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

*************
GetOperations
*************



.. py:class:: Lightsail.Paginator.GetOperations

  ::

    
    paginator = client.get_paginator('get_operations')

  
  

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

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

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


    **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**

      
      ::

        {
            'operations': [
                {
                    'id': 'string',
                    'resourceName': 'string',
                    'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
                    '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'
                    },
                    'isTerminal': True|False,
                    'operationDetails': 'string',
                    'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
                    'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
                    'statusChangedAt': datetime(2015, 1, 1),
                    'errorCode': 'string',
                    'errorDetails': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **operations** *(list) --* 

          An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

          
          

          - *(dict) --* 

            Describes the API operation.

            
            

            - **id** *(string) --* 

              The ID of the operation.

              
            

            - **resourceName** *(string) --* 

              The resource name.

              
            

            - **resourceType** *(string) --* 

              The resource type.

              
            

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

              The timestamp when the operation was initialized ( ``1479816991.349``).

              
            

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

              The Amazon Web Services Region and Availability Zone.

              
              

              - **availabilityZone** *(string) --* 

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

                
              

              - **regionName** *(string) --* 

                The Amazon Web Services Region name.

                
          
            

            - **isTerminal** *(boolean) --* 

              A Boolean value indicating whether the operation is terminal.

              
            

            - **operationDetails** *(string) --* 

              Details about the operation ( ``Debian-1GB-Ohio-1``).

              
            

            - **operationType** *(string) --* 

              The type of operation.

              
            

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

              The status of the operation.

              
            

            - **statusChangedAt** *(datetime) --* 

              The timestamp when the status was changed ( ``1479816991.349``).

              
            

            - **errorCode** *(string) --* 

              The error code.

              
            

            - **errorDetails** *(string) --* 

              The error details.

              
        
      
        

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

          A token to resume pagination.

          
    