Lightsail ¶

Table of Contents

Lightsail
- Client
- Paginators

Client ¶

class Lightsail.Client¶

A low-level client representing Amazon Lightsail:

client = session.create_client('lightsail')

These are the available methods:

allocate_static_ip()
attach_static_ip()
can_paginate()
close_instance_public_ports()
create_domain()
create_domain_entry()
create_instance_snapshot()
create_instances()
create_instances_from_snapshot()
create_key_pair()
delete_domain()
delete_domain_entry()
delete_instance()
delete_instance_snapshot()
delete_key_pair()
detach_static_ip()
download_default_key_pair()
generate_presigned_url()
get_active_names()
get_blueprints()
get_bundles()
get_domain()
get_domains()
get_instance()
get_instance_access_details()
get_instance_metric_data()
get_instance_port_states()
get_instance_snapshot()
get_instance_snapshots()
get_instance_state()
get_instances()
get_key_pair()
get_key_pairs()
get_operation()
get_operations()
get_operations_for_resource()
get_paginator()
get_regions()
get_static_ip()
get_static_ips()
get_waiter()
import_key_pair()
is_vpc_peered()
open_instance_public_ports()
peer_vpc()
put_instance_public_ports()
reboot_instance()
release_static_ip()
start_instance()
stop_instance()
unpeer_vpc()
update_domain_entry()

allocate_static_ip(**kwargs)¶

Allocates a static IP address.

See also: AWS API Documentation

Request Syntax

response = client.allocate_static_ip(
    staticIpName='string'
)

Parameters:

staticIpName (string) –

[REQUIRED]

The name of the static IP address.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the static IP address you allocated.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

attach_static_ip(**kwargs)¶

Attaches a static IP address to a specific Amazon Lightsail instance.

See also: AWS API Documentation

Request Syntax

response = client.attach_static_ip(
    staticIpName='string',
    instanceName='string'
)

Parameters:

staticIpName (string) –
[REQUIRED]

The name of the static IP.
instanceName (string) –
[REQUIRED]

The instance name to which you want to attach the static IP address.

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about your API operations.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Returns:	`True` if the operation can be paginated, `False` otherwise.

close_instance_public_ports(**kwargs)¶

Closes the public ports on a specific Amazon Lightsail instance.

See also: AWS API Documentation

Request Syntax

response = client.close_instance_public_ports(
    portInfo={
        'fromPort': 123,
        'toPort': 123,
        'protocol': 'tcp'|'all'|'udp'
    },
    instanceName='string'
)

Parameters:

portInfo (dict) –
[REQUIRED]

Information about the public port you are trying to close.
- fromPort (integer) –
  The first port in the range.
- toPort (integer) –
  The last port in the range.
- protocol (string) –
  The protocol.
instanceName (string) –
[REQUIRED]

The name of the instance on which you’re attempting to close the public ports.

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  An array of key-value pairs that contains information about the 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

create_domain(**kwargs)¶

Creates a domain resource for the specified domain (e.g., example.com).

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    domainName='string'
)

Parameters:

domainName (string) –

[REQUIRED]

The domain name to manage (e.g., example.com ).

Note

You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the domain resource you created.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

create_domain_entry(**kwargs)¶

Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.

See also: AWS API Documentation

Request Syntax

response = client.create_domain_entry(
    domainName='string',
    domainEntry={
        'id': 'string',
        'name': 'string',
        'target': 'string',
        'type': 'string',
        'options': {
            'string': 'string'
        }
    }
)

Parameters:

domainName (string) –
[REQUIRED]

The domain name (e.g., example.com ) for which you want to create the domain entry.
domainEntry (dict) –
[REQUIRED]

An array of key-value pairs containing information about the domain entry request.
- id (string) –
  The ID of the domain recordset entry.
- name (string) –
  The name of the domain.
- target (string) –
  The target AWS name server (e.g., ns-111.awsdns-22.com. ).
- type (string) –
  The type of domain entry (e.g., SOA or NS ).
- options (dict) –
  The options for the domain entry.
  - (string) –
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  An array of key-value pairs containing information about the 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

create_instance_snapshot(**kwargs)¶

Creates a snapshot of a specific virtual private server, or instance . You can use a snapshot to create a new instance that is based on that snapshot.

See also: AWS API Documentation

Request Syntax

response = client.create_instance_snapshot(
    instanceSnapshotName='string',
    instanceName='string'
)

Parameters:

instanceSnapshotName (string) –
[REQUIRED]

The name for your new snapshot.
instanceName (string) –
[REQUIRED]

The Lightsail instance on which to base your snapshot.

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about the results of your create instances snapshot 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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.

create_instances(**kwargs)¶

Creates one or more Amazon Lightsail virtual private servers, or instances .

See also: AWS API Documentation

Request Syntax

response = client.create_instances(
    instanceNames=[
        'string',
    ],
    availabilityZone='string',
    customImageName='string',
    blueprintId='string',
    bundleId='string',
    userData='string',
    keyPairName='string'
)

Parameters:

instanceNames (list) –
[REQUIRED]

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
- (string) –
availabilityZone (string) –
[REQUIRED]

The Availability Zone in which to create your instance. Use the following format: us-east-1a (case sensitive). You can get a list of availability zones by using the get regions operation. Be sure to add the include availability zones parameter to your request.
customImageName (string) –
(Deprecated) The name for your custom image.

Note

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
blueprintId (string) –
[REQUIRED]

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
bundleId (string) –
[REQUIRED]

The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
userData (string) –
A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get –y update .

Note

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg . For a complete list, see the Dev Guide .
keyPairName (string) – The name of your key pair.

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about the results of your create instances 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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.

create_instances_from_snapshot(**kwargs)¶

Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_instances_from_snapshot(
    instanceNames=[
        'string',
    ],
    availabilityZone='string',
    instanceSnapshotName='string',
    bundleId='string',
    userData='string',
    keyPairName='string'
)

Parameters:

instanceNames (list) –
[REQUIRED]

The names for your new instances.
- (string) –
availabilityZone (string) –
[REQUIRED]

The Availability Zone where you want to create your instances. Use the following formatting: us-east-1a (case sensitive). You can get a list of availability zones by using the get regions operation. Be sure to add the include availability zones parameter to your request.
instanceSnapshotName (string) –
[REQUIRED]

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
bundleId (string) –
[REQUIRED]

The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
userData (string) –
You can create a launch script that configures a server with additional user data. For example, apt-get –y update .

Note

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg . For a complete list, see the Dev Guide .
keyPairName (string) – The name for your key pair.

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about the results of your create instances from snapshot 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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.

create_key_pair(**kwargs)¶

Creates sn SSH key pair.

See also: AWS API Documentation

Request Syntax

response = client.create_key_pair(
    keyPairName='string'
)

Parameters:

keyPairName (string) –

[REQUIRED]

The name for your new key pair.

Return type: dict

Returns:

Response Syntax

{
    'keyPair': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'fingerprint': 'string'
    },
    'publicKeyBase64': 'string',
    'privateKeyBase64': 'string',
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- keyPair (dict) –
  An array of key-value pairs containing information about the new key pair you just created.
  - name (string) –
    The friendly name of the SSH key pair.
  - arn (string) –
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-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 key pair was created (e.g., 1479816991.349 ).
  - location (dict) –
    The region name and Availability Zone where the key pair was created.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - resourceType (string) –
    The resource type (usually KeyPair ).
  - fingerprint (string) –
    The RSA fingerprint of the key pair.
- publicKeyBase64 (string) –
  A base64-encoded public key of the ssh-rsa type.
- privateKeyBase64 (string) –
  A base64-encoded RSA private key.
- operation (dict) –
  An array of key-value pairs containing information about the results of your create key pair request.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

delete_domain(**kwargs)¶

Deletes the specified domain recordset and all of its domain records.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    domainName='string'
)

Parameters:

domainName (string) –

[REQUIRED]

The specific domain name to delete.

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the results of your delete domain request.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

delete_domain_entry(**kwargs)¶

Deletes a specific domain entry.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain_entry(
    domainName='string',
    domainEntry={
        'id': 'string',
        'name': 'string',
        'target': 'string',
        'type': 'string',
        'options': {
            'string': 'string'
        }
    }
)

Parameters:

domainName (string) –
[REQUIRED]

The name of the domain entry to delete.
domainEntry (dict) –
[REQUIRED]

An array of key-value pairs containing information about your domain entries.
- id (string) –
  The ID of the domain recordset entry.
- name (string) –
  The name of the domain.
- target (string) –
  The target AWS name server (e.g., ns-111.awsdns-22.com. ).
- type (string) –
  The type of domain entry (e.g., SOA or NS ).
- options (dict) –
  The options for the domain entry.
  - (string) –
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  An array of key-value pairs containing information about the results of your delete domain entry request.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

delete_instance(**kwargs)¶

Deletes a specific Amazon Lightsail virtual private server, or instance .

See also: AWS API Documentation

Request Syntax

response = client.delete_instance(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance to delete.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the results of your delete instance 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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

delete_instance_snapshot(**kwargs)¶

Deletes a specific snapshot of a virtual private server (or instance ).

See also: AWS API Documentation

Request Syntax

response = client.delete_instance_snapshot(
    instanceSnapshotName='string'
)

Parameters:

instanceSnapshotName (string) –

[REQUIRED]

The name of the snapshot to delete.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the results of your delete instance snapshot 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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

delete_key_pair(**kwargs)¶

Deletes a specific SSH key pair.

See also: AWS API Documentation

Request Syntax

response = client.delete_key_pair(
    keyPairName='string'
)

Parameters:

keyPairName (string) –

[REQUIRED]

The name of the key pair to delete.

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the results of your delete key pair request.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

detach_static_ip(**kwargs)¶

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

See also: AWS API Documentation

Request Syntax

response = client.detach_static_ip(
    staticIpName='string'
)

Parameters:

staticIpName (string) –

[REQUIRED]

The name of the static IP to detach from the instance.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the results of your detach static IP 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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

download_default_key_pair()¶

Downloads the default SSH key pair from the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.download_default_key_pair()

Return type: dict

Returns:

Response Syntax

{
    'publicKeyBase64': 'string',
    'privateKeyBase64': 'string'
}

Response Structure

(dict) –
- publicKeyBase64 (string) –
  A base64-encoded public key of the ssh-rsa type.
- privateKeyBase64 (string) –
  A base64-encoded RSA private key.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters:

ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_active_names(**kwargs)¶

Returns the names of all active (not deleted) resources.

See also: AWS API Documentation

Request Syntax

response = client.get_active_names(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for paginating results from your get active names request.

Return type: dict

Returns:

Response Syntax

{
    'activeNames': [
        'string',
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- activeNames (list) –
  The list of active names returned by the get active names request.
  - (string) –
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get active names request.

get_blueprints(**kwargs)¶

Returns the list of available instance images, or blueprints . You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

See also: AWS API Documentation

Request Syntax

response = client.get_blueprints(
    includeInactive=True|False,
    pageToken='string'
)

Parameters:

includeInactive (boolean) – A Boolean value indicating whether to include inactive results in your request.
pageToken (string) – A token used for advancing to the next page of results from your get blueprints request.

Return type:

dict

Returns:

Response Syntax

{
    'blueprints': [
        {
            'blueprintId': 'string',
            'name': 'string',
            'group': 'string',
            'type': 'os'|'app',
            'description': 'string',
            'isActive': True|False,
            'minPower': 123,
            'version': 'string',
            'versionCode': 'string',
            'productUrl': 'string',
            'licenseUrl': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- blueprints (list) –
  
  An array of key-value pairs that contains information about the available blueprints.
  - (dict) –
    
    Describes a blueprint (a virtual private server image).
    - blueprintId (string) –
      
      The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ).
    - name (string) –
      
      The friendly name of the blueprint (e.g., Amazon Linux ).
    - group (string) –
      
      The group name of the blueprint (e.g., amazon-linux ).
    - type (string) –
      
      The type of the blueprint (e.g., os or app ).
    - description (string) –
      
      The description of the blueprint.
    - isActive (boolean) –
      
      A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    - minPower (integer) –
      
      The minimum machine size required to run this blueprint. 0 indicates that the blueprint runs on all instances.
    - version (string) –
      
      The version number of the operating system, application, or stack (e.g., 2016.03.0 ).
    - versionCode (string) –
      
      The version code.
    - productUrl (string) –
      
      The product URL to learn more about the image or blueprint.
    - licenseUrl (string) –
      
      The end-user license agreement URL for the image or blueprint.
- nextPageToken (string) –
  
  A token used for advancing to the next page of results from your get blueprints request.

get_bundles(**kwargs)¶

Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance ).

See also: AWS API Documentation

Request Syntax

response = client.get_bundles(
    includeInactive=True|False,
    pageToken='string'
)

Parameters:

includeInactive (boolean) – A Boolean value that indicates whether to include inactive bundle results in your request.
pageToken (string) – A token used for advancing to the next page of results from your get bundles request.

Return type:

dict

Returns:

Response Syntax

{
    'bundles': [
        {
            'price': ...,
            'cpuCount': 123,
            'diskSizeInGb': 123,
            'bundleId': 'string',
            'instanceType': 'string',
            'isActive': True|False,
            'name': 'string',
            'power': 123,
            'ramSizeInGb': ...,
            'transferPerMonthInGb': 123
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- bundles (list) –
  
  An array of key-value pairs that contains information about the available bundles.
  - (dict) –
    
    Describes a bundle, which is a set of specs describing your virtual private server (or instance ).
    - price (float) –
      
      The price in US dollars (e.g., 5.0 ).
    - cpuCount (integer) –
      
      The number of vCPUs included in the bundle (e.g., 2 ).
    - diskSizeInGb (integer) –
      
      The size of the SSD (e.g., 30 ).
    - bundleId (string) –
      
      The bundle ID (e.g., micro_1_0 ).
    - instanceType (string) –
      
      The Amazon EC2 instance type (e.g., t2.micro ).
    - isActive (boolean) –
      
      A Boolean value indicating whether the bundle is active.
    - name (string) –
      
      A friendly name for the bundle (e.g., Micro ).
    - power (integer) –
      
      The power of the bundle (e.g., 500 ).
    - ramSizeInGb (float) –
      
      The amount of RAM in GB (e.g., 2.0 ).
    - transferPerMonthInGb (integer) –
      
      The data transfer rate per month in GB (e.g., 2000 ).
- nextPageToken (string) –
  
  A token used for advancing to the next page of results from your get active names request.

get_domain(**kwargs)¶

Returns information about a specific domain recordset.

See also: AWS API Documentation

Request Syntax

response = client.get_domain(
    domainName='string'
)

Parameters:

domainName (string) –

[REQUIRED]

The domain name for which your want to return information about.

Return type: dict

Returns:

Response Syntax

{
    'domain': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'domainEntries': [
            {
                'id': 'string',
                'name': 'string',
                'target': 'string',
                'type': 'string',
                'options': {
                    'string': 'string'
                }
            },
        ]
    }
}

Response Structure

(dict) –
- domain (dict) –
  An array of key-value pairs containing information about your get domain request.
  - name (string) –
    The name of the domain.
  - arn (string) –
    The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-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 date when the domain recordset was created.
  - location (dict) –
    The AWS Region and Availability Zones where the domain recordset was created.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - resourceType (string) –
    The resource type.
  - domainEntries (list) –
    An array of key-value pairs containing information about the domain entries.
    - (dict) –
      Describes a domain recordset entry.
      - id (string) –
        The ID of the domain recordset entry.
      - name (string) –
        The name of the domain.
      - target (string) –
        The target AWS name server (e.g., ns-111.awsdns-22.com. ).
      - type (string) –
        The type of domain entry (e.g., SOA or NS ).
      - options (dict) –
        The options for the domain entry.
        
        (string) –
        
        (string) –

get_domains(**kwargs)¶

Returns a list of all domains in the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.get_domains(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get domains request.

Return type: dict

Returns:

Response Syntax

{
    'domains': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'domainEntries': [
                {
                    'id': 'string',
                    'name': 'string',
                    'target': 'string',
                    'type': 'string',
                    'options': {
                        'string': 'string'
                    }
                },
            ]
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- domains (list) –
  An array of key-value pairs containing information about each of the domain entries in the user’s account.
  - (dict) –
    Describes a domain where you are storing recordsets in Lightsail.
    - name (string) –
      The name of the domain.
    - arn (string) –
      The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-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 date when the domain recordset was created.
    - location (dict) –
      The AWS Region and Availability Zones where the domain recordset was created.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The resource type.
    - domainEntries (list) –
      An array of key-value pairs containing information about the domain entries.
      - (dict) –
        Describes a domain recordset entry.
        
        id (string) –
        The ID of the domain recordset entry.
        
        name (string) –
        The name of the domain.
        
        target (string) –
        The target AWS name server (e.g., ns-111.awsdns-22.com. ).
        
        type (string) –
        The type of domain entry (e.g., SOA or NS ).
        
        options (dict) –
        The options for the domain entry.
        
        (string) –
        
        (string) –
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get active names request.

get_instance(**kwargs)¶

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

See also: AWS API Documentation

Request Syntax

response = client.get_instance(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance.

Return type: dict

Returns:

Response Syntax

{
    'instance': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'blueprintId': 'string',
        'blueprintName': 'string',
        'bundleId': 'string',
        'isStaticIp': True|False,
        'privateIpAddress': 'string',
        'publicIpAddress': 'string',
        'ipv6Address': 'string',
        'hardware': {
            'cpuCount': 123,
            'disks': [
                {
                    '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                    },
                    'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
                    'sizeInGb': 123,
                    'gbInUse': 123,
                    'isSystemDisk': True|False,
                    'iops': 123,
                    'path': 'string',
                    'attachedTo': 'string',
                    'isAttached': True|False,
                    'attachmentState': 'string'
                },
            ],
            'ramSizeInGb': ...
        },
        'networking': {
            'monthlyTransfer': {
                'gbPerMonthAllocated': 123
            },
            'ports': [
                {
                    'fromPort': 123,
                    'toPort': 123,
                    'protocol': 'tcp'|'all'|'udp',
                    'accessFrom': 'string',
                    'accessType': 'Public'|'Private',
                    'commonName': 'string',
                    'accessDirection': 'inbound'|'outbound'
                },
            ]
        },
        'state': {
            'code': 123,
            'name': 'string'
        },
        'username': 'string',
        'sshKeyName': 'string'
    }
}

Response Structure

(dict) –
- instance (dict) –
  An array of key-value pairs containing information about the specified instance.
  - name (string) –
    The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1 ).
  - arn (string) –
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (e.g., 1479734909.17 ).
  - location (dict) –
    The region name and availability zone where the instance is located.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - resourceType (string) –
    The type of resource (usually Instance ).
  - blueprintId (string) –
    The blueprint ID (e.g., os_amlinux_2016_03 ).
  - blueprintName (string) –
    The friendly name of the blueprint (e.g., Amazon Linux ).
  - bundleId (string) –
    The bundle for the instance (e.g., micro_1_0 ).
  - isStaticIp (boolean) –
    A Boolean value indicating whether this instance has a static IP assigned to it.
  - privateIpAddress (string) –
    The private IP address of the instance.
  - publicIpAddress (string) –
    The public IP address of the instance.
  - ipv6Address (string) –
    The IPv6 address of the instance.
  - hardware (dict) –
    The size of the vCPU and the amount of RAM for the instance.
    - cpuCount (integer) –
      The number of vCPUs the instance has.
    - disks (list) –
      The disks attached to the instance.
      - (dict) –
        Describes the hard disk (an SSD).
        
        name (string) –
        The name of the disk.
        
        arn (string) –
        The Amazon Resource Name (ARN) of the disk.
        
        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 date when the disk was created.
        
        location (dict) –
        The region and Availability Zone where the disk is located.
        
        availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
        
        regionName (string) –
        The AWS Region name.
        
        resourceType (string) –
        The resource type of the disk.
        
        sizeInGb (integer) –
        The size of the disk in GB.
        
        gbInUse (integer) –
        The number of GB in use by the disk.
        
        isSystemDisk (boolean) –
        A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
        
        iops (integer) –
        The input/output operations per second (IOPS) of the disk.
        
        path (string) –
        The disk path.
        
        attachedTo (string) –
        The resources to which the disk is attached.
        
        isAttached (boolean) –
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) –
        The attachment state of the disk.
    - ramSizeInGb (float) –
      The amount of RAM in GB on the instance (e.g., 1.0 ).
  - networking (dict) –
    Information about the public ports and monthly data transfer rates for the instance.
    - monthlyTransfer (dict) –
      The amount of data in GB allocated for monthly data transfers.
      - gbPerMonthAllocated (integer) –
        The amount allocated per month (in GB).
    - ports (list) –
      An array of key-value pairs containing information about the ports on the instance.
      - (dict) –
        Describes information about the instance ports.
        
        fromPort (integer) –
        The first port in the range.
        
        toPort (integer) –
        The last port in the range.
        
        protocol (string) –
        The protocol being used. Can be one of the following.
        
        tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn’t require reliable data stream service, use UDP instead.
        
        all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
        
        udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don’t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
        
        accessFrom (string) –
        The location from which access is allowed (e.g., Anywhere (0.0.0.0/0) ).
        
        accessType (string) –
        The type of access (Public or Private ).
        
        commonName (string) –
        The common name.
        
        accessDirection (string) –
        The access direction (inbound or outbound ).
  - state (dict) –
    The status code and the state (e.g., running ) for the instance.
    - code (integer) –
      The status code for the instance.
    - name (string) –
      The state of the instance (e.g., running or pending ).
  - username (string) –
    The user name for connecting to the instance (e.g., ec2-user ).
  - sshKeyName (string) –
    The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).

get_instance_access_details(**kwargs)¶

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance .

See also: AWS API Documentation

Request Syntax

response = client.get_instance_access_details(
    instanceName='string',
    protocol='ssh'|'rdp'
)

Parameters:

instanceName (string) –
[REQUIRED]

The name of the instance to access.
protocol (string) – The protocol to use to connect to your instance. Defaults to ssh .

Return type:

dict

Returns:

Response Syntax

{
    'accessDetails': {
        'certKey': 'string',
        'expiresAt': datetime(2015, 1, 1),
        'ipAddress': 'string',
        'password': 'string',
        'privateKey': 'string',
        'protocol': 'ssh'|'rdp',
        'instanceName': 'string',
        'username': 'string'
    }
}

Response Structure

(dict) –
- accessDetails (dict) –
  
  An array of key-value pairs containing information about a get instance access request.
  - certKey (string) –
    
    For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub .
  - expiresAt (datetime) –
    
    For SSH access, the date on which the temporary keys expire.
  - ipAddress (string) –
    
    The public IP address of the Amazon Lightsail instance.
  - password (string) –
    
    For RDP access, the temporary password of the Amazon EC2 instance.
  - privateKey (string) –
    
    For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey ).
  - protocol (string) –
    
    The protocol for these Amazon Lightsail instance access details.
  - instanceName (string) –
    
    The name of this Amazon Lightsail instance.
  - username (string) –
    
    The user name to use when logging in to the Amazon Lightsail instance.

get_instance_metric_data(**kwargs)¶

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_metric_data(
    instanceName='string',
    metricName='CPUUtilization'|'NetworkIn'|'NetworkOut'|'StatusCheckFailed'|'StatusCheckFailed_Instance'|'StatusCheckFailed_System',
    period=123,
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
    statistics=[
        'Minimum'|'Maximum'|'Sum'|'Average'|'SampleCount',
    ]
)

Parameters:

instanceName (string) –
[REQUIRED]

The name of the instance for which you want to get metrics data.
metricName (string) –
[REQUIRED]

The metric name to get data about.
period (integer) –
[REQUIRED]

The time period for which you are requesting data.
startTime (datetime) –
[REQUIRED]

The start time of the time period.
endTime (datetime) –
[REQUIRED]

The end time of the time period.
unit (string) –
[REQUIRED]

The unit. The list of valid values is below.
statistics (list) –
[REQUIRED]

The instance statistics.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'metricName': 'CPUUtilization'|'NetworkIn'|'NetworkOut'|'StatusCheckFailed'|'StatusCheckFailed_Instance'|'StatusCheckFailed_System',
    'metricData': [
        {
            'average': 123.0,
            'maximum': 123.0,
            'minimum': 123.0,
            'sampleCount': 123.0,
            'sum': 123.0,
            'timestamp': datetime(2015, 1, 1),
            'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
        },
    ]
}

Response Structure

(dict) –
- metricName (string) –
  
  The metric name to return data for.
- metricData (list) –
  
  An array of key-value pairs containing information about the results of your get instance metric data request.
  - (dict) –
    
    Describes the metric data point.
    - average (float) –
      
      The average.
    - maximum (float) –
      
      The maximum.
    - minimum (float) –
      
      The minimum.
    - sampleCount (float) –
      
      The sample count.
    - sum (float) –
      
      The sum.
    - timestamp (datetime) –
      
      The timestamp (e.g., 1479816991.349 ).
    - unit (string) –
      
      The unit.

get_instance_port_states(**kwargs)¶

Returns the port states for a specific virtual private server, or instance .

See also: AWS API Documentation

Request Syntax

response = client.get_instance_port_states(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance.

Return type: dict

Returns:

Response Syntax

{
    'portStates': [
        {
            'fromPort': 123,
            'toPort': 123,
            'protocol': 'tcp'|'all'|'udp',
            'state': 'open'|'closed'
        },
    ]
}

Response Structure

(dict) –
- portStates (list) –
  Information about the port states resulting from your request.
  - (dict) –
    Describes the port state.
    - fromPort (integer) –
      The first port in the range.
    - toPort (integer) –
      The last port in the range.
    - protocol (string) –
      The protocol being used. Can be one of the following.
      - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn’t require reliable data stream service, use UDP instead.
      - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
      - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don’t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    - state (string) –
      Specifies whether the instance port is open or closed .

get_instance_snapshot(**kwargs)¶

Returns information about a specific instance snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_snapshot(
    instanceSnapshotName='string'
)

Parameters:

instanceSnapshotName (string) –

[REQUIRED]

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

Return type: dict

Returns:

Response Syntax

{
    'instanceSnapshot': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'state': 'pending'|'error'|'available',
        'progress': 'string',
        'fromInstanceName': 'string',
        'fromInstanceArn': 'string',
        'fromBlueprintId': 'string',
        'fromBundleId': 'string',
        'sizeInGb': 123
    }
}

Response Structure

(dict) –
- instanceSnapshot (dict) –
  An array of key-value pairs containing information about the results of your get instance snapshot request.
  - name (string) –
    The name of the snapshot.
  - arn (string) –
    The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-1:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-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 snapshot was created (e.g., 1479907467.024 ).
  - location (dict) –
    The region name and availability zone where you created the snapshot.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - resourceType (string) –
    The type of resource (usually InstanceSnapshot ).
  - state (string) –
    The state the snapshot is in.
  - progress (string) –
    The progress of the snapshot.
  - fromInstanceName (string) –
    The instance from which the snapshot was created.
  - fromInstanceArn (string) –
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE ).
  - fromBlueprintId (string) –
    The blueprint ID from which you created the snapshot (e.g., os_debian_8_3 ). A blueprint is a virtual private server (or instance ) image used to create instances quickly.
  - fromBundleId (string) –
    The bundle ID from which you created the snapshot (e.g., micro_1_0 ).
  - sizeInGb (integer) –
    The size in GB of the SSD.

get_instance_snapshots(**kwargs)¶

Returns all instance snapshots for the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_snapshots(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get instance snapshots request.

Return type: dict

Returns:

Response Syntax

{
    'instanceSnapshots': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'state': 'pending'|'error'|'available',
            'progress': 'string',
            'fromInstanceName': 'string',
            'fromInstanceArn': 'string',
            'fromBlueprintId': 'string',
            'fromBundleId': 'string',
            'sizeInGb': 123
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- instanceSnapshots (list) –
  An array of key-value pairs containing information about the results of your get instance snapshots request.
  - (dict) –
    Describes the snapshot of the virtual private server, or instance .
    - name (string) –
      The name of the snapshot.
    - arn (string) –
      The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-1:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-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 snapshot was created (e.g., 1479907467.024 ).
    - location (dict) –
      The region name and availability zone where you created the snapshot.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The type of resource (usually InstanceSnapshot ).
    - state (string) –
      The state the snapshot is in.
    - progress (string) –
      The progress of the snapshot.
    - fromInstanceName (string) –
      The instance from which the snapshot was created.
    - fromInstanceArn (string) –
      The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE ).
    - fromBlueprintId (string) –
      The blueprint ID from which you created the snapshot (e.g., os_debian_8_3 ). A blueprint is a virtual private server (or instance ) image used to create instances quickly.
    - fromBundleId (string) –
      The bundle ID from which you created the snapshot (e.g., micro_1_0 ).
    - sizeInGb (integer) –
      The size in GB of the SSD.
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get instance snapshots request.

get_instance_state(**kwargs)¶

Returns the state of a specific instance. Works on one instance at a time.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_state(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance to get state information about.

Return type: dict

Returns:

Response Syntax

{
    'state': {
        'code': 123,
        'name': 'string'
    }
}

Response Structure

(dict) –
- state (dict) –
  The state of the instance.
  - code (integer) –
    The status code for the instance.
  - name (string) –
    The state of the instance (e.g., running or pending ).

get_instances(**kwargs)¶

Returns information about all Amazon Lightsail virtual private servers, or instances .

See also: AWS API Documentation

Request Syntax

response = client.get_instances(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get instances request.

Return type: dict

Returns:

Response Syntax

{
    'instances': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'blueprintId': 'string',
            'blueprintName': 'string',
            'bundleId': 'string',
            'isStaticIp': True|False,
            'privateIpAddress': 'string',
            'publicIpAddress': 'string',
            'ipv6Address': 'string',
            'hardware': {
                'cpuCount': 123,
                'disks': [
                    {
                        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                        },
                        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
                        'sizeInGb': 123,
                        'gbInUse': 123,
                        'isSystemDisk': True|False,
                        'iops': 123,
                        'path': 'string',
                        'attachedTo': 'string',
                        'isAttached': True|False,
                        'attachmentState': 'string'
                    },
                ],
                'ramSizeInGb': ...
            },
            'networking': {
                'monthlyTransfer': {
                    'gbPerMonthAllocated': 123
                },
                'ports': [
                    {
                        'fromPort': 123,
                        'toPort': 123,
                        'protocol': 'tcp'|'all'|'udp',
                        'accessFrom': 'string',
                        'accessType': 'Public'|'Private',
                        'commonName': 'string',
                        'accessDirection': 'inbound'|'outbound'
                    },
                ]
            },
            'state': {
                'code': 123,
                'name': 'string'
            },
            'username': 'string',
            'sshKeyName': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- instances (list) –
  An array of key-value pairs containing information about your instances.
  - (dict) –
    Describes an instance (a virtual private server).
    - name (string) –
      The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1 ).
    - arn (string) –
      The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (e.g., 1479734909.17 ).
    - location (dict) –
      The region name and availability zone where the instance is located.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The type of resource (usually Instance ).
    - blueprintId (string) –
      The blueprint ID (e.g., os_amlinux_2016_03 ).
    - blueprintName (string) –
      The friendly name of the blueprint (e.g., Amazon Linux ).
    - bundleId (string) –
      The bundle for the instance (e.g., micro_1_0 ).
    - isStaticIp (boolean) –
      A Boolean value indicating whether this instance has a static IP assigned to it.
    - privateIpAddress (string) –
      The private IP address of the instance.
    - publicIpAddress (string) –
      The public IP address of the instance.
    - ipv6Address (string) –
      The IPv6 address of the instance.
    - hardware (dict) –
      The size of the vCPU and the amount of RAM for the instance.
      - cpuCount (integer) –
        The number of vCPUs the instance has.
      - disks (list) –
        The disks attached to the instance.
        
        (dict) –
        Describes the hard disk (an SSD).
        
        name (string) –
        The name of the disk.
        
        arn (string) –
        The Amazon Resource Name (ARN) of the disk.
        
        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 date when the disk was created.
        
        location (dict) –
        The region and Availability Zone where the disk is located.
        
        availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
        
        regionName (string) –
        The AWS Region name.
        
        resourceType (string) –
        The resource type of the disk.
        
        sizeInGb (integer) –
        The size of the disk in GB.
        
        gbInUse (integer) –
        The number of GB in use by the disk.
        
        isSystemDisk (boolean) –
        A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
        
        iops (integer) –
        The input/output operations per second (IOPS) of the disk.
        
        path (string) –
        The disk path.
        
        attachedTo (string) –
        The resources to which the disk is attached.
        
        isAttached (boolean) –
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) –
        The attachment state of the disk.
      - ramSizeInGb (float) –
        The amount of RAM in GB on the instance (e.g., 1.0 ).
    - networking (dict) –
      Information about the public ports and monthly data transfer rates for the instance.
      - monthlyTransfer (dict) –
        The amount of data in GB allocated for monthly data transfers.
        
        gbPerMonthAllocated (integer) –
        The amount allocated per month (in GB).
      - ports (list) –
        An array of key-value pairs containing information about the ports on the instance.
        
        (dict) –
        Describes information about the instance ports.
        
        fromPort (integer) –
        The first port in the range.
        
        toPort (integer) –
        The last port in the range.
        
        protocol (string) –
        The protocol being used. Can be one of the following.
        
        tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn’t require reliable data stream service, use UDP instead.
        
        all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
        
        udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don’t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
        
        accessFrom (string) –
        The location from which access is allowed (e.g., Anywhere (0.0.0.0/0) ).
        
        accessType (string) –
        The type of access (Public or Private ).
        
        commonName (string) –
        The common name.
        
        accessDirection (string) –
        The access direction (inbound or outbound ).
    - state (dict) –
      The status code and the state (e.g., running ) for the instance.
      - code (integer) –
        The status code for the instance.
      - name (string) –
        The state of the instance (e.g., running or pending ).
    - username (string) –
      The user name for connecting to the instance (e.g., ec2-user ).
    - sshKeyName (string) –
      The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get instances request.

get_key_pair(**kwargs)¶

Returns information about a specific key pair.

See also: AWS API Documentation

Request Syntax

response = client.get_key_pair(
    keyPairName='string'
)

Parameters:

keyPairName (string) –

[REQUIRED]

The name of the key pair for which you are requesting information.

Return type: dict

Returns:

Response Syntax

{
    'keyPair': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'fingerprint': 'string'
    }
}

Response Structure

(dict) –
- keyPair (dict) –
  An array of key-value pairs containing information about the key pair.
  - name (string) –
    The friendly name of the SSH key pair.
  - arn (string) –
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-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 key pair was created (e.g., 1479816991.349 ).
  - location (dict) –
    The region name and Availability Zone where the key pair was created.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - resourceType (string) –
    The resource type (usually KeyPair ).
  - fingerprint (string) –
    The RSA fingerprint of the key pair.

get_key_pairs(**kwargs)¶

Returns information about all key pairs in the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.get_key_pairs(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get key pairs request.

Return type: dict

Returns:

Response Syntax

{
    'keyPairs': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'fingerprint': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- keyPairs (list) –
  An array of key-value pairs containing information about the key pairs.
  - (dict) –
    Describes the SSH key pair.
    - name (string) –
      The friendly name of the SSH key pair.
    - arn (string) –
      The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-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 key pair was created (e.g., 1479816991.349 ).
    - location (dict) –
      The region name and Availability Zone where the key pair was created.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The resource type (usually KeyPair ).
    - fingerprint (string) –
      The RSA fingerprint of the key pair.
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get key pairs request.

get_operation(**kwargs)¶

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

See also: AWS API Documentation

Request Syntax

response = client.get_operation(
    operationId='string'
)

Parameters:

operationId (string) –

[REQUIRED]

A GUID used to identify the operation.

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the results of your get operation request.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

get_operations(**kwargs)¶

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

See also: AWS API Documentation

Request Syntax

response = client.get_operations(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get operations request.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the results of your get operations 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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get operations request.

get_operations_for_resource(**kwargs)¶

Gets operations for a specific resource (e.g., an instance or a static IP).

See also: AWS API Documentation

Request Syntax

response = client.get_operations_for_resource(
    resourceName='string',
    pageToken='string'
)

Parameters:

resourceName (string) –
[REQUIRED]

The name of the resource for which you are requesting information.
pageToken (string) – A token used for advancing to the next page of results from your get operations for resource request.

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ],
    'nextPageCount': 'string',
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about the results of your get operations for resource 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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.
- nextPageCount (string) –
  
  (Deprecated) Returns the number of pages of results that remain.
  
  Note
  
  In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the nextPageToken parameter instead.
- nextPageToken (string) –
  
  An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Raises:	OperationNotPageableError – Raised if the operation is not pageable. You can use the `client.can_paginate` method to check if an operation is pageable.
Return type:	L{botocore.paginate.Paginator}
Returns:	A paginator object.

get_regions(**kwargs)¶

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the availability zones in a region.

See also: AWS API Documentation

Request Syntax

response = client.get_regions(
    includeAvailabilityZones=True|False
)

Parameters: includeAvailabilityZones (boolean) – A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-1a .

Return type: dict

Returns:

Response Syntax

{
    'regions': [
        {
            'continentCode': 'string',
            'description': 'string',
            'displayName': 'string',
            'name': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2',
            'availabilityZones': [
                {
                    'zoneName': 'string',
                    'state': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- regions (list) –
  An array of key-value pairs containing information about your get regions request.
  - (dict) –
    Describes the AWS Region.
    - continentCode (string) –
      The continent code (e.g., NA , meaning North America).
    - description (string) –
      The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada ).
    - displayName (string) –
      The display name (e.g., Virginia ).
    - name (string) –
      The region name (e.g., us-east-1 ).
    - availabilityZones (list) –
      The Availability Zones. Follows the format us-east-1a (case-sensitive).
      - (dict) –
        Describes an Availability Zone.
        
        zoneName (string) –
        The name of the Availability Zone. The format is us-east-1a (case-sensitive).
        
        state (string) –
        The state of the Availability Zone.

get_static_ip(**kwargs)¶

Returns information about a specific static IP.

See also: AWS API Documentation

Request Syntax

response = client.get_static_ip(
    staticIpName='string'
)

Parameters:

staticIpName (string) –

[REQUIRED]

The name of the static IP in Lightsail.

Return type: dict

Returns:

Response Syntax

{
    'staticIp': {
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        'ipAddress': 'string',
        'attachedTo': 'string',
        'isAttached': True|False
    }
}

Response Structure

(dict) –
- staticIp (dict) –
  An array of key-value pairs containing information about the requested static IP.
  - name (string) –
    The name of the static IP (e.g., StaticIP-Virginia-EXAMPLE ).
  - arn (string) –
    The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-1: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-1a (case-sensitive).
    - regionName (string) –
      The AWS 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-Virginia-1 ).
  - isAttached (boolean) –
    A Boolean value indicating whether the static IP is attached.

get_static_ips(**kwargs)¶

Returns information about all static IPs in the user’s account.

See also: AWS API Documentation

Request Syntax

response = client.get_static_ips(
    pageToken='string'
)

Parameters: pageToken (string) – A token used for advancing to the next page of results from your get static IPs request.

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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'ipAddress': 'string',
            'attachedTo': 'string',
            'isAttached': True|False
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- staticIps (list) –
  An array of key-value pairs containing information about your get static IPs request.
  - (dict) –
    Describes the static IP.
    - name (string) –
      The name of the static IP (e.g., StaticIP-Virginia-EXAMPLE ).
    - arn (string) –
      The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-1: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-1a (case-sensitive).
      - regionName (string) –
        The AWS 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-Virginia-1 ).
    - isAttached (boolean) –
      A Boolean value indicating whether the static IP is attached.
- nextPageToken (string) –
  A token used for advancing to the next page of results from your get static IPs request.

get_waiter(waiter_name)¶

import_key_pair(**kwargs)¶

Imports a public SSH key from a specific key pair.

See also: AWS API Documentation

Request Syntax

response = client.import_key_pair(
    keyPairName='string',
    publicKeyBase64='string'
)

Parameters:

keyPairName (string) –
[REQUIRED]

The name of the key pair for which you want to import the public key.
publicKeyBase64 (string) –
[REQUIRED]

A base64-encoded public key of the ssh-rsa type.

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  An array of key-value pairs containing information about the request 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

is_vpc_peered()¶

Returns a Boolean value indicating whether your Lightsail VPC is peered.

See also: AWS API Documentation

Request Syntax

response = client.is_vpc_peered()

Return type: dict

Returns:

Response Syntax

{
    'isPeered': True|False
}

Response Structure

(dict) –
- isPeered (boolean) –
  Returns true if the Lightsail VPC is peered; otherwise, false .

open_instance_public_ports(**kwargs)¶

Adds public ports to an Amazon Lightsail instance.

See also: AWS API Documentation

Request Syntax

response = client.open_instance_public_ports(
    portInfo={
        'fromPort': 123,
        'toPort': 123,
        'protocol': 'tcp'|'all'|'udp'
    },
    instanceName='string'
)

Parameters:

portInfo (dict) –
[REQUIRED]

An array of key-value pairs containing information about the port mappings.
- fromPort (integer) –
  The first port in the range.
- toPort (integer) –
  The last port in the range.
- protocol (string) –
  The protocol.
instanceName (string) –
[REQUIRED]

The name of the instance for which you want to open the public ports.

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  An array of key-value pairs containing information about the request 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

peer_vpc()¶

Tries to peer the Lightsail VPC with the user’s default VPC.

See also: AWS API Documentation

Request Syntax

response = client.peer_vpc()

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the request 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

put_instance_public_ports(**kwargs)¶

Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.

See also: AWS API Documentation

Request Syntax

response = client.put_instance_public_ports(
    portInfos=[
        {
            'fromPort': 123,
            'toPort': 123,
            'protocol': 'tcp'|'all'|'udp'
        },
    ],
    instanceName='string'
)

Parameters:

portInfos (list) –
[REQUIRED]

Specifies information about the public port(s).
- (dict) –
  Describes information about the ports on your virtual private server (or instance ).
  - fromPort (integer) –
    The first port in the range.
  - toPort (integer) –
    The last port in the range.
  - protocol (string) –
    The protocol.
instanceName (string) –
[REQUIRED]

The Lightsail instance name of the public port(s) you are setting.

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  Describes metadata about the operation you just executed.
  - 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 (e.g., 1479816991.349 ).
  - location (dict) –
    
    The region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      
      The AWS Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

reboot_instance(**kwargs)¶

Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.

See also: AWS API Documentation

Request Syntax

response = client.reboot_instance(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance to reboot.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the request operation.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

release_static_ip(**kwargs)¶

Deletes a specific static IP from your account.

See also: AWS API Documentation

Request Syntax

response = client.release_static_ip(
    staticIpName='string'
)

Parameters:

staticIpName (string) –

[REQUIRED]

The name of the static IP to delete.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the request operation.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

start_instance(**kwargs)¶

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

See also: AWS API Documentation

Request Syntax

response = client.start_instance(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance (a virtual private server) to start.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the request operation.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

stop_instance(**kwargs)¶

Stops a specific Amazon Lightsail instance that is currently running.

See also: AWS API Documentation

Request Syntax

response = client.stop_instance(
    instanceName='string'
)

Parameters:

instanceName (string) –

[REQUIRED]

The name of the instance (a virtual private server) to stop.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the request operation.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.

unpeer_vpc()¶

Attempts to unpeer the Lightsail VPC from the user’s default VPC.

See also: AWS API Documentation

Request Syntax

response = client.unpeer_vpc()

Return type: dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  An array of key-value pairs containing information about the request 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 (e.g., 1479816991.349 ).
  - location (dict) –
    The region and Availability Zone.
    - availabilityZone (string) –
      The Availability Zone. Follows the format us-east-1a (case-sensitive).
    - regionName (string) –
      The AWS Region name.
  - isTerminal (boolean) –
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    Details about the operation (e.g., Debian-1GB-Virginia-1 ).
  - operationType (string) –
    The type of operation.
  - status (string) –
    The status of the operation.
  - statusChangedAt (datetime) –
    The timestamp when the status was changed (e.g., 1479816991.349 ).
  - errorCode (string) –
    The error code.
  - errorDetails (string) –
    The error details.

update_domain_entry(**kwargs)¶

Updates a domain recordset after it is created.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_entry(
    domainName='string',
    domainEntry={
        'id': 'string',
        'name': 'string',
        'target': 'string',
        'type': 'string',
        'options': {
            'string': 'string'
        }
    }
)

Parameters:

domainName (string) –
[REQUIRED]

The name of the domain recordset to update.
domainEntry (dict) –
[REQUIRED]

An array of key-value pairs containing information about the domain entry.
- id (string) –
  The ID of the domain recordset entry.
- name (string) –
  The name of the domain.
- target (string) –
  The target AWS name server (e.g., ns-111.awsdns-22.com. ).
- type (string) –
  The type of domain entry (e.g., SOA or NS ).
- options (dict) –
  The options for the domain entry.
  - (string) –
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) –
- operations (list) –
  
  An array of key-value pairs containing information about the request operation.
  - (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 (e.g., 1479816991.349 ).
    - location (dict) –
      
      The region and Availability Zone.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        
        The AWS Region name.
    - isTerminal (boolean) –
      
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      
      The type of operation.
    - status (string) –
      
      The status of the operation.
    - statusChangedAt (datetime) –
      
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      
      The error code.
    - errorDetails (string) –
      
      The error details.

Paginators ¶

The available paginators are:

Lightsail.Paginator.GetActiveNames
Lightsail.Paginator.GetBlueprints
Lightsail.Paginator.GetBundles
Lightsail.Paginator.GetDomains
Lightsail.Paginator.GetInstanceSnapshots
Lightsail.Paginator.GetInstances
Lightsail.Paginator.GetKeyPairs
Lightsail.Paginator.GetOperations
Lightsail.Paginator.GetStaticIps

class Lightsail.Paginator.GetActiveNames¶

paginator = client.get_paginator('get_active_names')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'activeNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- activeNames (list) –
  The list of active names returned by the get active names request.
  - (string) –
- NextToken (string) –
  A token to resume pagination.

class Lightsail.Paginator.GetBlueprints¶

paginator = client.get_paginator('get_blueprints')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    includeInactive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

includeInactive (boolean) – A Boolean value indicating whether to include inactive results in your request.
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.
- PageSize (integer) –
  The size of each page.
- StartingToken (string) –
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'blueprints': [
        {
            'blueprintId': 'string',
            'name': 'string',
            'group': 'string',
            'type': 'os'|'app',
            'description': 'string',
            'isActive': True|False,
            'minPower': 123,
            'version': 'string',
            'versionCode': 'string',
            'productUrl': 'string',
            'licenseUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- blueprints (list) –
  
  An array of key-value pairs that contains information about the available blueprints.
  - (dict) –
    
    Describes a blueprint (a virtual private server image).
    - blueprintId (string) –
      
      The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ).
    - name (string) –
      
      The friendly name of the blueprint (e.g., Amazon Linux ).
    - group (string) –
      
      The group name of the blueprint (e.g., amazon-linux ).
    - type (string) –
      
      The type of the blueprint (e.g., os or app ).
    - description (string) –
      
      The description of the blueprint.
    - isActive (boolean) –
      
      A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    - minPower (integer) –
      
      The minimum machine size required to run this blueprint. 0 indicates that the blueprint runs on all instances.
    - version (string) –
      
      The version number of the operating system, application, or stack (e.g., 2016.03.0 ).
    - versionCode (string) –
      
      The version code.
    - productUrl (string) –
      
      The product URL to learn more about the image or blueprint.
    - licenseUrl (string) –
      
      The end-user license agreement URL for the image or blueprint.
- NextToken (string) –
  
  A token to resume pagination.

class Lightsail.Paginator.GetBundles¶

paginator = client.get_paginator('get_bundles')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    includeInactive=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

includeInactive (boolean) – A Boolean value that indicates whether to include inactive bundle results in your request.
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.
- PageSize (integer) –
  The size of each page.
- StartingToken (string) –
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'bundles': [
        {
            'price': ...,
            'cpuCount': 123,
            'diskSizeInGb': 123,
            'bundleId': 'string',
            'instanceType': 'string',
            'isActive': True|False,
            'name': 'string',
            'power': 123,
            'ramSizeInGb': ...,
            'transferPerMonthInGb': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- bundles (list) –
  
  An array of key-value pairs that contains information about the available bundles.
  - (dict) –
    
    Describes a bundle, which is a set of specs describing your virtual private server (or instance ).
    - price (float) –
      
      The price in US dollars (e.g., 5.0 ).
    - cpuCount (integer) –
      
      The number of vCPUs included in the bundle (e.g., 2 ).
    - diskSizeInGb (integer) –
      
      The size of the SSD (e.g., 30 ).
    - bundleId (string) –
      
      The bundle ID (e.g., micro_1_0 ).
    - instanceType (string) –
      
      The Amazon EC2 instance type (e.g., t2.micro ).
    - isActive (boolean) –
      
      A Boolean value indicating whether the bundle is active.
    - name (string) –
      
      A friendly name for the bundle (e.g., Micro ).
    - power (integer) –
      
      The power of the bundle (e.g., 500 ).
    - ramSizeInGb (float) –
      
      The amount of RAM in GB (e.g., 2.0 ).
    - transferPerMonthInGb (integer) –
      
      The data transfer rate per month in GB (e.g., 2000 ).
- NextToken (string) –
  
  A token to resume pagination.

class Lightsail.Paginator.GetDomains¶

paginator = client.get_paginator('get_domains')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'domains': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'domainEntries': [
                {
                    'id': 'string',
                    'name': 'string',
                    'target': 'string',
                    'type': 'string',
                    'options': {
                        'string': 'string'
                    }
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- domains (list) –
  An array of key-value pairs containing information about each of the domain entries in the user’s account.
  - (dict) –
    Describes a domain where you are storing recordsets in Lightsail.
    - name (string) –
      The name of the domain.
    - arn (string) –
      The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-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 date when the domain recordset was created.
    - location (dict) –
      The AWS Region and Availability Zones where the domain recordset was created.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The resource type.
    - domainEntries (list) –
      An array of key-value pairs containing information about the domain entries.
      - (dict) –
        Describes a domain recordset entry.
        
        id (string) –
        The ID of the domain recordset entry.
        
        name (string) –
        The name of the domain.
        
        target (string) –
        The target AWS name server (e.g., ns-111.awsdns-22.com. ).
        
        type (string) –
        The type of domain entry (e.g., SOA or NS ).
        
        options (dict) –
        The options for the domain entry.
        
        (string) –
        
        (string) –
- NextToken (string) –
  A token to resume pagination.

class Lightsail.Paginator.GetInstanceSnapshots¶

paginator = client.get_paginator('get_instance_snapshots')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'instanceSnapshots': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'state': 'pending'|'error'|'available',
            'progress': 'string',
            'fromInstanceName': 'string',
            'fromInstanceArn': 'string',
            'fromBlueprintId': 'string',
            'fromBundleId': 'string',
            'sizeInGb': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- instanceSnapshots (list) –
  An array of key-value pairs containing information about the results of your get instance snapshots request.
  - (dict) –
    Describes the snapshot of the virtual private server, or instance .
    - name (string) –
      The name of the snapshot.
    - arn (string) –
      The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-1:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-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 snapshot was created (e.g., 1479907467.024 ).
    - location (dict) –
      The region name and availability zone where you created the snapshot.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The type of resource (usually InstanceSnapshot ).
    - state (string) –
      The state the snapshot is in.
    - progress (string) –
      The progress of the snapshot.
    - fromInstanceName (string) –
      The instance from which the snapshot was created.
    - fromInstanceArn (string) –
      The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE ).
    - fromBlueprintId (string) –
      The blueprint ID from which you created the snapshot (e.g., os_debian_8_3 ). A blueprint is a virtual private server (or instance ) image used to create instances quickly.
    - fromBundleId (string) –
      The bundle ID from which you created the snapshot (e.g., micro_1_0 ).
    - sizeInGb (integer) –
      The size in GB of the SSD.
- NextToken (string) –
  A token to resume pagination.

class Lightsail.Paginator.GetInstances¶

paginator = client.get_paginator('get_instances')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'instances': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'blueprintId': 'string',
            'blueprintName': 'string',
            'bundleId': 'string',
            'isStaticIp': True|False,
            'privateIpAddress': 'string',
            'publicIpAddress': 'string',
            'ipv6Address': 'string',
            'hardware': {
                'cpuCount': 123,
                'disks': [
                    {
                        '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                        },
                        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
                        'sizeInGb': 123,
                        'gbInUse': 123,
                        'isSystemDisk': True|False,
                        'iops': 123,
                        'path': 'string',
                        'attachedTo': 'string',
                        'isAttached': True|False,
                        'attachmentState': 'string'
                    },
                ],
                'ramSizeInGb': ...
            },
            'networking': {
                'monthlyTransfer': {
                    'gbPerMonthAllocated': 123
                },
                'ports': [
                    {
                        'fromPort': 123,
                        'toPort': 123,
                        'protocol': 'tcp'|'all'|'udp',
                        'accessFrom': 'string',
                        'accessType': 'Public'|'Private',
                        'commonName': 'string',
                        'accessDirection': 'inbound'|'outbound'
                    },
                ]
            },
            'state': {
                'code': 123,
                'name': 'string'
            },
            'username': 'string',
            'sshKeyName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- instances (list) –
  An array of key-value pairs containing information about your instances.
  - (dict) –
    Describes an instance (a virtual private server).
    - name (string) –
      The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1 ).
    - arn (string) –
      The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (e.g., 1479734909.17 ).
    - location (dict) –
      The region name and availability zone where the instance is located.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The type of resource (usually Instance ).
    - blueprintId (string) –
      The blueprint ID (e.g., os_amlinux_2016_03 ).
    - blueprintName (string) –
      The friendly name of the blueprint (e.g., Amazon Linux ).
    - bundleId (string) –
      The bundle for the instance (e.g., micro_1_0 ).
    - isStaticIp (boolean) –
      A Boolean value indicating whether this instance has a static IP assigned to it.
    - privateIpAddress (string) –
      The private IP address of the instance.
    - publicIpAddress (string) –
      The public IP address of the instance.
    - ipv6Address (string) –
      The IPv6 address of the instance.
    - hardware (dict) –
      The size of the vCPU and the amount of RAM for the instance.
      - cpuCount (integer) –
        The number of vCPUs the instance has.
      - disks (list) –
        The disks attached to the instance.
        
        (dict) –
        Describes the hard disk (an SSD).
        
        name (string) –
        The name of the disk.
        
        arn (string) –
        The Amazon Resource Name (ARN) of the disk.
        
        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 date when the disk was created.
        
        location (dict) –
        The region and Availability Zone where the disk is located.
        
        availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
        
        regionName (string) –
        The AWS Region name.
        
        resourceType (string) –
        The resource type of the disk.
        
        sizeInGb (integer) –
        The size of the disk in GB.
        
        gbInUse (integer) –
        The number of GB in use by the disk.
        
        isSystemDisk (boolean) –
        A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
        
        iops (integer) –
        The input/output operations per second (IOPS) of the disk.
        
        path (string) –
        The disk path.
        
        attachedTo (string) –
        The resources to which the disk is attached.
        
        isAttached (boolean) –
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) –
        The attachment state of the disk.
      - ramSizeInGb (float) –
        The amount of RAM in GB on the instance (e.g., 1.0 ).
    - networking (dict) –
      Information about the public ports and monthly data transfer rates for the instance.
      - monthlyTransfer (dict) –
        The amount of data in GB allocated for monthly data transfers.
        
        gbPerMonthAllocated (integer) –
        The amount allocated per month (in GB).
      - ports (list) –
        An array of key-value pairs containing information about the ports on the instance.
        
        (dict) –
        Describes information about the instance ports.
        
        fromPort (integer) –
        The first port in the range.
        
        toPort (integer) –
        The last port in the range.
        
        protocol (string) –
        The protocol being used. Can be one of the following.
        
        tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn’t require reliable data stream service, use UDP instead.
        
        all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
        
        udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don’t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
        
        accessFrom (string) –
        The location from which access is allowed (e.g., Anywhere (0.0.0.0/0) ).
        
        accessType (string) –
        The type of access (Public or Private ).
        
        commonName (string) –
        The common name.
        
        accessDirection (string) –
        The access direction (inbound or outbound ).
    - state (dict) –
      The status code and the state (e.g., running ) for the instance.
      - code (integer) –
        The status code for the instance.
      - name (string) –
        The state of the instance (e.g., running or pending ).
    - username (string) –
      The user name for connecting to the instance (e.g., ec2-user ).
    - sshKeyName (string) –
      The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).
- NextToken (string) –
  A token to resume pagination.

class Lightsail.Paginator.GetKeyPairs¶

paginator = client.get_paginator('get_key_pairs')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'keyPairs': [
        {
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            'fingerprint': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- keyPairs (list) –
  An array of key-value pairs containing information about the key pairs.
  - (dict) –
    Describes the SSH key pair.
    - name (string) –
      The friendly name of the SSH key pair.
    - arn (string) –
      The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-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 key pair was created (e.g., 1479816991.349 ).
    - location (dict) –
      The region name and Availability Zone where the key pair was created.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - resourceType (string) –
      The resource type (usually KeyPair ).
    - fingerprint (string) –
      The RSA fingerprint of the key pair.
- NextToken (string) –
  A token to resume pagination.

class Lightsail.Paginator.GetOperations¶

paginator = client.get_paginator('get_operations')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- operations (list) –
  An array of key-value pairs containing information about the results of your get operations 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 (e.g., 1479816991.349 ).
    - location (dict) –
      The region and Availability Zone.
      - availabilityZone (string) –
        The Availability Zone. Follows the format us-east-1a (case-sensitive).
      - regionName (string) –
        The AWS Region name.
    - isTerminal (boolean) –
      A Boolean value indicating whether the operation is terminal.
    - operationDetails (string) –
      Details about the operation (e.g., Debian-1GB-Virginia-1 ).
    - operationType (string) –
      The type of operation.
    - status (string) –
      The status of the operation.
    - statusChangedAt (datetime) –
      The timestamp when the status was changed (e.g., 1479816991.349 ).
    - errorCode (string) –
      The error code.
    - errorDetails (string) –
      The error details.
- NextToken (string) –
  A token to resume pagination.

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.
PageSize (integer) –
The size of each page.
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-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc',
            '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 the static IP.
    - name (string) –
      The name of the static IP (e.g., StaticIP-Virginia-EXAMPLE ).
    - arn (string) –
      The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-1: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-1a (case-sensitive).
      - regionName (string) –
        The AWS 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-Virginia-1 ).
    - isAttached (boolean) –
      A Boolean value indicating whether the static IP is attached.
- NextToken (string) –
  A token to resume pagination.

Table Of Contents

Contents

Lightsail¶

Client¶

Paginators¶

Lightsail ¶

Client ¶

Paginators ¶