BundleInstance

Amazon Elastic Compute Cloud: 2008-08-08

previous page next page

BundleInstance

The BundleInstance operation bundles an Amazon EC2 instance running Windows. For more information, see Bundling an AMI in Windows.

To bundle an instance through the API, you must generate a JSON document that contains Amazon S3 authentication information.

Request Parameters

The following table describes the request parameters for BundleInstance. Parameter names are case sensitive.

Name	Description	Required
`instanceId`	The ID of the instance to bundle. 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.Bucket`	The bucket in which to store the AMI. Type: String Default: none	Yes
`Storage.S3.Prefix`	The prefix to append to the AMI. Type: String Default: none	Yes
`Storage.S3.UploadPolicy`	The Base64 encoded JSON document. Type: String Default: none	Yes
`Storage.S3.UploadPolicySignature`	The signature of the Base64 encoded JSON document. Type: String Default: none	Yes

Upload Policy 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. Please see the Amazon Simple Storage Service Developer Guide for more information about upload policies and how to sign them.

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

The following table describes the default response tags included in BundleInstance responses.

Name	Description
`requestId`	The ID of the bundling request. Type: xsd:string
`bundleId`	Identifier for this task. Type: xsd:string
`instanceId`	Instance associated with this bundle task. Type: xsd:string
`state`	The state of the task (`pending`, `waiting-for-shutdown`, `bundling`, `storing`, `canceling`, `complete`, and `failed`). Type: xsd:string
`startTime`	The time this task was created. Type: xsd:dateTime
`updateTime`	The time of the most recent update for the task. Type: xsd:dateTime
`storage`	The storage description for the task. Type: BundleInstanceTaskStorageType
`progress`	A percentage description of the progress of the task, such as 20%. Type: xsd:string
`error`	If a task fails, a description of the error. Type: BundleInstanceTaskErrorType

Sample Request

https://ec2.amazonaws.com/
?Action=BundleInstance
&InstanceId=-12345678
&Storage.S3.AWSAccessKeyId=10QMXFEV71ZS32XQFTR2
&Storage.S3.Bucket=my-bucket
&Storage.S3.Prefix=winami
&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MDlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgIiRrZXkiLCAibXktbmV3LWltYWdlIl1dfQ%3D%3D
&Storage.S3.UploadPolicySignature=w6BZu2oxGsiiLZnoBmQSErotuMA%3D
& ...auth parameters...

Sample Upload Policy JSON Document

{
  "expiration": "2008-08-08T09:41:01Z",
  "conditions": [
    {"bucket": "bucket"},
    {"acl": "ec2-bundle-read"},
    ["starts-with", "$key", "my-ami"]
  ]
}

Sample Response

<BundleInstanceResponse xmlns="http://ec2.amazonaws.com/doc/2008-08-08">
  <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>

Related Operations

previous page start next page