AWS API Changes

2017/05/18 - Amazon Lightsail - 1 new27 updated api methods

Changes Update lightsail client to latest version

PutInstancePublicPorts (new)

Link ¶

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

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

type portInfos:

list

param portInfos:

[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.

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

AllocateStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

Allocates a static IP address.

See also: AWS API Documentation

Request Syntax

client.allocate_static_ip(
    staticIpName='string'
)

type staticIpName:

string

param staticIpName:

[REQUIRED]

The name of the static IP address.

rtype:

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

AttachStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

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

type staticIpName:

string

param staticIpName:

[REQUIRED]

The name of the static IP.

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

CloseInstancePublicPorts (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Closes the public ports on a specific Amazon Lightsail instance.

See also: AWS API Documentation

Request Syntax

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

type portInfo:

dict

param portInfo:

[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.

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

CreateDomain (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.create_domain(
    domainName='string'
)

type domainName:

string

param domainName:

[REQUIRED]

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

rtype:

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

CreateDomainEntry (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

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

type domainName:

string

param domainName:

[REQUIRED]

The domain name (e.g., example.com) for which you want to create the domain entry.

type domainEntry:

dict

param domainEntry:

[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) --

rtype:

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

CreateInstanceSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

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

type instanceSnapshotName:

string

param instanceSnapshotName:

[REQUIRED]

The name for your new snapshot.

type instanceName:

string

param instanceName:

[REQUIRED]

The Lightsail instance on which to base your snapshot.

rtype:

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

CreateInstances (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

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

type instanceNames:

list

param instanceNames:

[REQUIRED]

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

(string) --

type availabilityZone:

string

param availabilityZone:

[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.

type customImageName:

string

param customImageName:

The name for your custom image.

type blueprintId:

string

param blueprintId:

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

type bundleId:

string

param bundleId:

[REQUIRED]

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

type userData:

string

param userData:

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.

type keyPairName:

string

param keyPairName:

The name of your key pair.

rtype:

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

CreateInstancesFromSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

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

type instanceNames:

list

param instanceNames:

[REQUIRED]

The names for your new instances.

(string) --

type availabilityZone:

string

param availabilityZone:

[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.

type instanceSnapshotName:

string

param instanceSnapshotName:

[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.

type bundleId:

string

param bundleId:

[REQUIRED]

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

type userData:

string

param userData:

You can create a launch script that configures a server with additional user data. For example, apt-get –y update.

type keyPairName:

string

param keyPairName:

The name for your key pair.

rtype:

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

CreateKeyPair (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Creates sn SSH key pair.

See also: AWS API Documentation

Request Syntax

client.create_key_pair(
    keyPairName='string'
)

type keyPairName:

string

param keyPairName:

[REQUIRED]

The name for your new key pair.

rtype:

dict

returns:

Response Syntax

{
    'keyPair': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'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-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.

DeleteDomain (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.delete_domain(
    domainName='string'
)

type domainName:

string

param domainName:

[REQUIRED]

The specific domain name to delete.

rtype:

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

DeleteDomainEntry (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Deletes a specific domain entry.

See also: AWS API Documentation

Request Syntax

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

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain entry to delete.

type domainEntry:

dict

param domainEntry:

[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) --

rtype:

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

DeleteInstance (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.delete_instance(
    instanceName='string'
)

type instanceName:

string

param instanceName:

[REQUIRED]

The name of the instance to delete.

rtype:

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

DeleteInstanceSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.delete_instance_snapshot(
    instanceSnapshotName='string'
)

type instanceSnapshotName:

string

param instanceSnapshotName:

[REQUIRED]

The name of the snapshot to delete.

rtype:

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

DeleteKeyPair (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Deletes a specific SSH key pair.

See also: AWS API Documentation

Request Syntax

client.delete_key_pair(
    keyPairName='string'
)

type keyPairName:

string

param keyPairName:

[REQUIRED]

The name of the key pair to delete.

rtype:

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

DetachStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.detach_static_ip(
    staticIpName='string'
)

type staticIpName:

string

param staticIpName:

[REQUIRED]

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

rtype:

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

GetOperation (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

client.get_operation(
    operationId='string'
)

type operationId:

string

param operationId:

[REQUIRED]

A GUID used to identify the operation.

rtype:

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

GetOperations (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

client.get_operations(
    pageToken='string'
)

type pageToken:

string

param pageToken:

A token used for advancing to the next page of results from your get operations request.

rtype:

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

GetOperationsForResource (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

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

type resourceName:

string

param resourceName:

[REQUIRED]

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

type pageToken:

string

param pageToken:

A token used for advancing to the next page of results from your get operations for resource request.

rtype:

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-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'
}

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) --
  
  Returns the number of pages of results that remain.

ImportKeyPair (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Imports a public SSH key from a specific key pair.

See also: AWS API Documentation

Request Syntax

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

type keyPairName:

string

param keyPairName:

[REQUIRED]

The name of the key pair for which you want to import the public key.

type publicKeyBase64:

string

param publicKeyBase64:

[REQUIRED]

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

rtype:

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

OpenInstancePublicPorts (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

Adds public ports to an Amazon Lightsail instance.

See also: AWS API Documentation

Request Syntax

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

type portInfo:

dict

param portInfo:

[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.

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

PeerVpc (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.peer_vpc()

rtype:

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

RebootInstance (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

client.reboot_instance(
    instanceName='string'
)

type instanceName:

string

param instanceName:

[REQUIRED]

The name of the instance to reboot.

rtype:

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

ReleaseStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

Deletes a specific static IP from your account.

See also: AWS API Documentation

Request Syntax

client.release_static_ip(
    staticIpName='string'
)

type staticIpName:

string

param staticIpName:

[REQUIRED]

The name of the static IP to delete.

rtype:

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

StartInstance (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

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

client.start_instance(
    instanceName='string'
)

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

StopInstance (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

Stops a specific Amazon Lightsail instance that is currently running.

See also: AWS API Documentation

Request Syntax

client.stop_instance(
    instanceName='string'
)

type instanceName:

string

param instanceName:

[REQUIRED]

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

rtype:

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

UnpeerVpc (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'PutInstancePublicPorts'}}}

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

See also: AWS API Documentation

Request Syntax

client.unpeer_vpc()

rtype:

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

UpdateDomainEntry (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'PutInstancePublicPorts'}}}

Updates a domain recordset after it is created.

See also: AWS API Documentation

Request Syntax

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

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain recordset to update.

type domainEntry:

dict

param domainEntry:

[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) --

rtype:

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