Create Snapshot operation


The Create Snapshot operation enables you to create a snapshot of an Amazon EBS volume and store it in Amazon S3. You can use a snapshot for backup, to make identical copies of instance devices, and to save data before shutting down an instance.

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

Sample <items> XML element for the Create Snapshot operation

<items>
   <item>
       <parameters>
           <volume-id></volume-id>
           <!--Optional:-->
           <description></description>
       </parameters>
   </item>
</items>

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

Adapter request elements for the Create Snapshot operation

Element

Definition

Required

<wsdl-location>

Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2

Examples:

Conditional:

  • Required if not specified in the request
  • If specified in the configuration and request, the value in the request overrides the value in the configuration
<endpoint-address>

Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions
Default value: US East region: http://us-east-1.ec2.amazonaws.com/

No

<signature-properties>

Specifies the mode for signing the adapter request

Conditional:

  • Required if not specified in the configuration
  • If <signature-properties mode = "key-files">, requires <private-key-file>
    and <certificate-file>
  • If <signature-properties mode = "key-data">, requires <private-key-data> and <certificate-data>
<operation-name>

Contains the name of the operation: create-snapshot

Yes

<volume-id>

Specifies the ID of the Amazon EBS volume of which you want to take a snapshot

Yes

<description>

Describes the Amazon EBS snapshot

No

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

Sample adapter request for the Create Snapshot operation

<amazon-ec2-request>
   <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/</wsdl-location>
   <endpoint-address>http://us-east-1.ec2.amazonaws.com/</endpoint-address>
   <signature-properties mode = "key-files">
       <private-key-file>C:\Security\
pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</private-key-file>
       <certificate-file>C:\Security\
cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</certificate-file>
   </signature-properties>
   <operation-name>create-snapshot</operation-name>
   <parameters>
       <volume-id>vol-679d280e</volume-id>
       <!--Optional:-->
       <description>Test Description</description>
   </parameters>
</amazon-ec2-request>

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

Sample adapter response for the Create Snapshot operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <CreateSnapshotResponse>
       <requestId>a83a15b3-ece7-4a17-9078-a178a4d40890</requestId>
       <snapshotId>snap-62a6700a</snapshotId>
       <volumeId>vol-679d280e</volumeId>
       <status>pending</status>
       <startTime>2010-04-20T08:06:25.000Z</startTime>
       <progress/>
       <ownerId>622872856407</ownerId>
       <volumeSize>1</volumeSize>
       <description>Test Description</description>
   </CreateSnapshotResponse>
</amazon-ec2-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*