Lightsail / Client / get_cloud_formation_stack_records

get_cloud_formation_stack_records#

Lightsail.Client.get_cloud_formation_stack_records(**kwargs)#

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_cloud_formation_stack_records(
    pageToken='string'
)
Parameters:

pageToken (string) –

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Return type:

dict

Returns:

Response Syntax

{
    'cloudFormationStackRecords': [
        {
            'name': 'string',
            'arn': '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',
            'state': 'Started'|'Succeeded'|'Failed',
            'sourceInfo': [
                {
                    'resourceType': 'ExportSnapshotRecord',
                    'name': 'string',
                    'arn': 'string'
                },
            ],
            'destinationInfo': {
                'id': 'string',
                'service': 'string'
            }
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

  • (dict) –

    • cloudFormationStackRecords (list) –

      A list of objects describing the CloudFormation stack records.

      • (dict) –

        Describes a CloudFormation stack record created as a result of the create cloud formation stack action.

        A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

        • name (string) –

          The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

        • arn (string) –

          The Amazon Resource Name (ARN) of the CloudFormation stack record.

        • createdAt (datetime) –

          The date when the CloudFormation stack record was created.

        • location (dict) –

          A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

          • 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 ( CloudFormationStackRecord).

        • state (string) –

          The current state of the CloudFormation stack record.

        • sourceInfo (list) –

          A list of objects describing the source of the CloudFormation stack record.

          • (dict) –

            Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

            • resourceType (string) –

              The Lightsail resource type ( ExportSnapshotRecord).

            • name (string) –

              The name of the record.

            • arn (string) –

              The Amazon Resource Name (ARN) of the export snapshot record.

        • destinationInfo (dict) –

          A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

          • id (string) –

            The ID of the resource created at the destination.

          • service (string) –

            The destination service of the record.

    • nextPageToken (string) –

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.

Exceptions

  • Lightsail.Client.exceptions.ServiceException

  • Lightsail.Client.exceptions.InvalidInputException

  • Lightsail.Client.exceptions.NotFoundException

  • Lightsail.Client.exceptions.OperationFailureException

  • Lightsail.Client.exceptions.AccessDeniedException

  • Lightsail.Client.exceptions.AccountSetupInProgressException

  • Lightsail.Client.exceptions.UnauthenticatedException