:doc:`Lightsail <../../lightsail>` / Paginator / GetCloudFormationStackRecords

*****************************
GetCloudFormationStackRecords
*****************************



.. py:class:: Lightsail.Paginator.GetCloudFormationStackRecords

  ::

    
    paginator = client.get_paginator('get_cloud_formation_stack_records')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Lightsail.Client.get_cloud_formation_stack_records`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecords>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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'|'ap-southeast-3'
                    },
                    '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'
                    }
                },
            ],
            'NextToken': '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.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    