[ aws . verifiedpermissions ]

batch-get-policy

Description

Retrieves information about a group (batch) of policies.

Note

The BatchGetPolicy operation doesn’t have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:GetPolicy in their IAM policies.

See also: AWS API Documentation

Synopsis

  batch-get-policy
--requests <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--requests (list)

An array of up to 100 policies you want information about.

(structure)

Information about a policy that you include in a BatchGetPolicy API request.

policyStoreId -> (string)

The identifier of the policy store where the policy you want information about is stored.

policyId -> (string)

The identifier of the policy you want information about.

Shorthand Syntax:

policyStoreId=string,policyId=string ...

JSON Syntax:

[
  {
    "policyStoreId": "string",
    "policyId": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

results -> (list)

Information about the policies listed in the request that were successfully returned. These results are returned in the order they were requested.

(structure)

Contains information about a policy returned from a BatchGetPolicy API request.

policyStoreId -> (string)

The identifier of the policy store where the policy you want information about is stored.

policyId -> (string)

The identifier of the policy you want information about.

policyType -> (string)

The type of the policy. This is one of the following values:

• STATIC
• TEMPLATE_LINKED

definition -> (tagged union structure)

The policy definition of an item in the list of policies returned.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: static, templateLinked.

static -> (structure)

Information about a static policy that wasn’t created with a policy template.

description -> (string)

A description of the static policy.

statement -> (string)

The content of the static policy written in the Cedar policy language.

templateLinked -> (structure)

Information about a template-linked policy that was created by instantiating a policy template.

policyTemplateId -> (string)

The unique identifier of the policy template used to create this policy.

principal -> (structure)

The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

entityType -> (string)

The type of an entity.

Example: "entityType":"*typeName* "

entityId -> (string)

The identifier of an entity.

"entityId":"*identifier* "

resource -> (structure)

The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

entityType -> (string)

The type of an entity.

Example: "entityType":"*typeName* "

entityId -> (string)

The identifier of an entity.

"entityId":"*identifier* "

createdDate -> (timestamp)

The date and time the policy was created.

lastUpdatedDate -> (timestamp)

The date and time the policy was most recently updated.

errors -> (list)

Information about the policies from the request that resulted in an error. These results are returned in the order they were requested.

(structure)

Contains the information about an error resulting from a BatchGetPolicy API call.

code -> (string)

The error code that was returned.

policyStoreId -> (string)

The identifier of the policy store associated with the failed request.

policyId -> (string)

The identifier of the policy associated with the failed request.

message -> (string)

A detailed error message.