[ aws . iot ]

get-policy-version

Description

Gets information about the specified policy version.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-policy-version
--policy-name <value>
--policy-version-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--policy-name (string)

The name of the policy.

--policy-version-id (string)

The policy version ID.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a specific version of a policy

The following get-policy-version example gets information about the first version of the specified policy.

aws iot get-policy \
    --policy-name UpdateDeviceCertPolicy
    --policy-version-id "1"

Output:

{
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy",
    "policyName": "UpdateDeviceCertPolicy",
    "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\":  \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }",
    "policyVersionId": "1",
    "isDefaultVersion": false,
    "creationDate": 1559925941.924,
    "lastModifiedDate": 1559926175.458,
    "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042"
}

For more information, see AWS IoT Policies in the AWS IoT Developers Guide.

Output

policyArn -> (string)

The policy ARN.

policyName -> (string)

The policy name.

policyDocument -> (string)

The JSON document that describes the policy.

policyVersionId -> (string)

The policy version ID.

isDefaultVersion -> (boolean)

Specifies whether the policy version is the default.

creationDate -> (timestamp)

The date the policy was created.

lastModifiedDate -> (timestamp)

The date the policy was last modified.

generationId -> (string)

The generation ID of the policy version.