AWS API Changes

2018/03/15 - Amazon Lightsail - 61 updated api methods

AllocateStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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.

AttachDisk (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

See also: AWS API Documentation

Request Syntax

client.attach_disk(
    diskName='string',
    instanceName='string',
    diskPath='string'
)

type diskName

string

param diskName

[REQUIRED]

The unique Lightsail disk name (e.g., my-disk ).

type instanceName

string

param instanceName

[REQUIRED]

The name of the Lightsail instance where you want to utilize the storage disk.

type diskPath

string

param diskPath

[REQUIRED]

The disk path to expose to the instance (e.g., /dev/xvdf ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

AttachInstancesToLoadBalancer (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

See also: AWS API Documentation

Request Syntax

client.attach_instances_to_load_balancer(
    loadBalancerName='string',
    instanceNames=[
        'string',
    ]
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer.

type instanceNames

list

param instanceNames

[REQUIRED]

An array of strings representing the instance name(s) you want to attach to your load balancer.

An instance must be running before you can attach it to your load balancer.

There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).

(string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object representing the 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-2a (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-Ohio-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.

AttachLoadBalancerTlsCertificate (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

See also: AWS API Documentation

Request Syntax

client.attach_load_balancer_tls_certificate(
    loadBalancerName='string',
    certificateName='string'
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer to which you want to associate the SSL/TLS certificate.

type certificateName

string

param certificateName

[REQUIRED]

The name of your SSL/TLS certificate.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object representing the API operations.
  
  These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
  - (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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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.

CreateDisk (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a ). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail .

See also: AWS API Documentation

Request Syntax

client.create_disk(
    diskName='string',
    availabilityZone='string',
    sizeInGb=123
)

type diskName

string

param diskName

[REQUIRED]

The unique Lightsail disk name (e.g., my-disk ).

type availabilityZone

string

param availabilityZone

[REQUIRED]

The Availability Zone where you want to create the disk (e.g., us-east-2a ). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

type sizeInGb

integer

param sizeInGb

[REQUIRED]

The size of the disk in GB (e.g., 32 ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

CreateDiskFromSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a ). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail .

See also: AWS API Documentation

Request Syntax

client.create_disk_from_snapshot(
    diskName='string',
    diskSnapshotName='string',
    availabilityZone='string',
    sizeInGb=123
)

type diskName

string

param diskName

[REQUIRED]

The unique Lightsail disk name (e.g., my-disk ).

type diskSnapshotName

string

param diskSnapshotName

[REQUIRED]

The name of the disk snapshot (e.g., my-snapshot ) from which to create the new storage disk.

type availabilityZone

string

param availabilityZone

[REQUIRED]

The Availability Zone where you want to create the disk (e.g., us-east-2a ). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

type sizeInGb

integer

param sizeInGb

[REQUIRED]

The size of the disk in GB (e.g., 32 ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

CreateDiskSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

See also: AWS API Documentation

Request Syntax

client.create_disk_snapshot(
    diskName='string',
    diskSnapshotName='string'
)

type diskName

string

param diskName

[REQUIRED]

The unique name of the source disk (e.g., my-source-disk ).

type diskSnapshotName

string

param diskSnapshotName

[REQUIRED]

The name of the destination disk snapshot (e.g., my-disk-snapshot ) based on the source disk.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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

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.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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',
        'isAlias': True|False,
        '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. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.
isAlias (boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
type (string) --

The type of domain entry (e.g., SOA or NS ).
options (dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
- (string) --
  - (string) --

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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-2a (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

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

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 .

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 .

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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',
    ],
    attachedDiskMapping={
        'string': [
            {
                'originalDiskPath': 'string',
                'newDiskName': '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 attachedDiskMapping

dict

param attachedDiskMapping

An object containing information about one or more disk mappings.

(string) --
- (list) --
  - (dict) --
    
    Describes a block storage disk mapping.
    - originalDiskPath (string) --
      
      The original disk path exposed to the instance (for example, /dev/sdh ).
    - newDiskName (string) --
      
      The new disk name (e.g., my-new-disk ).

type availabilityZone

string

param availabilityZone

[REQUIRED]

The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (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 .

Note

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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)

{'keyPair': {'location': {'regionName': ['eu-west-2']}},
 'operation': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'fingerprint': 'string'
    },
    'publicKeyBase64': 'string',
    'privateKeyBase64': 'string',
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2: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-2a (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-2a (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-Ohio-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.

CreateLoadBalancer (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing . You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

See also: AWS API Documentation

Request Syntax

client.create_load_balancer(
    loadBalancerName='string',
    instancePort=123,
    healthCheckPath='string',
    certificateName='string',
    certificateDomainName='string',
    certificateAlternativeNames=[
        'string',
    ]
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of your load balancer.

type instancePort

integer

param instancePort

[REQUIRED]

The instance port where you're creating your load balancer.

type healthCheckPath

string

param healthCheckPath

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/" ).

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

type certificateName

string

param certificateName

The name of the SSL/TLS certificate.

If you specify certificateName , then certificateDomainName is required (and vice-versa).

type certificateDomainName

string

param certificateDomainName

The domain name with which your certificate is associated (e.g., example.com ).

If you specify certificateDomainName , then certificateName is required (and vice-versa).

type certificateAlternativeNames

list

param certificateAlternativeNames

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com , example.com , m.example.com , blog.example.com ).

(string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object containing information about the 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-2a (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-Ohio-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.

CreateLoadBalancerTlsCertificate (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Creates a Lightsail load balancer TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

See also: AWS API Documentation

Request Syntax

client.create_load_balancer_tls_certificate(
    loadBalancerName='string',
    certificateName='string',
    certificateDomainName='string',
    certificateAlternativeNames=[
        'string',
    ]
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The load balancer name where you want to create the SSL/TLS certificate.

type certificateName

string

param certificateName

[REQUIRED]

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits .

type certificateDomainName

string

param certificateDomainName

[REQUIRED]

The domain name (e.g., example.com ) for your SSL/TLS certificate.

type certificateAlternativeNames

list

param certificateAlternativeNames

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com ).

(string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object containing information about the 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-2a (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-Ohio-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.

DeleteDisk (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

Note

The disk may remain in the deleting state for several minutes.

See also: AWS API Documentation

Request Syntax

client.delete_disk(
    diskName='string'
)

type diskName

string

param diskName

[REQUIRED]

The unique name of the disk you want to delete (e.g., my-disk ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

DeleteDiskSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

See also: AWS API Documentation

Request Syntax

client.delete_disk_snapshot(
    diskSnapshotName='string'
)

type diskSnapshotName

string

param diskSnapshotName

[REQUIRED]

The name of the disk snapshot you want to delete (e.g., my-disk-snapshot ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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',
        'isAlias': True|False,
        '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. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.
isAlias (boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
type (string) --

The type of domain entry (e.g., SOA or NS ).
options (dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
- (string) --
  - (string) --

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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.

DeleteLoadBalancer (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

See also: AWS API Documentation

Request Syntax

client.delete_load_balancer(
    loadBalancerName='string'
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer you want to delete.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

DeleteLoadBalancerTlsCertificate (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

See also: AWS API Documentation

Request Syntax

client.delete_load_balancer_tls_certificate(
    loadBalancerName='string',
    certificateName='string',
    force=True|False
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The load balancer name.

type certificateName

string

param certificateName

[REQUIRED]

The SSL/TLS certificate name.

type force

boolean

param force

When true , forces the deletion of an SSL/TLS certificate.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

DetachDisk (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

See also: AWS API Documentation

Request Syntax

client.detach_disk(
    diskName='string'
)

type diskName

string

param diskName

[REQUIRED]

The unique name of the disk you want to detach from your instance (e.g., my-disk ).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.

DetachInstancesFromLoadBalancer (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

See also: AWS API Documentation

Request Syntax

client.detach_instances_from_load_balancer(
    loadBalancerName='string',
    instanceNames=[
        'string',
    ]
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the Lightsail load balancer.

type instanceNames

list

param instanceNames

[REQUIRED]

An array of strings containing the names of the instances you want to detach from the load balancer.

(string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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.

GetDisk (updated)

Link ¶
Changes (response)

{'disk': {'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific block storage disk.

See also: AWS API Documentation

Request Syntax

client.get_disk(
    diskName='string'
)

type diskName

string

param diskName

[REQUIRED]

The name of the disk (e.g., my-disk ).

rtype

dict

returns

Response Syntax

{
    'disk': {
        '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'sizeInGb': 123,
        'isSystemDisk': True|False,
        'iops': 123,
        'path': 'string',
        'state': 'pending'|'error'|'available'|'in-use'|'unknown',
        'attachedTo': 'string',
        'isAttached': True|False,
        'attachmentState': 'string',
        'gbInUse': 123
    }
}

Response Structure

(dict) --
- disk (dict) --
  
  An object containing information about the disk.
  - name (string) --
    
    The unique 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 AWS Region and Availability Zone where the disk is located.
    - availabilityZone (string) --
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) --
      
      The AWS Region name.
  - resourceType (string) --
    
    The Lightsail resource type (e.g., Disk ).
  - sizeInGb (integer) --
    
    The size of the disk in GB.
  - 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.
  - state (string) --
    
    Describes the status of the disk.
  - attachedTo (string) --
    
    The resources to which the disk is attached.
  - isAttached (boolean) --
    
    A Boolean value indicating whether the disk is attached.
  - attachmentState (string) --
    
    (Deprecated) The attachment state of the disk.
    
    Note
    
    In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
  - gbInUse (integer) --
    
    (Deprecated) The number of GB in use by the disk.
    
    Note
    
    In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

GetDiskSnapshot (updated)

Link ¶
Changes (response)

{'diskSnapshot': {'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific block storage disk snapshot.

See also: AWS API Documentation

Request Syntax

client.get_disk_snapshot(
    diskSnapshotName='string'
)

type diskSnapshotName

string

param diskSnapshotName

[REQUIRED]

The name of the disk snapshot (e.g., my-disk-snapshot ).

rtype

dict

returns

Response Syntax

{
    'diskSnapshot': {
        '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'sizeInGb': 123,
        'state': 'pending'|'completed'|'error'|'unknown',
        'progress': 'string',
        'fromDiskName': 'string',
        'fromDiskArn': 'string'
    }
}

Response Structure

(dict) --
- diskSnapshot (dict) --
  
  An object containing information about the disk snapshot.
  - name (string) --
    
    The name of the disk snapshot (e.g., my-disk-snapshot ).
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the disk snapshot.
  - 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 snapshot was created.
  - location (dict) --
    
    The AWS Region and Availability Zone where the disk snapshot was created.
    - availabilityZone (string) --
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) --
      
      The AWS Region name.
  - resourceType (string) --
    
    The Lightsail resource type (e.g., DiskSnapshot ).
  - sizeInGb (integer) --
    
    The size of the disk in GB.
  - state (string) --
    
    The status of the disk snapshot operation.
  - progress (string) --
    
    The progress of the disk snapshot operation.
  - fromDiskName (string) --
    
    The unique name of the source disk from which you are creating the disk snapshot.
  - fromDiskArn (string) --
    
    The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.

GetDiskSnapshots (updated)

Link ¶
Changes (response)

{'diskSnapshots': {'location': {'regionName': ['eu-west-2']}}}

Returns information about all block storage disk snapshots in your AWS account and region.

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

See also: AWS API Documentation

Request Syntax

client.get_disk_snapshots(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

dict

returns

Response Syntax

{
    'diskSnapshots': [
        {
            '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'sizeInGb': 123,
            'state': 'pending'|'completed'|'error'|'unknown',
            'progress': 'string',
            'fromDiskName': 'string',
            'fromDiskArn': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- diskSnapshots (list) --
  
  An array of objects containing information about all block storage disk snapshots.
  - (dict) --
    
    Describes a block storage disk snapshot.
    - name (string) --
      
      The name of the disk snapshot (e.g., my-disk-snapshot ).
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the disk snapshot.
    - 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 snapshot was created.
    - location (dict) --
      
      The AWS Region and Availability Zone where the disk snapshot was created.
      - availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) --
        
        The AWS Region name.
    - resourceType (string) --
      
      The Lightsail resource type (e.g., DiskSnapshot ).
    - sizeInGb (integer) --
      
      The size of the disk in GB.
    - state (string) --
      
      The status of the disk snapshot operation.
    - progress (string) --
      
      The progress of the disk snapshot operation.
    - fromDiskName (string) --
      
      The unique name of the source disk from which you are creating the disk snapshot.
    - fromDiskArn (string) --
      
      The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.
- nextPageToken (string) --
  
  A token used for advancing to the next page of results from your GetDiskSnapshots request.

GetDisks (updated)

Link ¶
Changes (response)

{'disks': {'location': {'regionName': ['eu-west-2']}}}

Returns information about all block storage disks in your AWS account and region.

If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

See also: AWS API Documentation

Request Syntax

client.get_disks(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

dict

returns

Response Syntax

{
    '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'sizeInGb': 123,
            'isSystemDisk': True|False,
            'iops': 123,
            'path': 'string',
            'state': 'pending'|'error'|'available'|'in-use'|'unknown',
            'attachedTo': 'string',
            'isAttached': True|False,
            'attachmentState': 'string',
            'gbInUse': 123
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- disks (list) --
  
  An array of objects containing information about all block storage disks.
  - (dict) --
    
    Describes a system disk or an block storage disk.
    - name (string) --
      
      The unique 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 AWS Region and Availability Zone where the disk is located.
      - availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) --
        
        The AWS Region name.
    - resourceType (string) --
      
      The Lightsail resource type (e.g., Disk ).
    - sizeInGb (integer) --
      
      The size of the disk in GB.
    - 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.
    - state (string) --
      
      Describes the status of the disk.
    - attachedTo (string) --
      
      The resources to which the disk is attached.
    - isAttached (boolean) --
      
      A Boolean value indicating whether the disk is attached.
    - attachmentState (string) --
      
      (Deprecated) The attachment state of the disk.
      
      Note
      
      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
    - gbInUse (integer) --
      
      (Deprecated) The number of GB in use by the disk.
      
      Note
      
      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
- nextPageToken (string) --
  
  A token used for advancing to the next page of results from your GetDisks request.

GetDomain (updated)

Link ¶
Changes (response)

{'domain': {'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific domain recordset.

See also: AWS API Documentation

Request Syntax

client.get_domain(
    domainName='string'
)

type domainName

string

param domainName

[REQUIRED]

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'domainEntries': [
            {
                'id': 'string',
                'name': 'string',
                'target': 'string',
                'isAlias': True|False,
                '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-2a (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. ).
        
        For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.
      - isAlias (boolean) --
        
        When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
      - type (string) --
        
        The type of domain entry (e.g., SOA or NS ).
      - options (dict) --
        
        (Deprecated) The options for the domain entry.
        
        Note
        
        In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
        
        (string) --
        
        (string) --

GetDomains (updated)

Link ¶
Changes (response)

{'domains': {'location': {'regionName': ['eu-west-2']}}}

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

See also: AWS API Documentation

Request Syntax

client.get_domains(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'domainEntries': [
                {
                    'id': 'string',
                    'name': 'string',
                    'target': 'string',
                    'isAlias': True|False,
                    '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-2a (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. ).
        
        For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.
        
        isAlias (boolean) --
        
        When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
        
        type (string) --
        
        The type of domain entry (e.g., SOA or NS ).
        
        options (dict) --
        
        (Deprecated) The options for the domain entry.
        
        Note
        
        In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
        
        (string) --
        
        (string) --
- nextPageToken (string) --
  
  A token used for advancing to the next page of results from your get active names request.

GetInstance (updated)

Link ¶
Changes (response)

{'instance': {'hardware': {'disks': {'location': {'regionName': ['eu-west-2']}}},
              'location': {'regionName': ['eu-west-2']}}}

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

See also: AWS API Documentation

Request Syntax

client.get_instance(
    instanceName='string'
)

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance.

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                    },
                    'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
                    'sizeInGb': 123,
                    'isSystemDisk': True|False,
                    'iops': 123,
                    'path': 'string',
                    'state': 'pending'|'error'|'available'|'in-use'|'unknown',
                    'attachedTo': 'string',
                    'isAttached': True|False,
                    'attachmentState': 'string',
                    'gbInUse': 123
                },
            ],
            '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-Ohio-1 ).
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2: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-2a (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 a system disk or an block storage disk.
        
        name (string) --
        
        The unique 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 AWS Region and Availability Zone where the disk is located.
        
        availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
        
        regionName (string) --
        
        The AWS Region name.
        
        resourceType (string) --
        
        The Lightsail resource type (e.g., Disk ).
        
        sizeInGb (integer) --
        
        The size of the disk in GB.
        
        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.
        
        state (string) --
        
        Describes the status of the disk.
        
        attachedTo (string) --
        
        The resources to which the disk is attached.
        
        isAttached (boolean) --
        
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) --
        
        (Deprecated) The attachment state of the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
        
        gbInUse (integer) --
        
        (Deprecated) The number of GB in use by the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
    - 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 ).

GetInstanceSnapshot (updated)

Link ¶
Changes (response)

{'instanceSnapshot': {'fromAttachedDisks': {'location': {'regionName': ['eu-west-2']}},
                      'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific instance snapshot.

See also: AWS API Documentation

Request Syntax

client.get_instance_snapshot(
    instanceSnapshotName='string'
)

type instanceSnapshotName

string

param instanceSnapshotName

[REQUIRED]

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'state': 'pending'|'error'|'available',
        'progress': 'string',
        'fromAttachedDisks': [
            {
                '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                },
                'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
                'sizeInGb': 123,
                'isSystemDisk': True|False,
                'iops': 123,
                'path': 'string',
                'state': 'pending'|'error'|'available'|'in-use'|'unknown',
                'attachedTo': 'string',
                'isAttached': True|False,
                'attachmentState': 'string',
                'gbInUse': 123
            },
        ],
        '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-2: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-2a (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.
  - fromAttachedDisks (list) --
    
    An array of disk objects containing information about all block storage disks.
    - (dict) --
      
      Describes a system disk or an block storage disk.
      - name (string) --
        
        The unique 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 AWS Region and Availability Zone where the disk is located.
        
        availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
        
        regionName (string) --
        
        The AWS Region name.
      - resourceType (string) --
        
        The Lightsail resource type (e.g., Disk ).
      - sizeInGb (integer) --
        
        The size of the disk in GB.
      - 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.
      - state (string) --
        
        Describes the status of the disk.
      - attachedTo (string) --
        
        The resources to which the disk is attached.
      - isAttached (boolean) --
        
        A Boolean value indicating whether the disk is attached.
      - attachmentState (string) --
        
        (Deprecated) The attachment state of the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
      - gbInUse (integer) --
        
        (Deprecated) The number of GB in use by the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
  - 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-2: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.

GetInstanceSnapshots (updated)

Link ¶
Changes (response)

{'instanceSnapshots': {'fromAttachedDisks': {'location': {'regionName': ['eu-west-2']}},
                       'location': {'regionName': ['eu-west-2']}}}

Returns all instance snapshots for the user's account.

See also: AWS API Documentation

Request Syntax

client.get_instance_snapshots(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'state': 'pending'|'error'|'available',
            'progress': 'string',
            'fromAttachedDisks': [
                {
                    '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                    },
                    'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
                    'sizeInGb': 123,
                    'isSystemDisk': True|False,
                    'iops': 123,
                    'path': 'string',
                    'state': 'pending'|'error'|'available'|'in-use'|'unknown',
                    'attachedTo': 'string',
                    'isAttached': True|False,
                    'attachmentState': 'string',
                    'gbInUse': 123
                },
            ],
            '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-2: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-2a (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.
    - fromAttachedDisks (list) --
      
      An array of disk objects containing information about all block storage disks.
      - (dict) --
        
        Describes a system disk or an block storage disk.
        
        name (string) --
        
        The unique 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 AWS Region and Availability Zone where the disk is located.
        
        availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
        
        regionName (string) --
        
        The AWS Region name.
        
        resourceType (string) --
        
        The Lightsail resource type (e.g., Disk ).
        
        sizeInGb (integer) --
        
        The size of the disk in GB.
        
        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.
        
        state (string) --
        
        Describes the status of the disk.
        
        attachedTo (string) --
        
        The resources to which the disk is attached.
        
        isAttached (boolean) --
        
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) --
        
        (Deprecated) The attachment state of the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
        
        gbInUse (integer) --
        
        (Deprecated) The number of GB in use by the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
    - 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-2: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.

GetInstances (updated)

Link ¶
Changes (response)

{'instances': {'hardware': {'disks': {'location': {'regionName': ['eu-west-2']}}},
               'location': {'regionName': ['eu-west-2']}}}

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

See also: AWS API Documentation

Request Syntax

client.get_instances(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                        },
                        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
                        'sizeInGb': 123,
                        'isSystemDisk': True|False,
                        'iops': 123,
                        'path': 'string',
                        'state': 'pending'|'error'|'available'|'in-use'|'unknown',
                        'attachedTo': 'string',
                        'isAttached': True|False,
                        'attachmentState': 'string',
                        'gbInUse': 123
                    },
                ],
                '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-Ohio-1 ).
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2: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-2a (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 a system disk or an block storage disk.
        
        name (string) --
        
        The unique 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 AWS Region and Availability Zone where the disk is located.
        
        availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
        
        regionName (string) --
        
        The AWS Region name.
        
        resourceType (string) --
        
        The Lightsail resource type (e.g., Disk ).
        
        sizeInGb (integer) --
        
        The size of the disk in GB.
        
        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.
        
        state (string) --
        
        Describes the status of the disk.
        
        attachedTo (string) --
        
        The resources to which the disk is attached.
        
        isAttached (boolean) --
        
        A Boolean value indicating whether the disk is attached.
        
        attachmentState (string) --
        
        (Deprecated) The attachment state of the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
        
        gbInUse (integer) --
        
        (Deprecated) The number of GB in use by the disk.
        
        Note
        
        In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
      - 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.

GetKeyPair (updated)

Link ¶
Changes (response)

{'keyPair': {'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific key pair.

See also: AWS API Documentation

Request Syntax

client.get_key_pair(
    keyPairName='string'
)

type keyPairName

string

param keyPairName

[REQUIRED]

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

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-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        '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-2: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-2a (case-sensitive).
    - regionName (string) --
      
      The AWS Region name.
  - resourceType (string) --
    
    The resource type (usually KeyPair ).
  - fingerprint (string) --
    
    The RSA fingerprint of the key pair.

GetKeyPairs (updated)

Link ¶
Changes (response)

{'keyPairs': {'location': {'regionName': ['eu-west-2']}}}

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

See also: AWS API Documentation

Request Syntax

client.get_key_pairs(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            '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-2: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-2a (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.

GetLoadBalancer (updated)

Link ¶
Changes (response)

{'loadBalancer': {'location': {'regionName': ['eu-west-2']}}}

Returns information about the specified Lightsail load balancer.

See also: AWS API Documentation

Request Syntax

client.get_load_balancer(
    loadBalancerName='string'
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer.

rtype

dict

returns

Response Syntax

{
    'loadBalancer': {
        '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'dnsName': 'string',
        'state': 'active'|'provisioning'|'active_impaired'|'failed'|'unknown',
        'protocol': 'HTTP_HTTPS'|'HTTP',
        'publicPorts': [
            123,
        ],
        'healthCheckPath': 'string',
        'instancePort': 123,
        'instanceHealthSummary': [
            {
                'instanceName': 'string',
                'instanceHealth': 'initial'|'healthy'|'unhealthy'|'unused'|'draining'|'unavailable',
                'instanceHealthReason': 'Lb.RegistrationInProgress'|'Lb.InitialHealthChecking'|'Lb.InternalError'|'Instance.ResponseCodeMismatch'|'Instance.Timeout'|'Instance.FailedHealthChecks'|'Instance.NotRegistered'|'Instance.NotInUse'|'Instance.DeregistrationInProgress'|'Instance.InvalidState'|'Instance.IpUnusable'
            },
        ],
        'tlsCertificateSummaries': [
            {
                'name': 'string',
                'isAttached': True|False
            },
        ],
        'configurationOptions': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- loadBalancer (dict) --
  
  An object containing information about your load balancer.
  - name (string) --
    
    The name of the load balancer (e.g., my-load-balancer ).
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the load balancer.
  - supportCode (string) --
    
    The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) --
    
    The date when your load balancer was created.
  - location (dict) --
    
    The AWS Region where your load balancer was created (e.g., us-east-2a ). Lightsail automatically creates your load balancer across Availability Zones.
    - availabilityZone (string) --
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) --
      
      The AWS Region name.
  - resourceType (string) --
    
    The resource type (e.g., LoadBalancer .
  - dnsName (string) --
    
    The DNS name of your Lightsail load balancer.
  - state (string) --
    
    The status of your load balancer. Valid values are below.
  - protocol (string) --
    
    The protocol you have enabled for your load balancer. Valid values are below.
    
    You can't just have HTTP_HTTPS , but you can have just HTTP .
  - publicPorts (list) --
    
    An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
    - (integer) --
  - healthCheckPath (string) --
    
    The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
  - instancePort (integer) --
    
    The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.
  - instanceHealthSummary (list) --
    
    An array of InstanceHealthSummary objects describing the health of the load balancer.
    - (dict) --
      
      Describes information about the health of the instance.
      - instanceName (string) --
        
        The name of the Lightsail instance for which you are requesting health check data.
      - instanceHealth (string) --
        
        Describes the overall instance health. Valid values are below.
      - instanceHealthReason (string) --
        
        More information about the instance health. If the instanceHealth is healthy , then an instanceHealthReason value is not provided.
        
        If ** instanceHealth ** is initial , the ** instanceHealthReason ** value can be one of the following:
        
        **Lb.RegistrationInProgress ** - The target instance is in the process of being registered with the load balancer.
        
        **Lb.InitialHealthChecking ** - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
        
        If ** instanceHealth ** is unhealthy , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.ResponseCodeMismatch ** - The health checks did not return an expected HTTP code.
        
        **Instance.Timeout ** - The health check requests timed out.
        
        **Instance.FailedHealthChecks ** - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
        
        **Lb.InternalError ** - The health checks failed due to an internal error.
        
        If ** instanceHealth ** is unused , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.NotRegistered ** - The target instance is not registered with the target group.
        
        **Instance.NotInUse ** - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
        
        **Instance.IpUnusable ** - The target IP address is reserved for use by a Lightsail load balancer.
        
        **Instance.InvalidState ** - The target is in the stopped or terminated state.
        
        If ** instanceHealth ** is draining , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.DeregistrationInProgress ** - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
  - tlsCertificateSummaries (list) --
    
    An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true , the certificate is attached to the load balancer.
    - (dict) --
      
      Provides a summary of SSL/TLS certificate metadata.
      - name (string) --
        
        The name of the SSL/TLS certificate.
      - isAttached (boolean) --
        
        When true , the SSL/TLS certificate is attached to the Lightsail load balancer.
  - configurationOptions (dict) --
    
    A string to string map of the configuration options for your load balancer. Valid values are listed below.
    - (string) --
      - (string) --

GetLoadBalancerTlsCertificates (updated)

Link ¶
Changes (response)

{'tlsCertificates': {'location': {'regionName': ['eu-west-2']}}}

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

See also: AWS API Documentation

Request Syntax

client.get_load_balancer_tls_certificates(
    loadBalancerName='string'
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer you associated with your SSL/TLS certificate.

rtype

dict

returns

Response Syntax

{
    'tlsCertificates': [
        {
            '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'loadBalancerName': 'string',
            'isAttached': True|False,
            'status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED'|'UNKNOWN',
            'domainName': 'string',
            'domainValidationRecords': [
                {
                    'name': 'string',
                    'type': 'string',
                    'value': 'string',
                    'validationStatus': 'PENDING_VALIDATION'|'FAILED'|'SUCCESS',
                    'domainName': 'string'
                },
            ],
            'failureReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'OTHER',
            'issuedAt': datetime(2015, 1, 1),
            'issuer': 'string',
            'keyAlgorithm': 'string',
            'notAfter': datetime(2015, 1, 1),
            'notBefore': datetime(2015, 1, 1),
            'renewalSummary': {
                'renewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
                'domainValidationOptions': [
                    {
                        'domainName': 'string',
                        'validationStatus': 'PENDING_VALIDATION'|'FAILED'|'SUCCESS'
                    },
                ]
            },
            'revocationReason': 'UNSPECIFIED'|'KEY_COMPROMISE'|'CA_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERCEDED'|'CESSATION_OF_OPERATION'|'CERTIFICATE_HOLD'|'REMOVE_FROM_CRL'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE',
            'revokedAt': datetime(2015, 1, 1),
            'serial': 'string',
            'signatureAlgorithm': 'string',
            'subject': 'string',
            'subjectAlternativeNames': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) --
- tlsCertificates (list) --
  
  An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
  - (dict) --
    
    Describes a load balancer SSL/TLS certificate.
    
    TLS is just an updated, more secure version of Secure Socket Layer (SSL).
    - name (string) --
      
      The name of the SSL/TLS certificate (e.g., my-certificate ).
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the SSL/TLS certificate.
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The time when you created your SSL/TLS certificate.
    - location (dict) --
      
      The AWS Region and Availability Zone where you created your certificate.
      - availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) --
        
        The AWS Region name.
    - resourceType (string) --
      
      The resource type (e.g., LoadBalancerTlsCertificate ).
      - **Instance ** - A Lightsail instance (a virtual private server)
      - **StaticIp ** - A static IP address
      - **KeyPair ** - The key pair used to connect to a Lightsail instance
      - **InstanceSnapshot ** - A Lightsail instance snapshot
      - **Domain ** - A DNS zone
      - **PeeredVpc ** - A peered VPC
      - **LoadBalancer ** - A Lightsail load balancer
      - **LoadBalancerTlsCertificate ** - An SSL/TLS certificate associated with a Lightsail load balancer
      - **Disk ** - A Lightsail block storage disk
      - **DiskSnapshot ** - A block storage disk snapshot
    - loadBalancerName (string) --
      
      The load balancer name where your SSL/TLS certificate is attached.
    - isAttached (boolean) --
      
      When true , the SSL/TLS certificate is attached to the Lightsail load balancer.
    - status (string) --
      
      The status of the SSL/TLS certificate. Valid values are below.
    - domainName (string) --
      
      The domain name for your SSL/TLS certificate.
    - domainValidationRecords (list) --
      
      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
      - (dict) --
        
        Describes the validation record of each domain name in the SSL/TLS certificate.
        
        name (string) --
        
        A fully qualified domain name in the certificate. For example, example.com .
        
        type (string) --
        
        The type of validation record. For example, CNAME for domain validation.
        
        value (string) --
        
        The value for that type.
        
        validationStatus (string) --
        
        The validation status. Valid values are listed below.
        
        domainName (string) --
        
        The domain name against which your SSL/TLS certificate was validated.
    - failureReason (string) --
      
      The reason for the SSL/TLS certificate validation failure.
    - issuedAt (datetime) --
      
      The time when the SSL/TLS certificate was issued.
    - issuer (string) --
      
      The issuer of the certificate.
    - keyAlgorithm (string) --
      
      The algorithm that was used to generate the key pair (the public and private key).
    - notAfter (datetime) --
      
      The timestamp when the SSL/TLS certificate expires.
    - notBefore (datetime) --
      
      The timestamp when the SSL/TLS certificate is first valid.
    - renewalSummary (dict) --
      
      An object containing information about the status of Lightsail's managed renewal for the certificate.
      - renewalStatus (string) --
        
        The status of Lightsail's managed renewal of the certificate. Valid values are listed below.
      - domainValidationOptions (list) --
        
        Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
        
        (dict) --
        
        Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.
        
        domainName (string) --
        
        The fully qualified domain name in the certificate request.
        
        validationStatus (string) --
        
        The status of the domain validation. Valid values are listed below.
    - revocationReason (string) --
      
      The reason the certificate was revoked. Valid values are below.
    - revokedAt (datetime) --
      
      The timestamp when the SSL/TLS certificate was revoked.
    - serial (string) --
      
      The serial number of the certificate.
    - signatureAlgorithm (string) --
      
      The algorithm that was used to sign the certificate.
    - subject (string) --
      
      The name of the entity that is associated with the public key contained in the certificate.
    - subjectAlternativeNames (list) --
      
      One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com , www.example.com , or m.example.com .
      - (string) --

GetLoadBalancers (updated)

Link ¶
Changes (response)

{'loadBalancers': {'location': {'regionName': ['eu-west-2']}}}

Returns information about all load balancers in an account.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

See also: AWS API Documentation

Request Syntax

client.get_load_balancers(
    pageToken='string'
)

type pageToken

string

param pageToken

A token used for paginating the results from your GetLoadBalancers request.

rtype

dict

returns

Response Syntax

{
    'loadBalancers': [
        {
            '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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'dnsName': 'string',
            'state': 'active'|'provisioning'|'active_impaired'|'failed'|'unknown',
            'protocol': 'HTTP_HTTPS'|'HTTP',
            'publicPorts': [
                123,
            ],
            'healthCheckPath': 'string',
            'instancePort': 123,
            'instanceHealthSummary': [
                {
                    'instanceName': 'string',
                    'instanceHealth': 'initial'|'healthy'|'unhealthy'|'unused'|'draining'|'unavailable',
                    'instanceHealthReason': 'Lb.RegistrationInProgress'|'Lb.InitialHealthChecking'|'Lb.InternalError'|'Instance.ResponseCodeMismatch'|'Instance.Timeout'|'Instance.FailedHealthChecks'|'Instance.NotRegistered'|'Instance.NotInUse'|'Instance.DeregistrationInProgress'|'Instance.InvalidState'|'Instance.IpUnusable'
                },
            ],
            'tlsCertificateSummaries': [
                {
                    'name': 'string',
                    'isAttached': True|False
                },
            ],
            'configurationOptions': {
                'string': 'string'
            }
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- loadBalancers (list) --
  
  An array of LoadBalancer objects describing your load balancers.
  - (dict) --
    
    Describes the Lightsail load balancer.
    - name (string) --
      
      The name of the load balancer (e.g., my-load-balancer ).
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the load balancer.
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The date when your load balancer was created.
    - location (dict) --
      
      The AWS Region where your load balancer was created (e.g., us-east-2a ). Lightsail automatically creates your load balancer across Availability Zones.
      - availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) --
        
        The AWS Region name.
    - resourceType (string) --
      
      The resource type (e.g., LoadBalancer .
    - dnsName (string) --
      
      The DNS name of your Lightsail load balancer.
    - state (string) --
      
      The status of your load balancer. Valid values are below.
    - protocol (string) --
      
      The protocol you have enabled for your load balancer. Valid values are below.
      
      You can't just have HTTP_HTTPS , but you can have just HTTP .
    - publicPorts (list) --
      
      An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
      - (integer) --
    - healthCheckPath (string) --
      
      The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
    - instancePort (integer) --
      
      The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.
    - instanceHealthSummary (list) --
      
      An array of InstanceHealthSummary objects describing the health of the load balancer.
      - (dict) --
        
        Describes information about the health of the instance.
        
        instanceName (string) --
        
        The name of the Lightsail instance for which you are requesting health check data.
        
        instanceHealth (string) --
        
        Describes the overall instance health. Valid values are below.
        
        instanceHealthReason (string) --
        
        More information about the instance health. If the instanceHealth is healthy , then an instanceHealthReason value is not provided.
        
        If ** instanceHealth ** is initial , the ** instanceHealthReason ** value can be one of the following:
        
        **Lb.RegistrationInProgress ** - The target instance is in the process of being registered with the load balancer.
        
        **Lb.InitialHealthChecking ** - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
        
        If ** instanceHealth ** is unhealthy , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.ResponseCodeMismatch ** - The health checks did not return an expected HTTP code.
        
        **Instance.Timeout ** - The health check requests timed out.
        
        **Instance.FailedHealthChecks ** - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
        
        **Lb.InternalError ** - The health checks failed due to an internal error.
        
        If ** instanceHealth ** is unused , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.NotRegistered ** - The target instance is not registered with the target group.
        
        **Instance.NotInUse ** - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
        
        **Instance.IpUnusable ** - The target IP address is reserved for use by a Lightsail load balancer.
        
        **Instance.InvalidState ** - The target is in the stopped or terminated state.
        
        If ** instanceHealth ** is draining , the ** instanceHealthReason ** value can be one of the following:
        
        **Instance.DeregistrationInProgress ** - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
    - tlsCertificateSummaries (list) --
      
      An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true , the certificate is attached to the load balancer.
      - (dict) --
        
        Provides a summary of SSL/TLS certificate metadata.
        
        name (string) --
        
        The name of the SSL/TLS certificate.
        
        isAttached (boolean) --
        
        When true , the SSL/TLS certificate is attached to the Lightsail load balancer.
    - configurationOptions (dict) --
      
      A string to string map of the configuration options for your load balancer. Valid values are listed below.
      - (string) --
        
        (string) --
- nextPageToken (string) --
  
  A token used for advancing to the next page of results from your GetLoadBalancers request.

GetOperation (updated)

Link ¶
Changes (response)

{'operation': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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.

GetRegions (updated)

Link ¶
Changes (response)

{'regions': {'name': ['eu-west-2']}}

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

client.get_regions(
    includeAvailabilityZones=True|False
)

type includeAvailabilityZones

boolean

param includeAvailabilityZones

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'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., Ohio ).
    - name (string) --
      
      The region name (e.g., us-east-2 ).
    - availabilityZones (list) --
      
      The Availability Zones. Follows the format us-east-2a (case-sensitive).
      - (dict) --
        
        Describes an Availability Zone.
        
        zoneName (string) --
        
        The name of the Availability Zone. The format is us-east-2a (case-sensitive).
        
        state (string) --
        
        The state of the Availability Zone.

GetStaticIp (updated)

Link ¶
Changes (response)

{'staticIp': {'location': {'regionName': ['eu-west-2']}}}

Returns information about a specific static IP.

See also: AWS API Documentation

Request Syntax

client.get_static_ip(
    staticIpName='string'
)

type staticIpName

string

param staticIpName

[REQUIRED]

The name of the static IP in Lightsail.

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        '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-Ohio-EXAMPLE ).
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).
  - supportCode (string) --
    
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) --
    
    The timestamp when the static IP was created (e.g., 1479735304.222 ).
  - location (dict) --
    
    The region and Availability Zone where the static IP was created.
    - availabilityZone (string) --
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) --
      
      The 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-Ohio-1 ).
  - isAttached (boolean) --
    
    A Boolean value indicating whether the static IP is attached.

GetStaticIps (updated)

Link ¶
Changes (response)

{'staticIps': {'location': {'regionName': ['eu-west-2']}}}

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

See also: AWS API Documentation

Request Syntax

client.get_static_ips(
    pageToken='string'
)

type pageToken

string

param pageToken

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

rtype

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-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            '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-Ohio-EXAMPLE ).
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The timestamp when the static IP was created (e.g., 1479735304.222 ).
    - location (dict) --
      
      The region and Availability Zone where the static IP was created.
      - availabilityZone (string) --
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) --
        
        The 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-Ohio-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.

ImportKeyPair (updated)

Link ¶
Changes (response)

{'operation': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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.

PutInstancePublicPorts (updated)

Link ¶
Changes (response)

{'operation': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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 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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Stops a specific Amazon Lightsail instance that is currently running.

See also: AWS API Documentation

Request Syntax

client.stop_instance(
    instanceName='string',
    force=True|False
)

type instanceName

string

param instanceName

[REQUIRED]

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

type force

boolean

param force

When set to True , forces a Lightsail instance that is stuck in a stopping state to stop.

Warning

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
               'status': ['Succeeded']}}

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'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        '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-2a (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-Ohio-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': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

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',
        'isAlias': True|False,
        '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. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.
isAlias (boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
type (string) --

The type of domain entry (e.g., SOA or NS ).
options (dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
- (string) --
  - (string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            '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-2a (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-Ohio-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.

UpdateLoadBalancerAttribute (updated)

Link ¶
Changes (response)

{'operations': {'location': {'regionName': ['eu-west-2']},
                'status': ['Succeeded']}}

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

See also: AWS API Documentation

Request Syntax

client.update_load_balancer_attribute(
    loadBalancerName='string',
    attributeName='HealthCheckPath'|'SessionStickinessEnabled'|'SessionStickiness_LB_CookieDurationSeconds',
    attributeValue='string'
)

type loadBalancerName

string

param loadBalancerName

[REQUIRED]

The name of the load balancer that you want to modify (e.g., my-load-balancer .

type attributeName

string

param attributeName

[REQUIRED]

The name of the attribute you want to update. Valid values are below.

type attributeValue

string

param attributeValue

[REQUIRED]

The value that you want to specify for the attribute name.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'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'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An object describing the 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-2a (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-Ohio-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.