Lightsail / Paginator / GetStaticIps

GetStaticIps#

class Lightsail.Paginator.GetStaticIps#

paginator = client.get_paginator('get_static_ips')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Lightsail.Client.get_static_ips().

Request Syntax

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

Parameters:

PaginationConfig (dict) –

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.

Return type:

dict

Returns:

Response Syntax

{
    'staticIps': [
        {
            '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',
            'ipAddress': 'string',
            'attachedTo': 'string',
            'isAttached': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- staticIps (list) –
  
  An array of key-value pairs containing information about your get static IPs request.
  - (dict) –
    
    Describes a static IP.
    - name (string) –
      
      The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
    - 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 timestamp when the static IP was created (e.g., 1479735304.222).
    - location (dict) –
      
      The region and Availability Zone where the static IP 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 resource type (usually StaticIp).
    - ipAddress (string) –
      
      The static IP address.
    - attachedTo (string) –
      
      The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
    - isAttached (boolean) –
      
      A Boolean value indicating whether the static IP is attached.
- NextToken (string) –
  
  A token to resume pagination.