Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

describe-snapshot-attribute¶

Description¶

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide .

Synopsis¶

  describe-snapshot-attribute
--attribute <value>
--snapshot-id <value>
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options¶

--attribute (string)

The snapshot attribute you would like to view.

Possible values:

productCodes

createVolumePermission

--snapshot-id (string)

The ID of the EBS snapshot.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe the snapshot attributes for a snapshot

The following describe-snapshot example describes the createVolumePermission attribute for the specified snapshot.

aws ec2 describe-snapshot-attribute \
    --snapshot-id snap-066877671789bd71b \
    --attribute createVolumePermission

The output indicates that the specified user has volume permissions.

{
    "SnapshotId": "snap-066877671789bd71b",
    "CreateVolumePermissions": [
        {
            "UserId": "123456789012"
        }
    ]
}

Output similar to the following indicates that there are no volume permissions.

{
    "SnapshotId": "snap-066877671789bd71b",
    "CreateVolumePermissions": []
}

Output¶

CreateVolumePermissions -> (list)

The users and groups that have the permissions for creating volumes from the snapshot.

(structure)

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

Group -> (string)

The group to be added or removed. The possible value is all .

UserId -> (string)

The ID of the Amazon Web Services account to be added or removed.

ProductCodes -> (list)

The product codes.

(structure)

Describes a product code.

ProductCodeId -> (string)

The product code.

ProductCodeType -> (string)

The type of product code.

SnapshotId -> (string)

The ID of the EBS snapshot.

Table Of Contents

Feedback

User Guide