BundleInstance

Amazon Elastic Compute Cloud: 2009-08-15

previous page next page

BundleInstance

Description

Bundles the Windows instance. This procedure is not applicable for Linux and UNIX instances. For more information, go to the

Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud Getting Started Guide.
[Note]Note

During bundling, only the root store (C:\) is bundled. Data on other instance stores is not preserved.

Request Parameters

Name Description Required

InstanceId

The ID of the instance to bundle.

Type: String

Default: None

Yes

Storage.S3.Bucket

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

Type: String

Default: None

Yes

Storage.S3.Prefix

Specifies the beginning of the file name of the AMI.

Type: String

Default: None

Yes

Storage.S3.AWSAccessKeyId

The Access Key ID of the owner of the Amazon S3 bucket.

Type: String

Default: None

Yes

Storage.S3.UploadPolicy

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf.

Type: String

Default: None

Yes

Storage.S3.UploadPolicySignature

The signature of the Base64 encoded JSON document.

Type: String

Default: None

Yes

JSON Parameters

The upload policy gives Amazon EC2 limited permission to upload items into your Amazon S3 bucket. The following table describes the required parameters for the upload policy JSON document. Parameter names are case sensitive. For more information about upload policies and how to sign them, go to the Amazon Elastic Compute Cloud Developer Guide.

Name Description Required

expiration

The expiration of the policy. We recommend 12 hours or longer.

Yes

conditions

A list of restrictions on what can be uploaded to Amazon S3. Must contain the bucket and ACL conditions in this table.

Yes

bucket

The bucket to store the AMI.

Yes

acl

This must be set to ec2-bundle-read.

Yes

Response Elements

Name Description

BundleInstanceResponseType

BundleInstanceResponseType element.

Type: BundleInstanceResponseType

Ancestor: None

Children: requestId, bundleInstanceTask

requestId

The ID of the request.

Type: xsd:string

Ancestor: BundleInstanceResponseType

Children: None

bundleInstanceTask

Bundle task.

Type: BundleInstanceTaskType

Ancestor: BundleInstanceResponseType

Children: instanceId, bundleId, state, startTime, updateTime, storage, progress, and error

instanceId

Instance associated with this bundle task.

Type: xsd:string

Ancestor: bundleInstanceTask

Children: None

bundleId

Identifier for this task.

Type: xsd:string

Ancestor: bundleInstanceTask

Children: None

state

The state of the task.

Type: xsd:string

Valid Values: pending | waiting-for-shutdown | storing | canceling | complete | failed

Ancestor: bundleInstanceTask

Children: None

startTime

The time this task started.

Type: xsd:dateTime

Ancestor: bundleInstanceTask

Children: None

updateTime

The time of the most recent update for the task.

Type: xsd:dateTime

Ancestor: bundleInstanceTask

Children: None

storage

Amazon S3 storage locations.

Type: BundleInstanceTaskStorageType

Ancestor: bundleInstanceTask

Children: S3

S3

Amazon S3 storage location.

Type: BundleInstanceS3StorageType

Ancestor: storage

Children: bucket, prefix, awsAccessKeyId, uploadPolicy, and uploadPolicySignature

bucket

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

Type: xsd:string

Ancestor: S3

Children: None

prefix

Specifies the beginning of the file name of the AMI.

Type: xsd:string

Ancestor: S3

Children: None

awsAccessKeyId

The Access Key ID of the owner of the Amazon S3 bucket.

Type: xsd:string

Ancestor: S3

Children: None

uploadPolicy

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf.

Type: xsd:string

Ancestor: S3

Children: None

uploadPolicySignature

The signature of the Base64 encoded JSON document.

Type: xsd:string

Ancestor: S3

Children: None

progress

The level of task completion, in percent (e.g., 20%).

Type: xsd:string

Ancestor: bundleInstanceTask

Children: None

error

If the task fails, a description of the error.

Type: BundleInstanceTaskErrorType

Ancestor: bundleInstanceTask

Children: code, message

code

Error code.

Type: xsd:string

Ancestor: error

Children: None

message

Error message.

Type: xsd:string

Ancestor: error

Children: None

Examples

Example Request

This example bundles the i-e468cd8d instance.

https://ec2.amazonaws.com/?Action=BundleInstance&InstanceId=-i-e468cd8d
&Storage.S3.AWSAccessKeyId=10QMXFEV71ZS32XQFTR2
&Storage.S3.Bucket=my-bucket
&Storage.S3.Prefix=winami
&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MDlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgIiRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfQ%3D%3D
&Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNtJMU%3D
&AuthParams

Example Response

<BundleInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2009-08-15/">
  <requestId>bun-c1a540a8</requestId>
  <bundleInstanceTask>
      <instanceId>i-12345678</instanceId>
      <bundleId>bun-c1a540a8</bundleId>
      <state>bundling</state>
      <startTime>2008-10-07T11:41:50.000Z</startTime>
      <updateTime>2008-10-07T11:51:50.000Z</updateTime>
      <progress>70%</progress>
      <storage>
        <S3>
          <bucket>my-bucket</bucket>
          <prefix>winami</prefix>
        </S3>
      </storage>
  </bundleInstanceTask>
</BundleInstanceResponse>
previous page start next page