Describe Snapshot Attribute operation for the Amazon EC2 REST adapter

The Describe Snapshot Attribute operation returns information about an attribute of an Amazon EBS snapshot. You can specify only one attribute per call.

The following figure shows a sample <items> XML element for the Describe Snapshot Attribute operation.

Sample <items> XML element for the Describe Snapshot Attribute operation

<items>
    <item>
        <parameters>
            <snapshot-id></snapshot-id>
            <!- you have a choice of the next 2 elements ->
            <create-volume-permission/>
            <product-codes/>
        </parameters>
    </item>
</items>

The following table shows adapter request elements for the Describe Snapshot Attribute operation.

Adapter request elements for the Describe Snapshot Attribute operation

Element	Definition	Required
`<access-key>`	Specifies the Amazon Web Services (AWS) access key You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.	Conditional; You must specify the Access Key and theSecret Key together in the configuration or the adapter request. If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration. If only the Access Key is specified, the adapter ignores the value.
`<secret-key>`	Specifies the AWS secret access key You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.	Conditional; You must specify the Access Key and theSecret Key together in the configuration or the adapter request. If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration. If only the Secret Access Key is specified, the adapter ignores the value.
`<region>`	Specifies the region with which you want the adapter to communicate Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions. Valid values: us-east-1 us-west-2 (default) us-west-1 eu-west-1 ap-southeast-1 ap-northeast-1 ap-southeast-2 sa-east-1	No
`<operation-name`>	Contains the name of the operation: describe-snapshot-attribute	Yes
`<snapshot-id>`	Specifies the ID of the Amazon EBS snapshot whose attribute is to be described	Yes
`<query-parameter>`	Specifies the parameter to query for the specified snapshot Contains the following elements: `<create-volume-permission>` `<product-codes>`	Yes
`<create-volume-permission>`	Specifies the create volume permission of the snapshot	Conditional; required if the `<product-codes>` element is not specified
`<product-codes>`	Specifies the product codes associated with the snapshot Each product code contains a code and a product type	Conditional; required if the `<create-volume-permissions>` element is not specified

The following figure shows a sample adapter request for the Describe Snapshot Attribute operation.

Sample adapter request for the Describe Snapshot Attribute operation

<amazon-ec2-rest-request>
    <operation-name>describe-snapshot-attribute</operation-name>
    <parameters>
      <snapshot-id>snap-f03cebc1</snapshot-id>
      <create-volume-permission />
    </parameters>
</amazon-ec2-rest-request>

The following figure shows a sample adapter response for the Describe Snapshot Attribute operation.

Sample adapter response for the Describe Snapshot Attribute operation

<amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <DescribeSnapshotAttributeResponse>
    <snapshotId>snap-f03cebc1</snapshotId>
    <createVolumePermission>
      <item>
        <group />
        <userId>379709784307</userId>
      </item>
    </createVolumePermission>
  </DescribeSnapshotAttributeResponse>
</amazon-ec2-rest-response>

Describe Snapshot Attribute operation for the Amazon EC2 REST adapter

Comments