Lightsail / Client / get_disk_snapshot

get_disk_snapshot#

Lightsail.Client.get_disk_snapshot(**kwargs)#

Returns information about a specific block storage disk snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_disk_snapshot(
    diskSnapshotName='string'
)
Parameters:

diskSnapshotName (string) –

[REQUIRED]

The name of the disk snapshot ( my-disk-snapshot).

Return type:

dict

Returns:

Response Syntax

{
    'diskSnapshot': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'sizeInGb': 123,
        'state': 'pending'|'completed'|'error'|'unknown',
        'progress': 'string',
        'fromDiskName': 'string',
        'fromDiskArn': 'string',
        'fromInstanceName': 'string',
        'fromInstanceArn': 'string',
        'isFromAutoSnapshot': True|False
    }
}

Response Structure

  • (dict) –

    • diskSnapshot (dict) –

      An object containing information about the disk snapshot.

      • name (string) –

        The name of the disk snapshot ( my-disk-snapshot).

      • arn (string) –

        The Amazon Resource Name (ARN) of the disk snapshot.

      • supportCode (string) –

        The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

      • createdAt (datetime) –

        The date when the disk snapshot was created.

      • location (dict) –

        The AWS Region and Availability Zone where the disk snapshot was created.

        • availabilityZone (string) –

          The Availability Zone. Follows the format us-east-2a (case-sensitive).

        • regionName (string) –

          The Amazon Web Services Region name.

      • resourceType (string) –

        The Lightsail resource type ( DiskSnapshot).

      • tags (list) –

        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

        • (dict) –

          Describes a tag key and optional value assigned to an Amazon Lightsail resource.

          For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

          • key (string) –

            The key of the tag.

            Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

          • value (string) –

            The value of the tag.

            Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

      • sizeInGb (integer) –

        The size of the disk in GB.

      • state (string) –

        The status of the disk snapshot operation.

      • progress (string) –

        The progress of the snapshot.

      • fromDiskName (string) –

        The unique name of the source disk from which the disk snapshot was created.

      • fromDiskArn (string) –

        The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

      • fromInstanceName (string) –

        The unique name of the source instance from which the disk (system volume) snapshot was created.

      • fromInstanceArn (string) –

        The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

      • isFromAutoSnapshot (boolean) –

        A Boolean value indicating whether the snapshot was created from an automatic snapshot.

Exceptions