EC2 / Client / bundle_instance

bundle_instance

EC2.Client.bundle_instance(**kwargs)

Bundles an Amazon instance store-backed Windows instance.

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

Note

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

See also: AWS API Documentation

Request Syntax

response = client.bundle_instance(
    InstanceId='string',
    Storage={
        'S3': {
            'AWSAccessKeyId': 'string',
            'Bucket': 'string',
            'Prefix': 'string',
            'UploadPolicy': b'bytes',
            'UploadPolicySignature': 'string'
        }
    },
    DryRun=True|False
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The ID of the instance to bundle.

  Default: None

• Storage (dict) –

  [REQUIRED]

  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.

  • S3 (dict) –

    An Amazon S3 storage location.

    • AWSAccessKeyId (string) –

      The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the Account ManagementReference Guide.

    • Bucket (string) –

      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.

    • Prefix (string) –

      The beginning of the file name of the AMI.

    • UploadPolicy (bytes) –

      An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

    • UploadPolicySignature (string) –

      The signature of the JSON document.

• DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'BundleTask': {
        'BundleId': 'string',
        'BundleTaskError': {
            'Code': 'string',
            'Message': 'string'
        },
        'InstanceId': 'string',
        'Progress': 'string',
        'StartTime': datetime(2015, 1, 1),
        'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed',
        'Storage': {
            'S3': {
                'AWSAccessKeyId': 'string',
                'Bucket': 'string',
                'Prefix': 'string',
                'UploadPolicy': b'bytes',
                'UploadPolicySignature': 'string'
            }
        },
        'UpdateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  Contains the output of BundleInstance.

  • BundleTask (dict) –

    Information about the bundle task.

    • BundleId (string) –

      The ID of the bundle task.

    • BundleTaskError (dict) –

      If the task fails, a description of the error.

      • Code (string) –

        The error code.

      • Message (string) –

        The error message.

    • InstanceId (string) –

      The ID of the instance associated with this bundle task.

    • Progress (string) –

      The level of task completion, as a percent (for example, 20%).

    • StartTime (datetime) –

      The time this task started.

    • State (string) –

      The state of the task.

    • Storage (dict) –

      The Amazon S3 storage locations.

      • S3 (dict) –

        An Amazon S3 storage location.

        • AWSAccessKeyId (string) –

          The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the Account ManagementReference Guide.

        • Bucket (string) –

          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.

        • Prefix (string) –

          The beginning of the file name of the AMI.

        • UploadPolicy (bytes) –

          An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

        • UploadPolicySignature (string) –

          The signature of the JSON document.

    • UpdateTime (datetime) –

      The time of the most recent update for the task.