EC2 / Client / create_replace_root_volume_task

create_replace_root_volume_task

EC2.Client.create_replace_root_volume_task(**kwargs)

Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume’s launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance.

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_replace_root_volume_task(
    InstanceId='string',
    SnapshotId='string',
    ClientToken='string',
    DryRun=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ImageId='string',
    DeleteReplacedRootVolume=True|False
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The ID of the instance for which to replace the root volume.

• SnapshotId (string) –

  The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume.

  If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.

• ClientToken (string) –

  Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.

  This field is autopopulated if not provided.

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

• TagSpecifications (list) –

  The tags to apply to the root volume replacement task.

  • (dict) –

    The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

    Note

    The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

    • ResourceType (string) –

      The type of resource to tag on creation.

    • Tags (list) –

      The tags to apply to the resource.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value (string) –

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

• ImageId (string) –

  The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance.

  If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.

• DeleteReplacedRootVolume (boolean) – Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.

Return type:

dict

Returns:

Response Syntax

{
    'ReplaceRootVolumeTask': {
        'ReplaceRootVolumeTaskId': 'string',
        'InstanceId': 'string',
        'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached',
        'StartTime': 'string',
        'CompleteTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ImageId': 'string',
        'SnapshotId': 'string',
        'DeleteReplacedRootVolume': True|False
    }
}

Response Structure

• (dict) –

  • ReplaceRootVolumeTask (dict) –

    Information about the root volume replacement task.

    • ReplaceRootVolumeTaskId (string) –

      The ID of the root volume replacement task.

    • InstanceId (string) –

      The ID of the instance for which the root volume replacement task was created.

    • TaskState (string) –

      The state of the task. The task can be in one of the following states:

      • pending - the replacement volume is being created.

      • in-progress - the original volume is being detached and the replacement volume is being attached.

      • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

      • failing - the replacement task is in the process of failing.

      • failed - the replacement task has failed but the original root volume is still attached.

      • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

      • failed-detached - the replacement task has failed and the instance has no root volume attached.

    • StartTime (string) –

      The time the task was started.

    • CompleteTime (string) –

      The time the task completed.

    • Tags (list) –

      The tags assigned to the task.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

        • Value (string) –

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

    • ImageId (string) –

      The ID of the AMI used to create the replacement root volume.

    • SnapshotId (string) –

      The ID of the snapshot used to create the replacement root volume.

    • DeleteReplacedRootVolume (boolean) –

      Indicates whether the original root volume is to be deleted after the root volume replacement task completes.