:doc:`Lightsail <../../lightsail>` / Client / get_setup_history

*****************
get_setup_history
*****************



.. py:method:: Lightsail.Client.get_setup_history(**kwargs)

  

  Returns detailed information for five of the most recent ``SetupInstanceHttps`` requests that were ran on the target instance.

  

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


  **Request Syntax**
  ::

    response = client.get_setup_history(
        resourceName='string',
        pageToken='string'
    )
    
  :type resourceName: string
  :param resourceName: **[REQUIRED]** 

    The name of the resource for which you are requesting information.

    

  
  :type pageToken: string
  :param pageToken: 

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

     

    To get a page token, perform an initial ``GetSetupHistory`` 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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'setupHistory': [
              {
                  'operationId': 'string',
                  'request': {
                      'instanceName': 'string',
                      'domainNames': [
                          'string',
                      ],
                      'certificateProvider': 'LetsEncrypt'
                  },
                  'resource': {
                      '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'
                  },
                  'executionDetails': [
                      {
                          'command': 'string',
                          'dateTime': datetime(2015, 1, 1),
                          'name': 'string',
                          'status': 'succeeded'|'failed'|'inProgress',
                          'standardError': 'string',
                          'standardOutput': 'string',
                          'version': 'string'
                      },
                  ],
                  'status': 'succeeded'|'failed'|'inProgress'
              },
          ],
          'nextPageToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **setupHistory** *(list) --* 

        The historical information that's returned.

        
        

        - *(dict) --* 

          Returns a list of the commands that were ran on the target resource.

           

          The status of each command is also returned.

          
          

          - **operationId** *(string) --* 

            A GUID that's used to identify the operation.

            
          

          - **request** *(dict) --* 

            Information about the specified request.

            
            

            - **instanceName** *(string) --* 

              The name of the Lightsail instance.

              
            

            - **domainNames** *(list) --* 

              The name of the domain and subdomains that the SSL/TLS certificate secures.

              
              

              - *(string) --* 
          
            

            - **certificateProvider** *(string) --* 

              The Certificate Authority (CA) that issues the SSL/TLS certificate.

              
        
          

          - **resource** *(dict) --* 

            The target resource name for the request.

            
            

            - **name** *(string) --* 

              The name of the Lightsail resource.

              
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the Lightsail resource.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp for when the resource was created.

              
            

            - **location** *(dict) --* 

              Describes the resource location.

              
              

              - **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. For example, ``Instance``.

              
        
          

          - **executionDetails** *(list) --* 

            Describes the full details of the request.

            
            

            - *(dict) --* 

              Returns details about the commands that were run.

              
              

              - **command** *(string) --* 

                The command that was executed.

                
              

              - **dateTime** *(datetime) --* 

                The timestamp for when the request was run.

                
              

              - **name** *(string) --* 

                The name of the target resource.

                
              

              - **status** *(string) --* 

                The status of the ``SetupInstanceHttps`` request.

                
              

              - **standardError** *(string) --* 

                The text written by the command to stderr.

                
              

              - **standardOutput** *(string) --* 

                The text written by the command to stdout.

                
              

              - **version** *(string) --* 

                The current version of the script..

                
          
        
          

          - **status** *(string) --* 

            The status of the request.

            
      
    
      

      - **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 ``GetSetupHistory`` request and specify the next page token using the pageToken parameter.

        
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  