AWS API Changes

2020/11/12 - Amazon Lightsail - 14 new 104 updated api methods

Changes This release adds support for Amazon Lightsail container services. You can now create a Lightsail container service, and deploy Docker images to it.

GetContainerServiceDeployments (new)

Link ¶

Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

Note

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference .

See also: AWS API Documentation

Request Syntax

client.get_container_service_deployments(
    serviceName='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to return deployments.

rtype

dict

returns

Response Syntax

{
    'deployments': [
        {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- deployments (list) --
  
  An array of objects that describe deployments for a container service.
  - (dict) --
    
    Describes a container deployment configuration of an Amazon Lightsail container service.
    
    A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.

DeleteContainerImage (new)

Link ¶

Deletes a container image that is registered to your Amazon Lightsail container service.

See also: AWS API Documentation

Request Syntax

client.delete_container_image(
    serviceName='string',
    image='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to delete a registered container image.

type image

string

param image

[REQUIRED]

The name of the container image to delete from the container service.

Use the GetContainerImages action to get the name of the container images that are registered to a container service.

Note

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetContainerServiceMetricData (new)

Link ¶

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

See also: AWS API Documentation

Request Syntax

client.get_container_service_metric_data(
    serviceName='string',
    metricName='CPUUtilization'|'MemoryUtilization',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    period=123,
    statistics=[
        'Minimum'|'Maximum'|'Sum'|'Average'|'SampleCount',
    ]
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to get metric data.

type metricName

string

param metricName

[REQUIRED]

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service. Statistics: The most useful statistics are Maximum and Average . Unit: The published unit is Percent .
MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service. Statistics: The most useful statistics are Maximum and Average . Unit: The published unit is Percent .

type startTime

datetime

param startTime

[REQUIRED]

The start time of the time period.

type endTime

datetime

param endTime

[REQUIRED]

The end time of the time period.

type period

integer

param period

[REQUIRED]

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

type statistics

list

param statistics

[REQUIRED]

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

(string) --

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- metricName (string) --
  
  The name of the metric returned.
- metricData (list) --
  
  An array of objects that describe the metric data returned.
  - (dict) --
    
    Describes the metric data point.
    - average (float) --
      
      The average.
    - maximum (float) --
      
      The maximum.
    - minimum (float) --
      
      The minimum.
    - sampleCount (float) --
      
      The sample count.
    - sum (float) --
      
      The sum.
    - timestamp (datetime) --
      
      The timestamp (e.g., 1479816991.349 ).
    - unit (string) --
      
      The unit.

DeleteContainerService (new)

Link ¶

Deletes your Amazon Lightsail container service.

See also: AWS API Documentation

Request Syntax

client.delete_container_service(
    serviceName='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetContainerAPIMetadata (new)

Link ¶

Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

See also: AWS API Documentation

Request Syntax

client.get_container_api_metadata()

rtype

dict

returns

Response Syntax

{
    'metadata': [
        {
            'string': 'string'
        },
    ]
}

Response Structure

(dict) --
- metadata (list) --
  
  Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
  - (dict) --
    - (string) --
      - (string) --

RegisterContainerImage (new)

Link ¶

Registers a container image to your Amazon Lightsail container service.

Note

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Lightsail Dev Guide .

See also: AWS API Documentation

Request Syntax

client.register_container_image(
    serviceName='string',
    label='string',
    digest='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to register a container image.

type label

string

param label

[REQUIRED]

The label for the container image when it's registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

:container-service-1.<imagelabel>.1

If the name of your container service is mycontainerservice , and the label that you specify is mystaticwebsite , then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1 .

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2 . If you push and register another container image, the version number will be 3 , and so on.

type digest

string

param digest

[REQUIRED]

The digest of the container image to be registered.

rtype

dict

returns

Response Syntax

{
    'containerImage': {
        'image': 'string',
        'digest': 'string',
        'createdAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- containerImage (dict) --
  
  Describes a container image that is registered to an Amazon Lightsail container service.
  - image (string) --
    
    The name of the container image.
  - digest (string) --
    
    The digest of the container image.
  - createdAt (datetime) --
    
    The timestamp when the container image was created.

GetContainerLog (new)

Link ¶

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Note

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference .

See also: AWS API Documentation

Request Syntax

client.get_container_log(
    serviceName='string',
    containerName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    filterPattern='string',
    pageToken='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to get a container log.

type containerName

string

param containerName

[REQUIRED]

The name of the container that is either running or previously ran on the container service for which to return a log.

type startTime

datetime

param startTime

The start of the time interval for which to get log data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

type endTime

datetime

param endTime

The end of the time interval for which to get log data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

type filterPattern

string

param filterPattern

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

To return all log events, specify a filter pattern of "" .
To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR" .
To return log events that contain the ERROR term, specify a filter pattern of "ERROR" .
To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception" .
To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception" .

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'logEvents': [
        {
            'createdAt': datetime(2015, 1, 1),
            'message': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- logEvents (list) --
  
  An array of objects that describe the log events of a container.
  - (dict) --
    
    Describes the log events of a container of an Amazon Lightsail container service.
    - createdAt (datetime) --
      
      The timestamp when the container service log event was created.
    - message (string) --
      
      The message of the container service log event.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter.

GetContainerImages (new)

Link ¶

Returns the container images that are registered to your Amazon Lightsail container service.

Note

If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

See also: AWS API Documentation

Request Syntax

client.get_container_images(
    serviceName='string'
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to return registered container images.

rtype

dict

returns

Response Syntax

{
    'containerImages': [
        {
            'image': 'string',
            'digest': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- containerImages (list) --
  
  An array of objects that describe container images that are registered to the container service.
  - (dict) --
    
    Describes a container image that is registered to an Amazon Lightsail container service.
    - image (string) --
      
      The name of the container image.
    - digest (string) --
      
      The digest of the container image.
    - createdAt (datetime) --
      
      The timestamp when the container image was created.

GetContainerServicePowers (new)

Link ¶

Returns the list of powers that can be specified for your Amazon Lightsail container services.

The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

See also: AWS API Documentation

Request Syntax

client.get_container_service_powers()

rtype

dict

returns

Response Syntax

{
    'powers': [
        {
            'powerId': 'string',
            'price': ...,
            'cpuCount': ...,
            'ramSizeInGb': ...,
            'name': 'string',
            'isActive': True|False
        },
    ]
}

Response Structure

(dict) --
- powers (list) --
  
  An array of objects that describe the powers that can be specified for a container service.
  - (dict) --
    
    Describes the powers that can be specified for an Amazon Lightsail container service.
    
    The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
    - powerId (string) --
      
      The ID of the power (e.g., nano-1 ).
    - price (float) --
      
      The monthly price of the power in USD.
    - cpuCount (float) --
      
      The number of vCPUs included in the power.
    - ramSizeInGb (float) --
      
      The amount of RAM (in GB) of the power.
    - name (string) --
      
      The friendly name of the power (e.g., nano ).
    - isActive (boolean) --
      
      A Boolean value indicating whether the power is active and can be specified for container services.

GetContainerServices (new)

Link ¶

Returns information about one or more of your Amazon Lightsail container services.

See also: AWS API Documentation

Request Syntax

client.get_container_services(
    serviceName='string'
)

type serviceName

string

param serviceName

The name of the container service for which to return information.

When omitted, the response includes all of your container services in the AWS Region where the request is made.

rtype

dict

returns

Response Syntax

{
    'containerServices': [
        {
            'containerServiceName': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'power': 'nano'|'micro'|'small'|'medium'|'large'|'xlarge',
            'powerId': 'string',
            'state': 'PENDING'|'READY'|'RUNNING'|'UPDATING'|'DELETING'|'DISABLED',
            'scale': 123,
            'currentDeployment': {
                'version': 123,
                'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
                'containers': {
                    'string': {
                        'image': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': {
                            'string': 'string'
                        },
                        'ports': {
                            'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                        }
                    }
                },
                'publicEndpoint': {
                    'containerName': 'string',
                    'containerPort': 123,
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'unhealthyThreshold': 123,
                        'timeoutSeconds': 123,
                        'intervalSeconds': 123,
                        'path': 'string',
                        'successCodes': 'string'
                    }
                },
                'createdAt': datetime(2015, 1, 1)
            },
            'nextDeployment': {
                'version': 123,
                'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
                'containers': {
                    'string': {
                        'image': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': {
                            'string': 'string'
                        },
                        'ports': {
                            'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                        }
                    }
                },
                'publicEndpoint': {
                    'containerName': 'string',
                    'containerPort': 123,
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'unhealthyThreshold': 123,
                        'timeoutSeconds': 123,
                        'intervalSeconds': 123,
                        'path': 'string',
                        'successCodes': 'string'
                    }
                },
                'createdAt': datetime(2015, 1, 1)
            },
            'isDisabled': True|False,
            'principalArn': 'string',
            'privateDomainName': 'string',
            'publicDomainNames': {
                'string': [
                    'string',
                ]
            },
            'url': 'string'
        },
    ]
}

Response Structure

(dict) --
- containerServices (list) --
  
  An array of objects that describe one or more container services.
  - (dict) --
    
    Describes an Amazon Lightsail container service.
    - containerServiceName (string) --
      
      The name of the container service.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the container service.
    - createdAt (datetime) --
      
      The timestamp when the container service was created.
    - location (dict) --
      
      An object that describes the location of the container service, such as the AWS Region and Availability Zone.
      - 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 of the container service (i.e., ContainerService ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - power (string) --
      
      The power specification of the container service.
      
      The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
    - powerId (string) --
      
      The ID of the power of the container service.
    - state (string) --
      
      The current state of the container service.
      
      The state can be:
      - Pending - The container service is being created.
      - Ready - The container service is created but does not have a container deployment.
      - Disabled - The container service is disabled.
      - Updating - The container service capacity or other setting is being updated.
      - Deploying - The container service is launching a container deployment.
      - Running - The container service is created and it has a container deployment.
    - scale (integer) --
      
      The scale specification of the container service.
      
      The scale specifies the allocated compute nodes of the container service.
    - currentDeployment (dict) --
      
      An object that describes the current container deployment of the container service.
      - version (integer) --
        
        The version number of the deployment.
      - state (string) --
        
        The state of the deployment.
        
        A deployment can be in one of the following states:
        
        Activating - The deployment is being created.
        
        Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
        
        Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
        
        Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
      - containers (dict) --
        
        An object that describes the configuration for the containers of the deployment.
        
        (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
      - publicEndpoint (dict) --
        
        An object that describes the endpoint of the deployment.
        
        containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
        
        containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
        
        healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
      - createdAt (datetime) --
        
        The timestamp when the deployment was created.
    - nextDeployment (dict) --
      
      An object that describes the next deployment of the container service.
      
      This value is null when there is no deployment in a pending state.
      - version (integer) --
        
        The version number of the deployment.
      - state (string) --
        
        The state of the deployment.
        
        A deployment can be in one of the following states:
        
        Activating - The deployment is being created.
        
        Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
        
        Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
        
        Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
      - containers (dict) --
        
        An object that describes the configuration for the containers of the deployment.
        
        (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
      - publicEndpoint (dict) --
        
        An object that describes the endpoint of the deployment.
        
        containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
        
        containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
        
        healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
      - createdAt (datetime) --
        
        The timestamp when the deployment was created.
    - isDisabled (boolean) --
      
      A Boolean value indicating whether the container service is disabled.
    - principalArn (string) --
      
      The principal ARN of the container service.
      
      The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
    - privateDomainName (string) --
      
      The private domain name of the container service.
      
      The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
    - publicDomainNames (dict) --
      
      The public domain name of the container service, such as example.com and www.example.com .
      
      You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
      
      If you don't specify public domain names, then you can use the default domain of the container service.
      
      Warning
      
      You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.
      
      See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.
      - (string) --
        
        (list) --
        
        (string) --
    - url (string) --
      
      The publicly accessible URL of the container service.
      
      If no public endpoint is specified in the currentDeployment , this URL returns a 404 response.

CreateContainerServiceDeployment (new)

Link ¶

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Lightsail Dev Guide .

See also: AWS API Documentation

Request Syntax

client.create_container_service_deployment(
    serviceName='string',
    containers={
        'string': {
            'image': 'string',
            'command': [
                'string',
            ],
            'environment': {
                'string': 'string'
            },
            'ports': {
                'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
            }
        }
    },
    publicEndpoint={
        'containerName': 'string',
        'containerPort': 123,
        'healthCheck': {
            'healthyThreshold': 123,
            'unhealthyThreshold': 123,
            'timeoutSeconds': 123,
            'intervalSeconds': 123,
            'path': 'string',
            'successCodes': 'string'
        }
    }
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service for which to create the deployment.

type containers

dict

param containers

An object that describes the settings of the containers that will be launched on the container service.

(string) --
- (dict) --
  
  Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
  - image (string) --
    
    The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
  - command (list) --
    
    The launch command for the container.
    - (string) --
  - environment (dict) --
    
    The environment variables of the container.
    - (string) --
      - (string) --
  - ports (dict) --
    
    The open firewall ports of the container.
    - (string) --
      - (string) --

type publicEndpoint

dict

param publicEndpoint

An object that describes the settings of the public endpoint for the container service.

containerName (string) -- [REQUIRED]

The name of the container for the endpoint.
containerPort (integer) -- [REQUIRED]

The port of the container to which traffic is forwarded to.
healthCheck (dict) --

An object that describes the health check configuration of the container.
- healthyThreshold (integer) --
  
  The number of consecutive health checks successes required before moving the container to the Healthy state.
- unhealthyThreshold (integer) --
  
  The number of consecutive health check failures required before moving the container to the Unhealthy state.
- timeoutSeconds (integer) --
  
  The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
- intervalSeconds (integer) --
  
  The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
- path (string) --
  
  The path on the container on which to perform the health check.
- successCodes (string) --
  
  The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.

rtype

dict

returns

Response Syntax

{
    'containerService': {
        'containerServiceName': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'power': 'nano'|'micro'|'small'|'medium'|'large'|'xlarge',
        'powerId': 'string',
        'state': 'PENDING'|'READY'|'RUNNING'|'UPDATING'|'DELETING'|'DISABLED',
        'scale': 123,
        'currentDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'nextDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'isDisabled': True|False,
        'principalArn': 'string',
        'privateDomainName': 'string',
        'publicDomainNames': {
            'string': [
                'string',
            ]
        },
        'url': 'string'
    }
}

Response Structure

(dict) --
- containerService (dict) --
  
  An object that describes a container service.
  - containerServiceName (string) --
    
    The name of the container service.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the container service.
  - createdAt (datetime) --
    
    The timestamp when the container service was created.
  - location (dict) --
    
    An object that describes the location of the container service, such as the AWS Region and Availability Zone.
    - 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 of the container service (i.e., ContainerService ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - power (string) --
    
    The power specification of the container service.
    
    The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
  - powerId (string) --
    
    The ID of the power of the container service.
  - state (string) --
    
    The current state of the container service.
    
    The state can be:
    - Pending - The container service is being created.
    - Ready - The container service is created but does not have a container deployment.
    - Disabled - The container service is disabled.
    - Updating - The container service capacity or other setting is being updated.
    - Deploying - The container service is launching a container deployment.
    - Running - The container service is created and it has a container deployment.
  - scale (integer) --
    
    The scale specification of the container service.
    
    The scale specifies the allocated compute nodes of the container service.
  - currentDeployment (dict) --
    
    An object that describes the current container deployment of the container service.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - nextDeployment (dict) --
    
    An object that describes the next deployment of the container service.
    
    This value is null when there is no deployment in a pending state.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - isDisabled (boolean) --
    
    A Boolean value indicating whether the container service is disabled.
  - principalArn (string) --
    
    The principal ARN of the container service.
    
    The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
  - privateDomainName (string) --
    
    The private domain name of the container service.
    
    The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
  - publicDomainNames (dict) --
    
    The public domain name of the container service, such as example.com and www.example.com .
    
    You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
    
    If you don't specify public domain names, then you can use the default domain of the container service.
    
    Warning
    
    You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.
    
    See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.
    - (string) --
      - (list) --
        
        (string) --
  - url (string) --
    
    The publicly accessible URL of the container service.
    
    If no public endpoint is specified in the currentDeployment , this URL returns a 404 response.

UpdateContainerService (new)

Link ¶

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

See also: AWS API Documentation

Request Syntax

client.update_container_service(
    serviceName='string',
    power='nano'|'micro'|'small'|'medium'|'large'|'xlarge',
    scale=123,
    isDisabled=True|False,
    publicDomainNames={
        'string': [
            'string',
        ]
    }
)

type serviceName

string

param serviceName

[REQUIRED]

The name of the container service to update.

type power

string

param power

The power for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to view the specifications of each power option.

type scale

integer

param scale

The scale for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

type isDisabled

boolean

param isDisabled

A Boolean value to indicate whether the container service is disabled.

type publicDomainNames

dict

param publicDomainNames

The public domain names to use with the container service, such as example.com and www.example.com .

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don't specify public domain names, then you can use the default domain of the container service.

Warning

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

(string) --
- (list) --
  - (string) --

rtype

dict

returns

Response Syntax

{
    'containerService': {
        'containerServiceName': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'power': 'nano'|'micro'|'small'|'medium'|'large'|'xlarge',
        'powerId': 'string',
        'state': 'PENDING'|'READY'|'RUNNING'|'UPDATING'|'DELETING'|'DISABLED',
        'scale': 123,
        'currentDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'nextDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'isDisabled': True|False,
        'principalArn': 'string',
        'privateDomainName': 'string',
        'publicDomainNames': {
            'string': [
                'string',
            ]
        },
        'url': 'string'
    }
}

Response Structure

(dict) --
- containerService (dict) --
  
  An object that describes a container service.
  - containerServiceName (string) --
    
    The name of the container service.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the container service.
  - createdAt (datetime) --
    
    The timestamp when the container service was created.
  - location (dict) --
    
    An object that describes the location of the container service, such as the AWS Region and Availability Zone.
    - 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 of the container service (i.e., ContainerService ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - power (string) --
    
    The power specification of the container service.
    
    The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
  - powerId (string) --
    
    The ID of the power of the container service.
  - state (string) --
    
    The current state of the container service.
    
    The state can be:
    - Pending - The container service is being created.
    - Ready - The container service is created but does not have a container deployment.
    - Disabled - The container service is disabled.
    - Updating - The container service capacity or other setting is being updated.
    - Deploying - The container service is launching a container deployment.
    - Running - The container service is created and it has a container deployment.
  - scale (integer) --
    
    The scale specification of the container service.
    
    The scale specifies the allocated compute nodes of the container service.
  - currentDeployment (dict) --
    
    An object that describes the current container deployment of the container service.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - nextDeployment (dict) --
    
    An object that describes the next deployment of the container service.
    
    This value is null when there is no deployment in a pending state.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - isDisabled (boolean) --
    
    A Boolean value indicating whether the container service is disabled.
  - principalArn (string) --
    
    The principal ARN of the container service.
    
    The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
  - privateDomainName (string) --
    
    The private domain name of the container service.
    
    The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
  - publicDomainNames (dict) --
    
    The public domain name of the container service, such as example.com and www.example.com .
    
    You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
    
    If you don't specify public domain names, then you can use the default domain of the container service.
    
    Warning
    
    You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.
    
    See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.
    - (string) --
      - (list) --
        
        (string) --
  - url (string) --
    
    The publicly accessible URL of the container service.
    
    If no public endpoint is specified in the currentDeployment , this URL returns a 404 response.

CreateContainerServiceRegistryLogin (new)

Link ¶

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

Note

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images perform any other container image management actions on the container service registry of your Lightsail account.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

Note

See also: AWS API Documentation

Request Syntax

client.create_container_service_registry_login()

rtype

dict

returns

Response Syntax

{
    'registryLogin': {
        'username': 'string',
        'password': 'string',
        'expiresAt': datetime(2015, 1, 1),
        'registry': 'string'
    }
}

Response Structure

(dict) --
- registryLogin (dict) --
  
  An object that describes the log in information for the container service registry of your Lightsail account.
  - username (string) --
    
    The container service registry username to use to push container images to the container image registry of a Lightsail account.
  - password (string) --
    
    The container service registry password to use to push container images to the container image registry of a Lightsail account
  - expiresAt (datetime) --
    
    The timestamp of when the container image registry username and password expire.
    
    The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials using the CreateContainerServiceRegistryLogin action.
  - registry (string) --
    
    The address to use to push container images to the container image registry of a Lightsail account.

CreateContainerService (new)

Link ¶

Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide .

See also: AWS API Documentation

Request Syntax

client.create_container_service(
    serviceName='string',
    power='nano'|'micro'|'small'|'medium'|'large'|'xlarge',
    scale=123,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    publicDomainNames={
        'string': [
            'string',
        ]
    },
    deployment={
        'containers': {
            'string': {
                'image': 'string',
                'command': [
                    'string',
                ],
                'environment': {
                    'string': 'string'
                },
                'ports': {
                    'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                }
            }
        },
        'publicEndpoint': {
            'containerName': 'string',
            'containerPort': 123,
            'healthCheck': {
                'healthyThreshold': 123,
                'unhealthyThreshold': 123,
                'timeoutSeconds': 123,
                'intervalSeconds': 123,
                'path': 'string',
                'successCodes': 'string'
            }
        }
    }
)

type serviceName

string

param serviceName

[REQUIRED]

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com . If the name of your container service is container-service-1 , and it's located in the US East (Ohio) AWS region ( us-east-2 ), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

Must be unique within each AWS Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.

type power

string

param power

[REQUIRED]

The power specification for the container service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

type scale

integer

param scale

[REQUIRED]

The scale specification for the container service.

type tags

list

param tags

The tag keys and optional values for the container service.

For more information about tags in Lightsail, see the Lightsail Dev Guide.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

type publicDomainNames

dict

param publicDomainNames

The public domain names to use with the container service, such as example.com and www.example.com .

If you don't specify public domain names, then you can use the default domain of the container service.

Warning

You can specify public domain names using a string to array map as shown in the example later on this page.

(string) --
- (list) --
  - (string) --

type deployment

dict

param deployment

An object that describes a deployment for the container service.

containers (dict) --

An object that describes the configuration for the containers of the deployment.
- (string) --
  - (dict) --
    
    Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
    - image (string) --
      
      The name of the image used for the container.
      
      Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
    - command (list) --
      
      The launch command for the container.
      - (string) --
    - environment (dict) --
      
      The environment variables of the container.
      - (string) --
        
        (string) --
    - ports (dict) --
      
      The open firewall ports of the container.
      - (string) --
        
        (string) --
publicEndpoint (dict) --

An object that describes the endpoint of the deployment.
- containerName (string) -- [REQUIRED]
  
  The name of the container for the endpoint.
- containerPort (integer) -- [REQUIRED]
  
  The port of the container to which traffic is forwarded to.
- healthCheck (dict) --
  
  An object that describes the health check configuration of the container.
  - healthyThreshold (integer) --
    
    The number of consecutive health checks successes required before moving the container to the Healthy state.
  - unhealthyThreshold (integer) --
    
    The number of consecutive health check failures required before moving the container to the Unhealthy state.
  - timeoutSeconds (integer) --
    
    The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
  - intervalSeconds (integer) --
    
    The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
  - path (string) --
    
    The path on the container on which to perform the health check.
  - successCodes (string) --
    
    The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.

rtype

dict

returns

Response Syntax

{
    'containerService': {
        'containerServiceName': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'power': 'nano'|'micro'|'small'|'medium'|'large'|'xlarge',
        'powerId': 'string',
        'state': 'PENDING'|'READY'|'RUNNING'|'UPDATING'|'DELETING'|'DISABLED',
        'scale': 123,
        'currentDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'nextDeployment': {
            'version': 123,
            'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
            'containers': {
                'string': {
                    'image': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': {
                        'string': 'string'
                    },
                    'ports': {
                        'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                    }
                }
            },
            'publicEndpoint': {
                'containerName': 'string',
                'containerPort': 123,
                'healthCheck': {
                    'healthyThreshold': 123,
                    'unhealthyThreshold': 123,
                    'timeoutSeconds': 123,
                    'intervalSeconds': 123,
                    'path': 'string',
                    'successCodes': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1)
        },
        'isDisabled': True|False,
        'principalArn': 'string',
        'privateDomainName': 'string',
        'publicDomainNames': {
            'string': [
                'string',
            ]
        },
        'url': 'string'
    }
}

Response Structure

(dict) --
- containerService (dict) --
  
  An object that describes a container service.
  - containerServiceName (string) --
    
    The name of the container service.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the container service.
  - createdAt (datetime) --
    
    The timestamp when the container service was created.
  - location (dict) --
    
    An object that describes the location of the container service, such as the AWS Region and Availability Zone.
    - 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 of the container service (i.e., ContainerService ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - power (string) --
    
    The power specification of the container service.
    
    The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.
  - powerId (string) --
    
    The ID of the power of the container service.
  - state (string) --
    
    The current state of the container service.
    
    The state can be:
    - Pending - The container service is being created.
    - Ready - The container service is created but does not have a container deployment.
    - Disabled - The container service is disabled.
    - Updating - The container service capacity or other setting is being updated.
    - Deploying - The container service is launching a container deployment.
    - Running - The container service is created and it has a container deployment.
  - scale (integer) --
    
    The scale specification of the container service.
    
    The scale specifies the allocated compute nodes of the container service.
  - currentDeployment (dict) --
    
    An object that describes the current container deployment of the container service.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - nextDeployment (dict) --
    
    An object that describes the next deployment of the container service.
    
    This value is null when there is no deployment in a pending state.
    - version (integer) --
      
      The version number of the deployment.
    - state (string) --
      
      The state of the deployment.
      
      A deployment can be in one of the following states:
      - Activating - The deployment is being created.
      - Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
      - Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
      - Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
    - containers (dict) --
      
      An object that describes the configuration for the containers of the deployment.
      - (string) --
        
        (dict) --
        
        Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.
        
        image (string) --
        
        The name of the image used for the container.
        
        Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx .
        
        command (list) --
        
        The launch command for the container.
        
        (string) --
        
        environment (dict) --
        
        The environment variables of the container.
        
        (string) --
        
        (string) --
        
        ports (dict) --
        
        The open firewall ports of the container.
        
        (string) --
        
        (string) --
    - publicEndpoint (dict) --
      
      An object that describes the endpoint of the deployment.
      - containerName (string) --
        
        The name of the container entry of the deployment that the endpoint configuration applies to.
      - containerPort (integer) --
        
        The port of the specified container to which traffic is forwarded to.
      - healthCheck (dict) --
        
        An object that describes the health check configuration of the container.
        
        healthyThreshold (integer) --
        
        The number of consecutive health checks successes required before moving the container to the Healthy state.
        
        unhealthyThreshold (integer) --
        
        The number of consecutive health check failures required before moving the container to the Unhealthy state.
        
        timeoutSeconds (integer) --
        
        The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.
        
        intervalSeconds (integer) --
        
        The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.
        
        path (string) --
        
        The path on the container on which to perform the health check.
        
        successCodes (string) --
        
        The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499.
    - createdAt (datetime) --
      
      The timestamp when the deployment was created.
  - isDisabled (boolean) --
    
    A Boolean value indicating whether the container service is disabled.
  - principalArn (string) --
    
    The principal ARN of the container service.
    
    The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
  - privateDomainName (string) --
    
    The private domain name of the container service.
    
    The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
  - publicDomainNames (dict) --
    
    The public domain name of the container service, such as example.com and www.example.com .
    
    You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
    
    If you don't specify public domain names, then you can use the default domain of the container service.
    
    Warning
    
    You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.
    
    See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.
    - (string) --
      - (list) --
        
        (string) --
  - url (string) --
    
    The publicly accessible URL of the container service.
    
    If no public endpoint is specified in the currentDeployment , this URL returns a 404 response.

AllocateStaticIp (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

AttachCertificateToDistribution (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Warning

Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

See also: AWS API Documentation

Request Syntax

client.attach_certificate_to_distribution(
    distributionName='string',
    certificateName='string'
)

type distributionName

string

param distributionName

[REQUIRED]

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

type certificateName

string

param certificateName

[REQUIRED]

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

Note

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com .

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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 action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  
  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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Closes ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

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

type portInfo

dict

param portInfo

[REQUIRED]

An object to describe the ports to close for the specified instance.

fromPort (integer) --

The first port in a range of open ports on an instance.

Allowed ports:
- TCP and UDP - 0 to 65535
- ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
toPort (integer) --

The last port in a range of open ports on an instance.

Allowed ports:
- TCP and UDP - 0 to 65535
- ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
protocol (string) --

The IP protocol name.

The name 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.
- icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
cidrs (list) --

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:
- To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
- To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
- (string) --
cidrListAliases (list) --

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
- (string) --

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance for which to close ports.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the 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 AWS 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.

CopySnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.

When copying a manual snapshot , be sure to define the source region , source snapshot name , and target snapshot name parameters.

When copying an automatic snapshot , be sure to define the source region , source resource name , target snapshot name , and either the restore date or the use latest restorable auto snapshot parameters.

See also: AWS API Documentation

Request Syntax

client.copy_snapshot(
    sourceSnapshotName='string',
    sourceResourceName='string',
    restoreDate='string',
    useLatestRestorableAutoSnapshot=True|False,
    targetSnapshotName='string',
    sourceRegion='us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
)

type sourceSnapshotName

string

param sourceSnapshotName

The name of the source manual snapshot to copy.

Constraint:

Define this parameter only when copying a manual snapshot as another manual snapshot.

type sourceResourceName

string

param sourceResourceName

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

type restoreDate

string

param restoreDate

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

type useLatestRestorableAutoSnapshot

boolean

param useLatestRestorableAutoSnapshot

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

type targetSnapshotName

string

param targetSnapshotName

[REQUIRED]

The name of the new manual snapshot to be created as a copy.

type sourceRegion

string

param sourceRegion

[REQUIRED]

The AWS Region where the source manual or automatic snapshot is located.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateCertificate (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is created, use the AttachCertificateToDistribution action to attach the certificate to your distribution.

Warning

See also: AWS API Documentation

Request Syntax

client.create_certificate(
    certificateName='string',
    domainName='string',
    subjectAlternativeNames=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type certificateName

string

param certificateName

[REQUIRED]

The name for the certificate.

type domainName

string

param domainName

[REQUIRED]

The domain name (e.g., example.com ) for the certificate.

type subjectAlternativeNames

list

param subjectAlternativeNames

An array of strings that specify the alternate domains (e.g., example2.com ) and subdomains (e.g., blog.example.com ) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com ) are not supported.

(string) --

type tags

list

param tags

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'certificate': {
        'certificateArn': 'string',
        'certificateName': 'string',
        'domainName': 'string',
        'certificateDetail': {
            'arn': 'string',
            'name': 'string',
            'domainName': 'string',
            'status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
            'serialNumber': 'string',
            'subjectAlternativeNames': [
                'string',
            ],
            'domainValidationRecords': [
                {
                    'domainName': 'string',
                    'resourceRecord': {
                        'name': 'string',
                        'type': 'string',
                        'value': 'string'
                    }
                },
            ],
            'requestFailureReason': 'string',
            'inUseResourceCount': 123,
            'keyAlgorithm': 'string',
            'createdAt': datetime(2015, 1, 1),
            'issuedAt': datetime(2015, 1, 1),
            'issuerCA': 'string',
            'notBefore': datetime(2015, 1, 1),
            'notAfter': datetime(2015, 1, 1),
            'eligibleToRenew': 'string',
            'renewalSummary': {
                'domainValidationRecords': [
                    {
                        'domainName': 'string',
                        'resourceRecord': {
                            'name': 'string',
                            'type': 'string',
                            'value': 'string'
                        }
                    },
                ],
                'renewalStatus': 'PendingAutoRenewal'|'PendingValidation'|'Success'|'Failed',
                'renewalStatusReason': 'string',
                'updatedAt': datetime(2015, 1, 1)
            },
            'revokedAt': datetime(2015, 1, 1),
            'revocationReason': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'supportCode': 'string'
        },
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- certificate (dict) --
  
  An object that describes the certificate created.
  - certificateArn (string) --
    
    The Amazon Resource Name (ARN) of the certificate.
  - certificateName (string) --
    
    The name of the certificate.
  - domainName (string) --
    
    The domain name of the certificate.
  - certificateDetail (dict) --
    
    An object that describes a certificate in detail.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the certificate.
    - name (string) --
      
      The name of the certificate (e.g., my-certificate ).
    - domainName (string) --
      
      The domain name of the certificate.
    - status (string) --
      
      The validation status of the certificate.
    - serialNumber (string) --
      
      The serial number of the certificate.
    - subjectAlternativeNames (list) --
      
      An array of strings that specify the alternate domains (e.g., example2.com ) and subdomains (e.g., blog.example.com ) of the certificate.
      - (string) --
    - domainValidationRecords (list) --
      
      An array of objects that describe the domain validation records of the certificate.
      - (dict) --
        
        Describes the domain validation records of an Amazon Lightsail SSL/TLS certificate.
        
        domainName (string) --
        
        The domain name of the certificate validation record. For example, example.com or www.example.com .
        
        resourceRecord (dict) --
        
        An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
        
        name (string) --
        
        The name of the record.
        
        type (string) --
        
        The DNS record type.
        
        value (string) --
        
        The value for the DNS record.
    - requestFailureReason (string) --
      
      The validation failure reason, if any, of the certificate.
      
      The following failure reasons are possible:
      - NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.
      - ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
      Note
      
      You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
      - DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
      - INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
      - OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
    - inUseResourceCount (integer) --
      
      The number of Lightsail resources that the certificate is attached to.
    - keyAlgorithm (string) --
      
      The algorithm used to generate the key pair (the public and private key) of the certificate.
    - createdAt (datetime) --
      
      The timestamp when the certificate was created.
    - issuedAt (datetime) --
      
      The timestamp when the certificate was issued.
    - issuerCA (string) --
      
      The certificate authority that issued the certificate.
    - notBefore (datetime) --
      
      The timestamp when the certificate is first valid.
    - notAfter (datetime) --
      
      The timestamp when the certificate expires.
    - eligibleToRenew (string) --
      
      The renewal eligibility of the certificate.
    - renewalSummary (dict) --
      
      An object that describes the status of the certificate renewal managed by Lightsail.
      - domainValidationRecords (list) --
        
        An array of objects that describe the domain validation records of the certificate.
        
        (dict) --
        
        Describes the domain validation records of an Amazon Lightsail SSL/TLS certificate.
        
        domainName (string) --
        
        The domain name of the certificate validation record. For example, example.com or www.example.com .
        
        resourceRecord (dict) --
        
        An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
        
        name (string) --
        
        The name of the record.
        
        type (string) --
        
        The DNS record type.
        
        value (string) --
        
        The value for the DNS record.
      - renewalStatus (string) --
        
        The renewal status of the certificate.
        
        The following renewal status are possible:
        
        PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
        
        PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
        
        Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
        
        Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.
      - renewalStatusReason (string) --
        
        The reason for the renewal status of the certificate.
      - updatedAt (datetime) --
        
        The timestamp when the certificate was last updated.
    - revokedAt (datetime) --
      
      The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED .
    - revocationReason (string) --
      
      The reason the certificate was revoked. This value is present only when the certificate status is REVOKED .
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateCloudFormationStack (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

Warning

Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

See also: AWS API Documentation

Request Syntax

client.create_cloud_formation_stack(
    instances=[
        {
            'sourceName': 'string',
            'instanceType': 'string',
            'portInfoSource': 'DEFAULT'|'INSTANCE'|'NONE'|'CLOSED',
            'userData': 'string',
            'availabilityZone': 'string'
        },
    ]
)

type instances

list

param instances

[REQUIRED]

An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

(dict) --

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.
- sourceName (string) -- [REQUIRED]
  
  The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.
  
  Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.
- instanceType (string) -- [REQUIRED]
  
  The instance type (e.g., t2.micro ) to use for the new Amazon EC2 instance.
- portInfoSource (string) -- [REQUIRED]
  
  The port configuration to use for the new Amazon EC2 instance.
  
  The following configuration options are available:
  - DEFAULT - Use the default firewall settings from the Lightsail instance blueprint.
  - INSTANCE - Use the configured firewall settings from the source Lightsail instance.
  - NONE - Use the default Amazon EC2 security group.
  - CLOSED - All ports closed.
  Note
  
  If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.
- userData (string) --
  
  A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update .
  
  Note
  
  Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg .
- availabilityZone (string) -- [REQUIRED]
  
  The Availability Zone for the new Amazon EC2 instance.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateContactMethod (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.create_contact_method(
    protocol='Email'|'SMS',
    contactEndpoint='string'
)

type protocol

string

param protocol

[REQUIRED]

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following AWS Regions.

US East (N. Virginia) ( us-east-1 )
US West (Oregon) ( us-west-2 )
Europe (Ireland) ( eu-west-1 )
Asia Pacific (Tokyo) ( ap-northeast-1 )
Asia Pacific (Singapore) ( ap-southeast-1 )
Asia Pacific (Sydney) ( ap-southeast-2 )

For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide .

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

type contactEndpoint

string

param contactEndpoint

[REQUIRED]

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia .

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a ).

The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_disk(
    diskName='string',
    availabilityZone='string',
    sizeInGb=123,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    addOns=[
        {
            'addOnType': 'AutoSnapshot',
            'autoSnapshotAddOnRequest': {
                'snapshotTimeOfDay': 'string'
            }
        },
    ]
)

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 ). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions 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 ).

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

type addOns

list

param addOns

An array of objects that represent the add-ons to enable for the new disk.

(dict) --

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

Note

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
- addOnType (string) -- [REQUIRED]
  
  The add-on type.
- autoSnapshotAddOnRequest (dict) --
  
  An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
  - snapshotTimeOfDay (string) --
    
    The daily time when an automatic snapshot will be created.
    
    Constraints:
    - Must be in HH:00 format, and in an hourly increment.
    - Specified in Coordinated Universal Time (UTC).
    - The snapshot will be automatically created between the time specified and up to 45 minutes after.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a ).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_disk_from_snapshot(
    diskName='string',
    diskSnapshotName='string',
    availabilityZone='string',
    sizeInGb=123,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    addOns=[
        {
            'addOnType': 'AutoSnapshot',
            'autoSnapshotAddOnRequest': {
                'snapshotTimeOfDay': 'string'
            }
        },
    ],
    sourceDiskName='string',
    restoreDate='string',
    useLatestRestorableAutoSnapshot=True|False
)

type diskName

string

param diskName

[REQUIRED]

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

type diskSnapshotName

string

param diskSnapshotName

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

Constraint:

This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

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

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

type addOns

list

param addOns

An array of objects that represent the add-ons to enable for the new disk.

(dict) --

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

Note

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
- addOnType (string) -- [REQUIRED]
  
  The add-on type.
- autoSnapshotAddOnRequest (dict) --
  
  An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
  - snapshotTimeOfDay (string) --
    
    The daily time when an automatic snapshot will be created.
    
    Constraints:
    - Must be in HH:00 format, and in an hourly increment.
    - Specified in Coordinated Universal Time (UTC).
    - The snapshot will be automatically created between the time specified and up to 45 minutes after.

type sourceDiskName

string

param sourceDiskName

The name of the source disk from which the source automatic snapshot was created.

Constraints:

This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

type restoreDate

string

param restoreDate

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

type useLatestRestorableAutoSnapshot

boolean

param useLatestRestorableAutoSnapshot

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_disk_snapshot(
    diskName='string',
    diskSnapshotName='string',
    instanceName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type diskName

string

param diskName

The unique name of the source disk (e.g., Disk-Virginia-1 ).

Note

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

type diskSnapshotName

string

param diskSnapshotName

[REQUIRED]

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

type instanceName

string

param instanceName

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1 ). When this is defined, a snapshot of the instance's system volume is created.

Note

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateDistribution (updated)

Link ¶
Changes (response)

{'distribution': {'origin': {'resourceType': {'ContainerService'}},
                  'resourceType': {'ContainerService'}},
 'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.create_distribution(
    distributionName='string',
    origin={
        'name': 'string',
        'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2',
        'protocolPolicy': 'http-only'|'https-only'
    },
    defaultCacheBehavior={
        'behavior': 'dont-cache'|'cache'
    },
    cacheBehaviorSettings={
        'defaultTTL': 123,
        'minimumTTL': 123,
        'maximumTTL': 123,
        'allowedHTTPMethods': 'string',
        'cachedHTTPMethods': 'string',
        'forwardedCookies': {
            'option': 'none'|'allow-list'|'all',
            'cookiesAllowList': [
                'string',
            ]
        },
        'forwardedHeaders': {
            'option': 'none'|'allow-list'|'all',
            'headersAllowList': [
                'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
            ]
        },
        'forwardedQueryStrings': {
            'option': True|False,
            'queryStringsAllowList': [
                'string',
            ]
        }
    },
    cacheBehaviors=[
        {
            'path': 'string',
            'behavior': 'dont-cache'|'cache'
        },
    ],
    bundleId='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type distributionName

string

param distributionName

[REQUIRED]

The name for the distribution.

type origin

dict

param origin

[REQUIRED]

An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.

The distribution pulls, caches, and serves content from the origin.

name (string) --

The name of the origin resource.
regionName (string) --

The AWS Region name of the origin resource.
protocolPolicy (string) --

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

type defaultCacheBehavior

dict

param defaultCacheBehavior

[REQUIRED]

An object that describes the default cache behavior for the distribution.

behavior (string) --

The cache behavior of the distribution.

The following cache behaviors can be specified:
- cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
- dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

type cacheBehaviorSettings

dict

param cacheBehaviorSettings

An object that describes the cache behavior settings for the distribution.

defaultTTL (integer) --

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

Note

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
minimumTTL (integer) --

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
allowedHTTPMethods (string) --

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:
- GET,HEAD - The distribution forwards the GET and HEAD methods.
- GET,HEAD,OPTIONS - The distribution forwards the GET , HEAD , and OPTIONS methods.
- GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET , HEAD , OPTIONS , PUT , PATCH , POST , and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --

The HTTP method responses that are cached by your distribution.

You can specify the following options:
- GET,HEAD - The distribution caches responses to the GET and HEAD methods.
- GET,HEAD,OPTIONS - The distribution caches responses to the GET , HEAD , and OPTIONS methods.
forwardedCookies (dict) --

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
- option (string) --
  
  Specifies which cookies to forward to the distribution's origin for a cache behavior: all , none , or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
- cookiesAllowList (list) --
  
  The specific cookies to forward to your distribution's origin.
  - (string) --
forwardedHeaders (dict) --

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
- option (string) --
  
  The headers that you want your distribution to forward to your origin and base caching on.
  
  You can configure your distribution to do one of the following:
  - all - Forward all headers to your origin.
  - none - Forward only the default headers.
  - allow-list - Forward only the headers you specify using the headersAllowList parameter.
- headersAllowList (list) --
  
  The specific headers to forward to your distribution's origin.
  - (string) --
forwardedQueryStrings (dict) --

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
- option (boolean) --
  
  Indicates whether the distribution forwards and caches based on query strings.
- queryStringsAllowList (list) --
  
  The specific query strings that the distribution forwards to the origin.
  
  Your distribution will cache content based on the specified query strings.
  
  If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
  - (string) --

type cacheBehaviors

list

param cacheBehaviors

An array of objects that describe the per-path cache behavior for the distribution.

(dict) --

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

if the cacheBehavior's behavior is set to 'cache', then
- path (string) --
  
  The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/* ), and file types ( *.html, *jpg, *js ). Directories and file paths are case-sensitive.
  
  Examples:
  - Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
  - Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
  - Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
  - Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
- behavior (string) --
  
  The cache behavior for the specified path.
  
  You can specify one of the following per-path cache behaviors:
  - cache - This behavior caches the specified path.
  - dont-cache - This behavior doesn't cache the specified path.

type bundleId

string

param bundleId

[REQUIRED]

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

type tags

list

param tags

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'distribution': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'alternativeDomainNames': [
            'string',
        ],
        'status': 'string',
        'isEnabled': True|False,
        'domainName': 'string',
        'bundleId': 'string',
        'certificateName': 'string',
        'origin': {
            'name': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2',
            'protocolPolicy': 'http-only'|'https-only'
        },
        'originPublicDNS': 'string',
        'defaultCacheBehavior': {
            'behavior': 'dont-cache'|'cache'
        },
        'cacheBehaviorSettings': {
            'defaultTTL': 123,
            'minimumTTL': 123,
            'maximumTTL': 123,
            'allowedHTTPMethods': 'string',
            'cachedHTTPMethods': 'string',
            'forwardedCookies': {
                'option': 'none'|'allow-list'|'all',
                'cookiesAllowList': [
                    'string',
                ]
            },
            'forwardedHeaders': {
                'option': 'none'|'allow-list'|'all',
                'headersAllowList': [
                    'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
                ]
            },
            'forwardedQueryStrings': {
                'option': True|False,
                'queryStringsAllowList': [
                    'string',
                ]
            }
        },
        'cacheBehaviors': [
            {
                'path': 'string',
                'behavior': 'dont-cache'|'cache'
            },
        ],
        'ableToUpdateBundle': True|False,
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- distribution (dict) --
  
  An object that describes the distribution created.
  - name (string) --
    
    The name of the distribution.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the distribution.
  - supportCode (string) --
    
    The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) --
    
    The timestamp when the distribution was created.
  - location (dict) --
    
    An object that describes the location of the distribution, such as the AWS Region and Availability Zone.
    
    Note
    
    Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
    - 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., Distribution ).
  - alternativeDomainNames (list) --
    
    The alternate domain names of the distribution.
    - (string) --
  - status (string) --
    
    The status of the distribution.
  - isEnabled (boolean) --
    
    Indicates whether the distribution is enabled.
  - domainName (string) --
    
    The domain name of the distribution.
  - bundleId (string) --
    
    The ID of the bundle currently applied to the distribution.
  - certificateName (string) --
    
    The name of the SSL/TLS certificate attached to the distribution, if any.
  - origin (dict) --
    
    An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer.
    
    The distribution pulls, caches, and serves content from the origin.
    - name (string) --
      
      The name of the origin resource.
    - resourceType (string) --
      
      The resource type of the origin resource (e.g., Instance ).
    - regionName (string) --
      
      The AWS Region name of the origin resource.
    - protocolPolicy (string) --
      
      The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
  - originPublicDNS (string) --
    
    The public DNS of the origin.
  - defaultCacheBehavior (dict) --
    
    An object that describes the default cache behavior of the distribution.
    - behavior (string) --
      
      The cache behavior of the distribution.
      
      The following cache behaviors can be specified:
      - cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
      - dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
  - cacheBehaviorSettings (dict) --
    
    An object that describes the cache behavior settings of the distribution.
    - defaultTTL (integer) --
      
      The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
      
      Note
      
      The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
    - minimumTTL (integer) --
      
      The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
      
      A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
    - maximumTTL (integer) --
      
      The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
      
      The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
    - allowedHTTPMethods (string) --
      
      The HTTP methods that are processed and forwarded to the distribution's origin.
      
      You can specify the following options:
      - GET,HEAD - The distribution forwards the GET and HEAD methods.
      - GET,HEAD,OPTIONS - The distribution forwards the GET , HEAD , and OPTIONS methods.
      - GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET , HEAD , OPTIONS , PUT , PATCH , POST , and DELETE methods.
      If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
    - cachedHTTPMethods (string) --
      
      The HTTP method responses that are cached by your distribution.
      
      You can specify the following options:
      - GET,HEAD - The distribution caches responses to the GET and HEAD methods.
      - GET,HEAD,OPTIONS - The distribution caches responses to the GET , HEAD , and OPTIONS methods.
    - forwardedCookies (dict) --
      
      An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
      - option (string) --
        
        Specifies which cookies to forward to the distribution's origin for a cache behavior: all , none , or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
      - cookiesAllowList (list) --
        
        The specific cookies to forward to your distribution's origin.
        
        (string) --
    - forwardedHeaders (dict) --
      
      An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
      - option (string) --
        
        The headers that you want your distribution to forward to your origin and base caching on.
        
        You can configure your distribution to do one of the following:
        
        all - Forward all headers to your origin.
        
        none - Forward only the default headers.
        
        allow-list - Forward only the headers you specify using the headersAllowList parameter.
      - headersAllowList (list) --
        
        The specific headers to forward to your distribution's origin.
        
        (string) --
    - forwardedQueryStrings (dict) --
      
      An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
      - option (boolean) --
        
        Indicates whether the distribution forwards and caches based on query strings.
      - queryStringsAllowList (list) --
        
        The specific query strings that the distribution forwards to the origin.
        
        Your distribution will cache content based on the specified query strings.
        
        If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
        
        (string) --
  - cacheBehaviors (list) --
    
    An array of objects that describe the per-path cache behavior of the distribution.
    - (dict) --
      
      Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
      
      A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
      
      if the cacheBehavior's behavior is set to 'cache', then
      - path (string) --
        
        The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/* ), and file types ( *.html, *jpg, *js ). Directories and file paths are case-sensitive.
        
        Examples:
        
        Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
        
        Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
        
        Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
        
        Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
      - behavior (string) --
        
        The cache behavior for the specified path.
        
        You can specify one of the following per-path cache behaviors:
        
        cache - This behavior caches the specified path.
        
        dont-cache - This behavior doesn't cache the specified path.
  - ableToUpdateBundle (boolean) --
    
    Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
    
    Use the UpdateDistributionBundle action to change your distribution's bundle.
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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

The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_domain(
    domainName='string',
    tags=[
        {
            'key': 'string',
            'value': '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.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Lightsail Dev Guide.

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, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:
- A
- CNAME
- MX
- NS
- SOA
- SRV
- TXT
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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_instance_snapshot(
    instanceSnapshotName='string',
    instanceName='string',
    tags=[
        {
            'key': 'string',
            'value': '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.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_instances(
    instanceNames=[
        'string',
    ],
    availabilityZone='string',
    customImageName='string',
    blueprintId='string',
    bundleId='string',
    userData='string',
    keyPairName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    addOns=[
        {
            'addOnType': 'AutoSnapshot',
            'autoSnapshotAddOnRequest': {
                'snapshotTimeOfDay': '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 ).

Note

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

type addOns

list

param addOns

An array of objects representing the add-ons to enable for the new instance.

(dict) --

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

Note

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
- addOnType (string) -- [REQUIRED]
  
  The add-on type.
- autoSnapshotAddOnRequest (dict) --
  
  An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
  - snapshotTimeOfDay (string) --
    
    The daily time when an automatic snapshot will be created.
    
    Constraints:
    - Must be in HH:00 format, and in an hourly increment.
    - Specified in Coordinated Universal Time (UTC).
    - The snapshot will be automatically created between the time specified and up to 45 minutes after.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name . For more information, see the Lightsail Dev Guide.

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',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    addOns=[
        {
            'addOnType': 'AutoSnapshot',
            'autoSnapshotAddOnRequest': {
                'snapshotTimeOfDay': 'string'
            }
        },
    ],
    sourceInstanceName='string',
    restoreDate='string',
    useLatestRestorableAutoSnapshot=True|False
)

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

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.

Constraint:

This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

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.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

type addOns

list

param addOns

An array of objects representing the add-ons to enable for the new instance.

(dict) --

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

Note

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.
- addOnType (string) -- [REQUIRED]
  
  The add-on type.
- autoSnapshotAddOnRequest (dict) --
  
  An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
  - snapshotTimeOfDay (string) --
    
    The daily time when an automatic snapshot will be created.
    
    Constraints:
    - Must be in HH:00 format, and in an hourly increment.
    - Specified in Coordinated Universal Time (UTC).
    - The snapshot will be automatically created between the time specified and up to 45 minutes after.

type sourceInstanceName

string

param sourceInstanceName

The name of the source instance from which the source automatic snapshot was created.

Constraints:

This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

type restoreDate

string

param restoreDate

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

type useLatestRestorableAutoSnapshot

boolean

param useLatestRestorableAutoSnapshot

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'resourceType': {'ContainerService'}},
 'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Creates an SSH key pair.

The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_key_pair(
    keyPairName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type keyPairName

string

param keyPairName

[REQUIRED]

The name for your new key pair.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'fingerprint': 'string'
    },
    'publicKeyBase64': 'string',
    'privateKeyBase64': 'string',
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        '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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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 objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_load_balancer(
    loadBalancerName='string',
    instancePort=123,
    healthCheckPath='string',
    certificateName='string',
    certificateDomainName='string',
    certificateAlternativeNames=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': '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) --

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a Lightsail load balancer TLS certificate.

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

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_load_balancer_tls_certificate(
    loadBalancerName='string',
    certificateName='string',
    certificateDomainName='string',
    certificateAlternativeNames=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': '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) --

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_relational_database(
    relationalDatabaseName='string',
    availabilityZone='string',
    relationalDatabaseBlueprintId='string',
    relationalDatabaseBundleId='string',
    masterDatabaseName='string',
    masterUsername='string',
    masterUserPassword='string',
    preferredBackupWindow='string',
    preferredMaintenanceWindow='string',
    publiclyAccessible=True|False,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name to use for your new database.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

type availabilityZone

string

param availabilityZone

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

type relationalDatabaseBlueprintId

string

param relationalDatabaseBlueprintId

[REQUIRED]

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

type relationalDatabaseBundleId

string

param relationalDatabaseBundleId

[REQUIRED]

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

type masterDatabaseName

string

param masterDatabaseName

[REQUIRED]

The name of the master database created when the Lightsail database resource is created.

Constraints:

Must contain from 1 to 64 alphanumeric characters.
Cannot be a word reserved by the specified database engine

type masterUsername

string

param masterUsername

[REQUIRED]

The master user name for your new database.

Constraints:

Master user name is required.
Must contain from 1 to 16 alphanumeric characters.
The first character must be a letter.
Cannot be a reserved word for the database engine you choose. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.

type masterUserPassword

string

param masterUserPassword

The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

type preferredBackupWindow

string

param preferredBackupWindow

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

type preferredMaintenanceWindow

string

param preferredMaintenanceWindow

The weekly time range during which system maintenance can occur on your new database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30

type publiclyAccessible

boolean

param publiclyAccessible

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateRelationalDatabaseFromSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_relational_database_from_snapshot(
    relationalDatabaseName='string',
    availabilityZone='string',
    publiclyAccessible=True|False,
    relationalDatabaseSnapshotName='string',
    relationalDatabaseBundleId='string',
    sourceRelationalDatabaseName='string',
    restoreTime=datetime(2015, 1, 1),
    useLatestRestorableTime=True|False,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name to use for your new database.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

type availabilityZone

string

param availabilityZone

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

type publiclyAccessible

boolean

param publiclyAccessible

type relationalDatabaseSnapshotName

string

param relationalDatabaseSnapshotName

The name of the database snapshot from which to create your new database.

type relationalDatabaseBundleId

string

param relationalDatabaseBundleId

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

type sourceRelationalDatabaseName

string

param sourceRelationalDatabaseName

The name of the source database.

type restoreTime

datetime

param restoreTime

The date and time to restore your database from.

Constraints:

Must be before the latest restorable time for the database.
Cannot be specified if the use latest restorable time parameter is true .
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

type useLatestRestorableTime

boolean

param useLatestRestorableTime

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

CreateRelationalDatabaseSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.create_relational_database_snapshot(
    relationalDatabaseName='string',
    relationalDatabaseSnapshotName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of the database on which to base your new snapshot.

type relationalDatabaseSnapshotName

string

param relationalDatabaseSnapshotName

[REQUIRED]

The name for your new database snapshot.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

type tags

list

param tags

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteAlarm (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes an alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.delete_alarm(
    alarmName='string'
)

type alarmName

string

param alarmName

[REQUIRED]

The name of the alarm to delete.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteAutoSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.delete_auto_snapshot(
    resourceName='string',
    date='string'
)

type resourceName

string

param resourceName

[REQUIRED]

The name of the source instance or disk from which to delete the automatic snapshot.

type date

string

param date

[REQUIRED]

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteCertificate (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

See also: AWS API Documentation

Request Syntax

client.delete_certificate(
    certificateName='string'
)

type certificateName

string

param certificateName

[REQUIRED]

The name of the certificate to delete.

Use the GetCertificates action to get a list of certificate names that you can specify.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteContactMethod (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes a contact method.

See also: AWS API Documentation

Request Syntax

client.delete_contact_method(
    protocol='Email'|'SMS'
)

type protocol

string

param protocol

[REQUIRED]

The protocol that will be deleted, such as Email or SMS (text messaging).

Note

To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.delete_disk(
    diskName='string',
    forceDeleteAddOns=True|False
)

type diskName

string

param diskName

[REQUIRED]

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

type forceDeleteAddOns

boolean

param forceDeleteAddOns

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteDistribution (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

See also: AWS API Documentation

Request Syntax

client.delete_distribution(
    distributionName='string'
)

type distributionName

string

param distributionName

The name of the distribution to delete.

Use the GetDistributions action to get a list of distribution names that you can specify.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Lightsail Dev Guide.

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, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:
- A
- CNAME
- MX
- NS
- SOA
- SRV
- TXT
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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.delete_instance(
    instanceName='string',
    forceDeleteAddOns=True|False
)

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance to delete.

type forceDeleteAddOns

boolean

param forceDeleteAddOns

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Deletes a specific SSH key pair.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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.

DeleteKnownHostKeys (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Warning

Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

See also: AWS API Documentation

Request Syntax

client.delete_known_host_keys(
    instanceName='string'
)

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance for which you want to reset the host key or certificate.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.delete_relational_database(
    relationalDatabaseName='string',
    skipFinalSnapshot=True|False,
    finalRelationalDatabaseSnapshotName='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of the database that you are deleting.

type skipFinalSnapshot

boolean

param skipFinalSnapshot

Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false .

Default: false

type finalRelationalDatabaseSnapshotName

string

param finalRelationalDatabaseSnapshotName

The name of the database snapshot created if skip final snapshot is false , which is the default value for that parameter.

Note

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DeleteRelationalDatabaseSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.delete_relational_database_snapshot(
    relationalDatabaseSnapshotName='string'
)

type relationalDatabaseSnapshotName

string

param relationalDatabaseSnapshotName

[REQUIRED]

The name of the database snapshot that you are deleting.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DetachCertificateFromDistribution (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

See also: AWS API Documentation

Request Syntax

client.detach_certificate_from_distribution(
    distributionName='string'
)

type distributionName

string

param distributionName

[REQUIRED]

The name of the distribution from which to detach the certificate.

Use the GetDistributions action to get a list of distribution names that you can specify.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

DisableAddOn (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.disable_add_on(
    addOnType='AutoSnapshot',
    resourceName='string'
)

type addOnType

string

param addOnType

[REQUIRED]

The add-on type to disable.

type resourceName

string

param resourceName

[REQUIRED]

The name of the source resource for which to disable the add-on.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

EnableAddOn (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.enable_add_on(
    resourceName='string',
    addOnRequest={
        'addOnType': 'AutoSnapshot',
        'autoSnapshotAddOnRequest': {
            'snapshotTimeOfDay': 'string'
        }
    }
)

type resourceName

string

param resourceName

[REQUIRED]

The name of the source resource for which to enable or modify the add-on.

type addOnRequest

dict

param addOnRequest

[REQUIRED]

An array of strings representing the add-on to enable or modify.

addOnType (string) -- [REQUIRED]

The add-on type.
autoSnapshotAddOnRequest (dict) --

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
- snapshotTimeOfDay (string) --
  
  The daily time when an automatic snapshot will be created.
  
  Constraints:
  - Must be in HH:00 format, and in an hourly increment.
  - Specified in Coordinated Universal Time (UTC).
  - The snapshot will be automatically created between the time specified and up to 45 minutes after.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

ExportSnapshot (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name . For more information, see the Lightsail Dev Guide.

Note

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

See also: AWS API Documentation

Request Syntax

client.export_snapshot(
    sourceSnapshotName='string'
)

type sourceSnapshotName

string

param sourceSnapshotName

[REQUIRED]

The name of the instance or disk snapshot to be exported to Amazon EC2.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

GetAlarms (updated)

Link ¶
Changes (response)

{'alarms': {'monitoredResourceInfo': {'resourceType': {'ContainerService'}},
            'resourceType': {'ContainerService'}}}

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

See also: AWS API Documentation

Request Syntax

client.get_alarms(
    alarmName='string',
    pageToken='string',
    monitoredResourceName='string'
)

type alarmName

string

param alarmName

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

type monitoredResourceName

string

param monitoredResourceName

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

rtype

dict

returns

Response Syntax

{
    'alarms': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'supportCode': 'string',
            'monitoredResourceInfo': {
                'arn': 'string',
                'name': 'string',
                'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'
            },
            'comparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'evaluationPeriods': 123,
            'period': 123,
            'threshold': 123.0,
            'datapointsToAlarm': 123,
            'treatMissingData': 'breaching'|'notBreaching'|'ignore'|'missing',
            'statistic': 'Minimum'|'Maximum'|'Sum'|'Average'|'SampleCount',
            'metricName': 'CPUUtilization'|'NetworkIn'|'NetworkOut'|'StatusCheckFailed'|'StatusCheckFailed_Instance'|'StatusCheckFailed_System'|'ClientTLSNegotiationErrorCount'|'HealthyHostCount'|'UnhealthyHostCount'|'HTTPCode_LB_4XX_Count'|'HTTPCode_LB_5XX_Count'|'HTTPCode_Instance_2XX_Count'|'HTTPCode_Instance_3XX_Count'|'HTTPCode_Instance_4XX_Count'|'HTTPCode_Instance_5XX_Count'|'InstanceResponseTime'|'RejectedConnectionCount'|'RequestCount'|'DatabaseConnections'|'DiskQueueDepth'|'FreeStorageSpace'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'BurstCapacityTime'|'BurstCapacityPercentage',
            'state': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
            'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
            'contactProtocols': [
                'Email'|'SMS',
            ],
            'notificationTriggers': [
                'OK'|'ALARM'|'INSUFFICIENT_DATA',
            ],
            'notificationEnabled': True|False
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- alarms (list) --
  
  An array of objects that describe the alarms.
  - (dict) --
    
    Describes an alarm.
    
    An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
    - name (string) --
      
      The name of the alarm.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the alarm.
    - createdAt (datetime) --
      
      The timestamp when the alarm was created.
    - location (dict) --
      
      An object that lists information about the location of the alarm.
      - 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., Alarm ).
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
    - monitoredResourceInfo (dict) --
      
      An object that lists information about the resource monitored by the alarm.
      - arn (string) --
        
        The Amazon Resource Name (ARN) of the resource being monitored.
      - name (string) --
        
        The name of the Lightsail resource being monitored.
      - resourceType (string) --
        
        The Lightsail resource type of the resource being monitored.
        
        Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
    - comparisonOperator (string) --
      
      The arithmetic operation used when comparing the specified statistic and threshold.
    - evaluationPeriods (integer) --
      
      The number of periods over which data is compared to the specified threshold.
    - period (integer) --
      
      The period, in seconds, over which the statistic is applied.
    - threshold (float) --
      
      The value against which the specified statistic is compared.
    - datapointsToAlarm (integer) --
      
      The number of data points that must not within the specified threshold to trigger the alarm.
    - treatMissingData (string) --
      
      Specifies how the alarm handles missing data points.
      
      An alarm can treat missing data in the following ways:
      - breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
      - notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
      - ignore - Ignore the missing data. Maintains the current alarm state.
      - missing - Missing data is treated as missing.
    - statistic (string) --
      
      The statistic for the metric associated with the alarm.
      
      The following statistics are available:
      - Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
      - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
      - Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
      - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
      - SampleCount - The count, or number, of data points used for the statistical calculation.
    - metricName (string) --
      
      The name of the metric associated with the alarm.
    - state (string) --
      
      The current state of the alarm.
      
      An alarm has the following possible states:
      - ALARM - The metric is outside of the defined threshold.
      - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
      - OK - The metric is within the defined threshold.
    - unit (string) --
      
      The unit of the metric associated with the alarm.
    - contactProtocols (list) --
      
      The contact protocols for the alarm, such as Email , SMS (text messaging), or both.
      - (string) --
    - notificationTriggers (list) --
      
      The alarm states that trigger a notification.
      - (string) --
    - notificationEnabled (boolean) --
      
      Indicates whether the alarm is enabled.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

GetAutoSnapshots (updated)

Link ¶
Changes (response)

{'resourceType': {'ContainerService'}}

Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.get_auto_snapshots(
    resourceName='string'
)

type resourceName

string

param resourceName

[REQUIRED]

The name of the source instance or disk from which to get automatic snapshot information.

rtype

dict

returns

Response Syntax

{
    'resourceName': 'string',
    'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
    'autoSnapshots': [
        {
            'date': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': 'Success'|'Failed'|'InProgress'|'NotFound',
            'fromAttachedDisks': [
                {
                    'path': 'string',
                    'sizeInGb': 123
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- resourceName (string) --
  
  The name of the source instance or disk for the automatic snapshots.
- resourceType (string) --
  
  The resource type (e.g., Instance or Disk ).
- autoSnapshots (list) --
  
  An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
  - (dict) --
    
    Describes an automatic snapshot.
    - date (string) --
      
      The date of the automatic snapshot in YYYY-MM-DD format.
    - createdAt (datetime) --
      
      The timestamp when the automatic snapshot was created.
    - status (string) --
      
      The status of the automatic snapshot.
    - fromAttachedDisks (list) --
      
      An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.
      - (dict) --
        
        Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.
        
        path (string) --
        
        The path of the disk (e.g., /dev/xvdf ).
        
        sizeInGb (integer) --
        
        The size of the disk in GB.

GetCloudFormationStackRecords (updated)

Link ¶
Changes (response)

{'cloudFormationStackRecords': {'resourceType': {'ContainerService'}}}

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

See also: AWS API Documentation

Request Syntax

client.get_cloud_formation_stack_records(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'cloudFormationStackRecords': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'state': 'Started'|'Succeeded'|'Failed',
            'sourceInfo': [
                {
                    'resourceType': 'ExportSnapshotRecord',
                    'name': 'string',
                    'arn': 'string'
                },
            ],
            'destinationInfo': {
                'id': 'string',
                'service': 'string'
            }
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- cloudFormationStackRecords (list) --
  
  A list of objects describing the CloudFormation stack records.
  - (dict) --
    
    Describes a CloudFormation stack record created as a result of the create cloud formation stack operation.
    
    A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
    - name (string) --
      
      The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the CloudFormation stack record.
    - createdAt (datetime) --
      
      The date when the CloudFormation stack record was created.
    - location (dict) --
      
      A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
      - 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., CloudFormationStackRecord ).
    - state (string) --
      
      The current state of the CloudFormation stack record.
    - sourceInfo (list) --
      
      A list of objects describing the source of the CloudFormation stack record.
      - (dict) --
        
        Describes the source of a CloudFormation stack record (i.e., the export snapshot record).
        
        resourceType (string) --
        
        The Lightsail resource type (e.g., ExportSnapshotRecord ).
        
        name (string) --
        
        The name of the record.
        
        arn (string) --
        
        The Amazon Resource Name (ARN) of the export snapshot record.
    - destinationInfo (dict) --
      
      A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
      - id (string) --
        
        The ID of the resource created at the destination.
      - service (string) --
        
        The destination service of the record.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.

GetContactMethods (updated)

Link ¶
Changes (response)

{'contactMethods': {'resourceType': {'ContainerService'}}}

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

See also: AWS API Documentation

Request Syntax

client.get_contact_methods(
    protocols=[
        'Email'|'SMS',
    ]
)

type protocols

list

param protocols

The protocols used to send notifications, such as Email , or SMS (text messaging).

Specify a protocol in your request to return information about a specific contact method protocol.

(string) --

rtype

dict

returns

Response Syntax

{
    'contactMethods': [
        {
            'contactEndpoint': 'string',
            'status': 'PendingVerification'|'Valid'|'Invalid',
            'protocol': 'Email'|'SMS',
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'supportCode': 'string'
        },
    ]
}

Response Structure

(dict) --
- contactMethods (list) --
  
  An array of objects that describe the contact methods.
  - (dict) --
    
    Describes a contact method.
    
    A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
    - contactEndpoint (string) --
      
      The destination of the contact method, such as an email address or a mobile phone number.
    - status (string) --
      
      The current status of the contact method.
      
      A contact method has the following possible status:
      - PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.
      - Valid - The contact method has been verified.
      - InValid - An attempt was made to verify the contact method, but the verification has expired.
    - protocol (string) --
      
      The protocol of the contact method, such as email or SMS (text messaging).
    - name (string) --
      
      The name of the contact method.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the contact method.
    - createdAt (datetime) --
      
      The timestamp when the contact method was created.
    - location (dict) --
      
      Describes the resource location.
      - 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., ContactMethod ).
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

GetDisk (updated)

Link ¶
Changes (response)

{'disk': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'addOns': [
            {
                'name': 'string',
                'status': 'string',
                'snapshotTimeOfDay': 'string',
                'nextSnapshotTimeOfDay': 'string'
            },
        ],
        '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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - addOns (list) --
    
    An array of objects representing the add-ons enabled on the disk.
    - (dict) --
      
      Describes an add-on that is enabled for an Amazon Lightsail resource.
      - name (string) --
        
        The name of the add-on.
      - status (string) --
        
        The status of the add-on.
      - snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
      - nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
  - 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': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'sizeInGb': 123,
        'state': 'pending'|'completed'|'error'|'unknown',
        'progress': 'string',
        'fromDiskName': 'string',
        'fromDiskArn': 'string',
        'fromInstanceName': 'string',
        'fromInstanceArn': 'string',
        'isFromAutoSnapshot': True|False
    }
}

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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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 the disk snapshot was created.
  - fromDiskArn (string) --
    
    The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
  - fromInstanceName (string) --
    
    The unique name of the source instance from which the disk (system volume) snapshot was created.
  - fromInstanceArn (string) --
    
    The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
  - isFromAutoSnapshot (boolean) --
    
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.

GetDiskSnapshots (updated)

Link ¶
Changes (response)

{'diskSnapshots': {'resourceType': {'ContainerService'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_disk_snapshots(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'sizeInGb': 123,
            'state': 'pending'|'completed'|'error'|'unknown',
            'progress': 'string',
            'fromDiskName': 'string',
            'fromDiskArn': 'string',
            'fromInstanceName': 'string',
            'fromInstanceArn': 'string',
            'isFromAutoSnapshot': True|False
        },
    ],
    '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 ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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 the disk snapshot was created.
    - fromDiskArn (string) --
      
      The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
    - fromInstanceName (string) --
      
      The unique name of the source instance from which the disk (system volume) snapshot was created.
    - fromInstanceArn (string) --
      
      The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
    - isFromAutoSnapshot (boolean) --
      
      A Boolean value indicating whether the snapshot was created from an automatic snapshot.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.

GetDisks (updated)

Link ¶
Changes (response)

{'disks': {'resourceType': {'ContainerService'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_disks(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'addOns': [
                {
                    'name': 'string',
                    'status': 'string',
                    'snapshotTimeOfDay': 'string',
                    'nextSnapshotTimeOfDay': 'string'
                },
            ],
            '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 a 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 ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - addOns (list) --
      
      An array of objects representing the add-ons enabled on the disk.
      - (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
    - 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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

GetDistributions (updated)

Link ¶
Changes (response)

{'distributions': {'origin': {'resourceType': {'ContainerService'}},
                   'resourceType': {'ContainerService'}}}

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

See also: AWS API Documentation

Request Syntax

client.get_distributions(
    distributionName='string',
    pageToken='string'
)

type distributionName

string

param distributionName

The name of the distribution for which to return information.

Use the GetDistributions action to get a list of distribution names that you can specify.

When omitted, the response includes all of your distributions in the AWS Region where the request is made.

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'distributions': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'alternativeDomainNames': [
                'string',
            ],
            'status': 'string',
            'isEnabled': True|False,
            'domainName': 'string',
            'bundleId': 'string',
            'certificateName': 'string',
            'origin': {
                'name': 'string',
                'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2',
                'protocolPolicy': 'http-only'|'https-only'
            },
            'originPublicDNS': 'string',
            'defaultCacheBehavior': {
                'behavior': 'dont-cache'|'cache'
            },
            'cacheBehaviorSettings': {
                'defaultTTL': 123,
                'minimumTTL': 123,
                'maximumTTL': 123,
                'allowedHTTPMethods': 'string',
                'cachedHTTPMethods': 'string',
                'forwardedCookies': {
                    'option': 'none'|'allow-list'|'all',
                    'cookiesAllowList': [
                        'string',
                    ]
                },
                'forwardedHeaders': {
                    'option': 'none'|'allow-list'|'all',
                    'headersAllowList': [
                        'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
                    ]
                },
                'forwardedQueryStrings': {
                    'option': True|False,
                    'queryStringsAllowList': [
                        'string',
                    ]
                }
            },
            'cacheBehaviors': [
                {
                    'path': 'string',
                    'behavior': 'dont-cache'|'cache'
                },
            ],
            'ableToUpdateBundle': True|False,
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- distributions (list) --
  
  An array of objects that describe your distributions.
  - (dict) --
    
    Describes an Amazon Lightsail content delivery network (CDN) distribution.
    - name (string) --
      
      The name of the distribution.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the distribution.
    - supportCode (string) --
      
      The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The timestamp when the distribution was created.
    - location (dict) --
      
      An object that describes the location of the distribution, such as the AWS Region and Availability Zone.
      
      Note
      
      Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
      - 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., Distribution ).
    - alternativeDomainNames (list) --
      
      The alternate domain names of the distribution.
      - (string) --
    - status (string) --
      
      The status of the distribution.
    - isEnabled (boolean) --
      
      Indicates whether the distribution is enabled.
    - domainName (string) --
      
      The domain name of the distribution.
    - bundleId (string) --
      
      The ID of the bundle currently applied to the distribution.
    - certificateName (string) --
      
      The name of the SSL/TLS certificate attached to the distribution, if any.
    - origin (dict) --
      
      An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer.
      
      The distribution pulls, caches, and serves content from the origin.
      - name (string) --
        
        The name of the origin resource.
      - resourceType (string) --
        
        The resource type of the origin resource (e.g., Instance ).
      - regionName (string) --
        
        The AWS Region name of the origin resource.
      - protocolPolicy (string) --
        
        The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
    - originPublicDNS (string) --
      
      The public DNS of the origin.
    - defaultCacheBehavior (dict) --
      
      An object that describes the default cache behavior of the distribution.
      - behavior (string) --
        
        The cache behavior of the distribution.
        
        The following cache behaviors can be specified:
        
        cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
        
        dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
    - cacheBehaviorSettings (dict) --
      
      An object that describes the cache behavior settings of the distribution.
      - defaultTTL (integer) --
        
        The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
        
        Note
        
        The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
      - minimumTTL (integer) --
        
        The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
        
        A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
      - maximumTTL (integer) --
        
        The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
        
        The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
      - allowedHTTPMethods (string) --
        
        The HTTP methods that are processed and forwarded to the distribution's origin.
        
        You can specify the following options:
        
        GET,HEAD - The distribution forwards the GET and HEAD methods.
        
        GET,HEAD,OPTIONS - The distribution forwards the GET , HEAD , and OPTIONS methods.
        
        GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET , HEAD , OPTIONS , PUT , PATCH , POST , and DELETE methods.
        
        If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
      - cachedHTTPMethods (string) --
        
        The HTTP method responses that are cached by your distribution.
        
        You can specify the following options:
        
        GET,HEAD - The distribution caches responses to the GET and HEAD methods.
        
        GET,HEAD,OPTIONS - The distribution caches responses to the GET , HEAD , and OPTIONS methods.
      - forwardedCookies (dict) --
        
        An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
        
        option (string) --
        
        Specifies which cookies to forward to the distribution's origin for a cache behavior: all , none , or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
        
        cookiesAllowList (list) --
        
        The specific cookies to forward to your distribution's origin.
        
        (string) --
      - forwardedHeaders (dict) --
        
        An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
        
        option (string) --
        
        The headers that you want your distribution to forward to your origin and base caching on.
        
        You can configure your distribution to do one of the following:
        
        all - Forward all headers to your origin.
        
        none - Forward only the default headers.
        
        allow-list - Forward only the headers you specify using the headersAllowList parameter.
        
        headersAllowList (list) --
        
        The specific headers to forward to your distribution's origin.
        
        (string) --
      - forwardedQueryStrings (dict) --
        
        An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
        
        option (boolean) --
        
        Indicates whether the distribution forwards and caches based on query strings.
        
        queryStringsAllowList (list) --
        
        The specific query strings that the distribution forwards to the origin.
        
        Your distribution will cache content based on the specified query strings.
        
        If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
        
        (string) --
    - cacheBehaviors (list) --
      
      An array of objects that describe the per-path cache behavior of the distribution.
      - (dict) --
        
        Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
        
        A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
        
        if the cacheBehavior's behavior is set to 'cache', then
        
        path (string) --
        
        The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/* ), and file types ( *.html, *jpg, *js ). Directories and file paths are case-sensitive.
        
        Examples:
        
        Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
        
        Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
        
        Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
        
        Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
        
        behavior (string) --
        
        The cache behavior for the specified path.
        
        You can specify one of the following per-path cache behaviors:
        
        cache - This behavior caches the specified path.
        
        dont-cache - This behavior doesn't cache the specified path.
    - ableToUpdateBundle (boolean) --
      
      Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
      
      Use the UpdateDistributionBundle action to change your distribution's bundle.
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.

GetDomain (updated)

Link ¶
Changes (response)

{'domain': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        '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.
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
        
        The following domain entry types can be used:
        
        A
        
        CNAME
        
        MX
        
        NS
        
        SOA
        
        SRV
        
        TXT
      - 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': {'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            '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.
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
        
        The following domain entry types can be used:
        
        A
        
        CNAME
        
        MX
        
        NS
        
        SOA
        
        SRV
        
        TXT
        
        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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.

GetExportSnapshotRecords (updated)

Link ¶
Changes (response)

{'exportSnapshotRecords': {'resourceType': {'ContainerService'}}}

Returns the export snapshot record created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.

See also: AWS API Documentation

Request Syntax

client.get_export_snapshot_records(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'exportSnapshotRecords': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'state': 'Started'|'Succeeded'|'Failed',
            'sourceInfo': {
                'resourceType': 'InstanceSnapshot'|'DiskSnapshot',
                'createdAt': datetime(2015, 1, 1),
                'name': 'string',
                'arn': 'string',
                'fromResourceName': 'string',
                'fromResourceArn': 'string',
                'instanceSnapshotInfo': {
                    'fromBundleId': 'string',
                    'fromBlueprintId': 'string',
                    'fromDiskInfo': [
                        {
                            'name': 'string',
                            'path': 'string',
                            'sizeInGb': 123,
                            'isSystemDisk': True|False
                        },
                    ]
                },
                'diskSnapshotInfo': {
                    'sizeInGb': 123
                }
            },
            'destinationInfo': {
                'id': 'string',
                'service': 'string'
            }
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- exportSnapshotRecords (list) --
  
  A list of objects describing the export snapshot records.
  - (dict) --
    
    Describes an export snapshot record.
    - name (string) --
      
      The export snapshot record name.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the export snapshot record.
    - createdAt (datetime) --
      
      The date when the export snapshot record was created.
    - location (dict) --
      
      The AWS Region and Availability Zone where the export snapshot record 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., ExportSnapshotRecord ).
    - state (string) --
      
      The state of the export snapshot record.
    - sourceInfo (dict) --
      
      A list of objects describing the source of the export snapshot record.
      - resourceType (string) --
        
        The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot ).
      - createdAt (datetime) --
        
        The date when the source instance or disk snapshot was created.
      - name (string) --
        
        The name of the source instance or disk snapshot.
      - arn (string) --
        
        The Amazon Resource Name (ARN) of the source instance or disk snapshot.
      - fromResourceName (string) --
        
        The name of the snapshot's source instance or disk.
      - fromResourceArn (string) --
        
        The Amazon Resource Name (ARN) of the snapshot's source instance or disk.
      - instanceSnapshotInfo (dict) --
        
        A list of objects describing an instance snapshot.
        
        fromBundleId (string) --
        
        The bundle ID from which the source instance was created (e.g., micro_1_0 ).
        
        fromBlueprintId (string) --
        
        The blueprint ID from which the source instance (e.g., os_debian_8_3 ).
        
        fromDiskInfo (list) --
        
        A list of objects describing the disks that were attached to the source instance.
        
        (dict) --
        
        Describes a disk.
        
        name (string) --
        
        The disk name.
        
        path (string) --
        
        The disk path.
        
        sizeInGb (integer) --
        
        The size of the disk in GB (e.g., 32 ).
        
        isSystemDisk (boolean) --
        
        A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
      - diskSnapshotInfo (dict) --
        
        A list of objects describing a disk snapshot.
        
        sizeInGb (integer) --
        
        The size of the disk in GB (e.g., 32 ).
    - destinationInfo (dict) --
      
      A list of objects describing the destination of the export snapshot record.
      - id (string) --
        
        The ID of the resource created at the destination.
      - service (string) --
        
        The destination service of the record.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

GetInstance (updated)

Link ¶
Changes (response)

{'instance': {'hardware': {'disks': {'resourceType': {'ContainerService'}}},
              'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'blueprintId': 'string',
        'blueprintName': 'string',
        'bundleId': 'string',
        'addOns': [
            {
                'name': 'string',
                'status': 'string',
                'snapshotTimeOfDay': 'string',
                'nextSnapshotTimeOfDay': 'string'
            },
        ],
        'isStaticIp': True|False,
        'privateIpAddress': 'string',
        'publicIpAddress': 'string',
        'ipv6Address': 'string',
        'hardware': {
            'cpuCount': 123,
            'disks': [
                {
                    'name': 'string',
                    'arn': 'string',
                    'supportCode': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'location': {
                        'availabilityZone': 'string',
                        'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                    },
                    'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
                    'tags': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'addOns': [
                        {
                            'name': 'string',
                            'status': 'string',
                            'snapshotTimeOfDay': 'string',
                            'nextSnapshotTimeOfDay': 'string'
                        },
                    ],
                    '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'|'icmp',
                    'accessFrom': 'string',
                    'accessType': 'Public'|'Private',
                    'commonName': 'string',
                    'accessDirection': 'inbound'|'outbound',
                    'cidrs': [
                        'string',
                    ],
                    'cidrListAliases': [
                        'string',
                    ]
                },
            ]
        },
        '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 ) in Unix time format.
  - 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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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 ).
  - addOns (list) --
    
    An array of objects representing the add-ons enabled on the instance.
    - (dict) --
      
      Describes an add-on that is enabled for an Amazon Lightsail resource.
      - name (string) --
        
        The name of the add-on.
      - status (string) --
        
        The status of the add-on.
      - snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
      - nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
  - 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 a 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 ).
        
        tags (list) --
        
        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        addOns (list) --
        
        An array of objects representing the add-ons enabled on the disk.
        
        (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        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 ports for an Amazon Lightsail instance.
        
        fromPort (integer) --
        
        The first port in a range of open ports on an instance.
        
        Allowed ports:
        
        TCP and UDP - 0 to 65535
        
        ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
        
        toPort (integer) --
        
        The last port in a range of open ports on an instance.
        
        Allowed ports:
        
        TCP and UDP - 0 to 65535
        
        ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
        
        protocol (string) --
        
        The IP protocol name.
        
        The name 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.
        
        icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
        
        accessFrom (string) --
        
        The location from which access is allowed. For example, Anywhere (0.0.0.0/0) , or Custom if a specific IP address or range of IP addresses is allowed.
        
        accessType (string) --
        
        The type of access ( Public or Private ).
        
        commonName (string) --
        
        The common name of the port information.
        
        accessDirection (string) --
        
        The access direction ( inbound or outbound ).
        
        Note
        
        Lightsail currently supports only inbound access direction.
        
        cidrs (list) --
        
        The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
        
        For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
        
        (string) --
        
        cidrListAliases (list) --
        
        An alias that defines access for a preconfigured range of IP addresses.
        
        The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
        
        (string) --
  - 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': {'resourceType': {'ContainerService'}},
                      'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        '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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                },
                'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
                'tags': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'addOns': [
                    {
                        'name': 'string',
                        'status': 'string',
                        'snapshotTimeOfDay': 'string',
                        'nextSnapshotTimeOfDay': 'string'
                    },
                ],
                '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',
        'isFromAutoSnapshot': True|False,
        '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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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 a 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 ).
      - tags (list) --
        
        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - addOns (list) --
        
        An array of objects representing the add-ons enabled on the disk.
        
        (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
      - 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 ).
  - isFromAutoSnapshot (boolean) --
    
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
  - sizeInGb (integer) --
    
    The size in GB of the SSD.

GetInstanceSnapshots (updated)

Link ¶
Changes (response)

{'instanceSnapshots': {'fromAttachedDisks': {'resourceType': {'ContainerService'}},
                       'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            '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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                    },
                    'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
                    'tags': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'addOns': [
                        {
                            'name': 'string',
                            'status': 'string',
                            'snapshotTimeOfDay': 'string',
                            'nextSnapshotTimeOfDay': 'string'
                        },
                    ],
                    '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',
            'isFromAutoSnapshot': True|False,
            '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 an instance snapshot.
    - 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 ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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 a 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 ).
        
        tags (list) --
        
        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        addOns (list) --
        
        An array of objects representing the add-ons enabled on the disk.
        
        (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        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 ).
    - isFromAutoSnapshot (boolean) --
      
      A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    - sizeInGb (integer) --
      
      The size in GB of the SSD.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

GetInstances (updated)

Link ¶
Changes (response)

{'instances': {'hardware': {'disks': {'resourceType': {'ContainerService'}}},
               'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'blueprintId': 'string',
            'blueprintName': 'string',
            'bundleId': 'string',
            'addOns': [
                {
                    'name': 'string',
                    'status': 'string',
                    'snapshotTimeOfDay': 'string',
                    'nextSnapshotTimeOfDay': 'string'
                },
            ],
            'isStaticIp': True|False,
            'privateIpAddress': 'string',
            'publicIpAddress': 'string',
            'ipv6Address': 'string',
            'hardware': {
                'cpuCount': 123,
                'disks': [
                    {
                        'name': 'string',
                        'arn': 'string',
                        'supportCode': 'string',
                        'createdAt': datetime(2015, 1, 1),
                        'location': {
                            'availabilityZone': 'string',
                            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
                        },
                        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
                        'tags': [
                            {
                                'key': 'string',
                                'value': 'string'
                            },
                        ],
                        'addOns': [
                            {
                                'name': 'string',
                                'status': 'string',
                                'snapshotTimeOfDay': 'string',
                                'nextSnapshotTimeOfDay': 'string'
                            },
                        ],
                        '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'|'icmp',
                        'accessFrom': 'string',
                        'accessType': 'Public'|'Private',
                        'commonName': 'string',
                        'accessDirection': 'inbound'|'outbound',
                        'cidrs': [
                            'string',
                        ],
                        'cidrListAliases': [
                            'string',
                        ]
                    },
                ]
            },
            '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 ) in Unix time format.
    - 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 ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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 ).
    - addOns (list) --
      
      An array of objects representing the add-ons enabled on the instance.
      - (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
    - 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 a 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 ).
        
        tags (list) --
        
        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        addOns (list) --
        
        An array of objects representing the add-ons enabled on the disk.
        
        (dict) --
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) --
        
        The name of the add-on.
        
        status (string) --
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) --
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) --
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        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 ports for an Amazon Lightsail instance.
        
        fromPort (integer) --
        
        The first port in a range of open ports on an instance.
        
        Allowed ports:
        
        TCP and UDP - 0 to 65535
        
        ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
        
        toPort (integer) --
        
        The last port in a range of open ports on an instance.
        
        Allowed ports:
        
        TCP and UDP - 0 to 65535
        
        ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
        
        protocol (string) --
        
        The IP protocol name.
        
        The name 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.
        
        icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
        
        accessFrom (string) --
        
        The location from which access is allowed. For example, Anywhere (0.0.0.0/0) , or Custom if a specific IP address or range of IP addresses is allowed.
        
        accessType (string) --
        
        The type of access ( Public or Private ).
        
        commonName (string) --
        
        The common name of the port information.
        
        accessDirection (string) --
        
        The access direction ( inbound or outbound ).
        
        Note
        
        Lightsail currently supports only inbound access direction.
        
        cidrs (list) --
        
        The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
        
        For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
        
        (string) --
        
        cidrListAliases (list) --
        
        An alias that defines access for a preconfigured range of IP addresses.
        
        The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
        
        (string) --
    - 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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

GetKeyPair (updated)

Link ¶
Changes (response)

{'keyPair': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        '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 ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - fingerprint (string) --
    
    The RSA fingerprint of the key pair.

GetKeyPairs (updated)

Link ¶
Changes (response)

{'keyPairs': {'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            '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 ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - fingerprint (string) --
      
      The RSA fingerprint of the key pair.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

GetLoadBalancer (updated)

Link ¶
Changes (response)

{'loadBalancer': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        '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 .
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - 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': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            '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
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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 validation 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 validation failure reason, if any, of the certificate.
      
      The following failure reasons are possible:
      - NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.
      - ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
      Note
      
      You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
      - DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
      - INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
      - OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
    - issuedAt (datetime) --
      
      The time when the SSL/TLS certificate was issued.
    - issuer (string) --
      
      The issuer of the certificate.
    - keyAlgorithm (string) --
      
      The algorithm 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 that describes the status of the certificate renewal managed by Lightsail.
      - renewalStatus (string) --
        
        The renewal status of the certificate.
        
        The following renewal status are possible:
        
        PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
        
        PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
        
        Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
        
        Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.
      - 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. This value is present only when the certificate status is REVOKED .
    - revokedAt (datetime) --
      
      The timestamp when the certificate was revoked. This value is present only when the certificate status is 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) --
      
      An array of strings that specify the alternate domains (e.g., example2.com ) and subdomains (e.g., blog.example.com ) for the certificate.
      - (string) --

GetLoadBalancers (updated)

Link ¶
Changes (response)

{'loadBalancers': {'resourceType': {'ContainerService'}}}

Returns information about all load balancers in an account.

See also: AWS API Documentation

Request Syntax

client.get_load_balancers(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            '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 .
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - 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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.

GetOperation (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            '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 objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.

GetOperationsForResource (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            '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 objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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 next page token parameter instead.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.

GetRelationalDatabase (updated)

Link ¶
Changes (response)

{'relationalDatabase': {'resourceType': {'ContainerService'}}}

Returns information about a specific database in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.get_relational_database(
    relationalDatabaseName='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of the database that you are looking up.

rtype

dict

returns

Response Syntax

{
    'relationalDatabase': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'relationalDatabaseBlueprintId': 'string',
        'relationalDatabaseBundleId': 'string',
        'masterDatabaseName': 'string',
        'hardware': {
            'cpuCount': 123,
            'diskSizeInGb': 123,
            'ramSizeInGb': ...
        },
        'state': 'string',
        'secondaryAvailabilityZone': 'string',
        'backupRetentionEnabled': True|False,
        'pendingModifiedValues': {
            'masterUserPassword': 'string',
            'engineVersion': 'string',
            'backupRetentionEnabled': True|False
        },
        'engine': 'string',
        'engineVersion': 'string',
        'latestRestorableTime': datetime(2015, 1, 1),
        'masterUsername': 'string',
        'parameterApplyStatus': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'publiclyAccessible': True|False,
        'masterEndpoint': {
            'port': 123,
            'address': 'string'
        },
        'pendingMaintenanceActions': [
            {
                'action': 'string',
                'description': 'string',
                'currentApplyDate': datetime(2015, 1, 1)
            },
        ],
        'caCertificateIdentifier': 'string'
    }
}

Response Structure

(dict) --
- relationalDatabase (dict) --
  
  An object describing the specified database.
  - name (string) --
    
    The unique name of the database resource in Lightsail.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the database.
  - supportCode (string) --
    
    The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) --
    
    The timestamp when the database was created. Formatted in Unix time.
  - location (dict) --
    
    The Region name and Availability Zone where the database 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 for the database (for example, RelationalDatabase ).
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - relationalDatabaseBlueprintId (string) --
    
    The blueprint ID for the database. A blueprint describes the major engine version of a database.
  - relationalDatabaseBundleId (string) --
    
    The bundle ID for the database. A bundle describes the performance specifications for your database.
  - masterDatabaseName (string) --
    
    The name of the master database created when the Lightsail database resource is created.
  - hardware (dict) --
    
    Describes the hardware of the database.
    - cpuCount (integer) --
      
      The number of vCPUs for the database.
    - diskSizeInGb (integer) --
      
      The size of the disk for the database.
    - ramSizeInGb (float) --
      
      The amount of RAM in GB for the database.
  - state (string) --
    
    Describes the current state of the database.
  - secondaryAvailabilityZone (string) --
    
    Describes the secondary Availability Zone of a high availability database.
    
    The secondary database is used for failover support of a high availability database.
  - backupRetentionEnabled (boolean) --
    
    A Boolean value indicating whether automated backup retention is enabled for the database.
  - pendingModifiedValues (dict) --
    
    Describes pending database value modifications.
    - masterUserPassword (string) --
      
      The password for the master user of the database.
    - engineVersion (string) --
      
      The database engine version.
    - backupRetentionEnabled (boolean) --
      
      A Boolean value indicating whether automated backup retention is enabled.
  - engine (string) --
    
    The database software (for example, MySQL ).
  - engineVersion (string) --
    
    The database engine version (for example, 5.7.23 ).
  - latestRestorableTime (datetime) --
    
    The latest point in time to which the database can be restored. Formatted in Unix time.
  - masterUsername (string) --
    
    The master user name of the database.
  - parameterApplyStatus (string) --
    
    The status of parameter updates for the database.
  - preferredBackupWindow (string) --
    
    The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ).
  - preferredMaintenanceWindow (string) --
    
    The weekly time range during which system maintenance can occur on the database.
    
    In the format ddd:hh24:mi-ddd:hh24:mi . For example, Tue:17:00-Tue:17:30 .
  - publiclyAccessible (boolean) --
    
    A Boolean value indicating whether the database is publicly accessible.
  - masterEndpoint (dict) --
    
    The master endpoint for the database.
    - port (integer) --
      
      Specifies the port that the database is listening on.
    - address (string) --
      
      Specifies the DNS address of the database.
  - pendingMaintenanceActions (list) --
    
    Describes the pending maintenance actions for the database.
    - (dict) --
      
      Describes a pending database maintenance action.
      - action (string) --
        
        The type of pending database maintenance action.
      - description (string) --
        
        Additional detail about the pending database maintenance action.
      - currentApplyDate (datetime) --
        
        The effective date of the pending database maintenance action.
  - caCertificateIdentifier (string) --
    
    The certificate associated with the database.

GetRelationalDatabaseSnapshot (updated)

Link ¶
Changes (response)

{'relationalDatabaseSnapshot': {'resourceType': {'ContainerService'}}}

Returns information about a specific database snapshot in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.get_relational_database_snapshot(
    relationalDatabaseSnapshotName='string'
)

type relationalDatabaseSnapshotName

string

param relationalDatabaseSnapshotName

[REQUIRED]

The name of the database snapshot for which to get information.

rtype

dict

returns

Response Syntax

{
    'relationalDatabaseSnapshot': {
        'name': 'string',
        'arn': 'string',
        'supportCode': 'string',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'engine': 'string',
        'engineVersion': 'string',
        'sizeInGb': 123,
        'state': 'string',
        'fromRelationalDatabaseName': 'string',
        'fromRelationalDatabaseArn': 'string',
        'fromRelationalDatabaseBundleId': 'string',
        'fromRelationalDatabaseBlueprintId': 'string'
    }
}

Response Structure

(dict) --
- relationalDatabaseSnapshot (dict) --
  
  An object describing the specified database snapshot.
  - name (string) --
    
    The name of the database snapshot.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the database snapshot.
  - supportCode (string) --
    
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - createdAt (datetime) --
    
    The timestamp when the database snapshot was created.
  - location (dict) --
    
    The Region name and Availability Zone where the database snapshot 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.
  - tags (list) --
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    - (dict) --
      
      Describes a tag key and optional value assigned to an Amazon Lightsail resource.
      
      For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
      - value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
  - engine (string) --
    
    The software of the database snapshot (for example, MySQL )
  - engineVersion (string) --
    
    The database engine version for the database snapshot (for example, 5.7.23 ).
  - sizeInGb (integer) --
    
    The size of the disk in GB (for example, 32 ) for the database snapshot.
  - state (string) --
    
    The state of the database snapshot.
  - fromRelationalDatabaseName (string) --
    
    The name of the source database from which the database snapshot was created.
  - fromRelationalDatabaseArn (string) --
    
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
  - fromRelationalDatabaseBundleId (string) --
    
    The bundle ID of the database from which the database snapshot was created.
  - fromRelationalDatabaseBlueprintId (string) --
    
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

GetRelationalDatabaseSnapshots (updated)

Link ¶
Changes (response)

{'relationalDatabaseSnapshots': {'resourceType': {'ContainerService'}}}

Returns information about all of your database snapshots in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.get_relational_database_snapshots(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'relationalDatabaseSnapshots': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'engine': 'string',
            'engineVersion': 'string',
            'sizeInGb': 123,
            'state': 'string',
            'fromRelationalDatabaseName': 'string',
            'fromRelationalDatabaseArn': 'string',
            'fromRelationalDatabaseBundleId': 'string',
            'fromRelationalDatabaseBlueprintId': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- relationalDatabaseSnapshots (list) --
  
  An object describing the result of your get relational database snapshots request.
  - (dict) --
    
    Describes a database snapshot.
    - name (string) --
      
      The name of the database snapshot.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the database snapshot.
    - supportCode (string) --
      
      The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The timestamp when the database snapshot was created.
    - location (dict) --
      
      The Region name and Availability Zone where the database snapshot 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.
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - engine (string) --
      
      The software of the database snapshot (for example, MySQL )
    - engineVersion (string) --
      
      The database engine version for the database snapshot (for example, 5.7.23 ).
    - sizeInGb (integer) --
      
      The size of the disk in GB (for example, 32 ) for the database snapshot.
    - state (string) --
      
      The state of the database snapshot.
    - fromRelationalDatabaseName (string) --
      
      The name of the source database from which the database snapshot was created.
    - fromRelationalDatabaseArn (string) --
      
      The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    - fromRelationalDatabaseBundleId (string) --
      
      The bundle ID of the database from which the database snapshot was created.
    - fromRelationalDatabaseBlueprintId (string) --
      
      The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

GetRelationalDatabases (updated)

Link ¶
Changes (response)

{'relationalDatabases': {'resourceType': {'ContainerService'}}}

Returns information about all of your databases in Amazon Lightsail.

See also: AWS API Documentation

Request Syntax

client.get_relational_databases(
    pageToken='string'
)

type pageToken

string

param pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

rtype

dict

returns

Response Syntax

{
    'relationalDatabases': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'relationalDatabaseBlueprintId': 'string',
            'relationalDatabaseBundleId': 'string',
            'masterDatabaseName': 'string',
            'hardware': {
                'cpuCount': 123,
                'diskSizeInGb': 123,
                'ramSizeInGb': ...
            },
            'state': 'string',
            'secondaryAvailabilityZone': 'string',
            'backupRetentionEnabled': True|False,
            'pendingModifiedValues': {
                'masterUserPassword': 'string',
                'engineVersion': 'string',
                'backupRetentionEnabled': True|False
            },
            'engine': 'string',
            'engineVersion': 'string',
            'latestRestorableTime': datetime(2015, 1, 1),
            'masterUsername': 'string',
            'parameterApplyStatus': 'string',
            'preferredBackupWindow': 'string',
            'preferredMaintenanceWindow': 'string',
            'publiclyAccessible': True|False,
            'masterEndpoint': {
                'port': 123,
                'address': 'string'
            },
            'pendingMaintenanceActions': [
                {
                    'action': 'string',
                    'description': 'string',
                    'currentApplyDate': datetime(2015, 1, 1)
                },
            ],
            'caCertificateIdentifier': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) --
- relationalDatabases (list) --
  
  An object describing the result of your get relational databases request.
  - (dict) --
    
    Describes a database.
    - name (string) --
      
      The unique name of the database resource in Lightsail.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the database.
    - supportCode (string) --
      
      The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) --
      
      The timestamp when the database was created. Formatted in Unix time.
    - location (dict) --
      
      The Region name and Availability Zone where the database 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 for the database (for example, RelationalDatabase ).
    - tags (list) --
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
      - (dict) --
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Lightsail Dev Guide.
        
        key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) --
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - relationalDatabaseBlueprintId (string) --
      
      The blueprint ID for the database. A blueprint describes the major engine version of a database.
    - relationalDatabaseBundleId (string) --
      
      The bundle ID for the database. A bundle describes the performance specifications for your database.
    - masterDatabaseName (string) --
      
      The name of the master database created when the Lightsail database resource is created.
    - hardware (dict) --
      
      Describes the hardware of the database.
      - cpuCount (integer) --
        
        The number of vCPUs for the database.
      - diskSizeInGb (integer) --
        
        The size of the disk for the database.
      - ramSizeInGb (float) --
        
        The amount of RAM in GB for the database.
    - state (string) --
      
      Describes the current state of the database.
    - secondaryAvailabilityZone (string) --
      
      Describes the secondary Availability Zone of a high availability database.
      
      The secondary database is used for failover support of a high availability database.
    - backupRetentionEnabled (boolean) --
      
      A Boolean value indicating whether automated backup retention is enabled for the database.
    - pendingModifiedValues (dict) --
      
      Describes pending database value modifications.
      - masterUserPassword (string) --
        
        The password for the master user of the database.
      - engineVersion (string) --
        
        The database engine version.
      - backupRetentionEnabled (boolean) --
        
        A Boolean value indicating whether automated backup retention is enabled.
    - engine (string) --
      
      The database software (for example, MySQL ).
    - engineVersion (string) --
      
      The database engine version (for example, 5.7.23 ).
    - latestRestorableTime (datetime) --
      
      The latest point in time to which the database can be restored. Formatted in Unix time.
    - masterUsername (string) --
      
      The master user name of the database.
    - parameterApplyStatus (string) --
      
      The status of parameter updates for the database.
    - preferredBackupWindow (string) --
      
      The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ).
    - preferredMaintenanceWindow (string) --
      
      The weekly time range during which system maintenance can occur on the database.
      
      In the format ddd:hh24:mi-ddd:hh24:mi . For example, Tue:17:00-Tue:17:30 .
    - publiclyAccessible (boolean) --
      
      A Boolean value indicating whether the database is publicly accessible.
    - masterEndpoint (dict) --
      
      The master endpoint for the database.
      - port (integer) --
        
        Specifies the port that the database is listening on.
      - address (string) --
        
        Specifies the DNS address of the database.
    - pendingMaintenanceActions (list) --
      
      Describes the pending maintenance actions for the database.
      - (dict) --
        
        Describes a pending database maintenance action.
        
        action (string) --
        
        The type of pending database maintenance action.
        
        description (string) --
        
        Additional detail about the pending database maintenance action.
        
        currentApplyDate (datetime) --
        
        The effective date of the pending database maintenance action.
    - caCertificateIdentifier (string) --
      
      The certificate associated with the database.
- nextPageToken (string) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.

GetStaticIp (updated)

Link ¶
Changes (response)

{'staticIp': {'resourceType': {'ContainerService'}}}

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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        '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': {'resourceType': {'ContainerService'}}}

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

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            '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) --
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.

ImportKeyPair (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

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

type portInfo

dict

param portInfo

[REQUIRED]

An object to describe the ports to open for the specified instance.

fromPort (integer) --

The first port in a range of open ports on an instance.

Allowed ports:
- TCP and UDP - 0 to 65535
- ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
toPort (integer) --

The last port in a range of open ports on an instance.

Allowed ports:
- TCP and UDP - 0 to 65535
- ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
protocol (string) --

The IP protocol name.

The name 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.
- icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
cidrs (list) --

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:
- To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
- To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
- (string) --
cidrListAliases (list) --

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
- (string) --

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance for which to open ports.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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.

PutAlarm (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Creates or updates an alarm, and associates it with the specified metric.

When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

See also: AWS API Documentation

Request Syntax

client.put_alarm(
    alarmName='string',
    metricName='CPUUtilization'|'NetworkIn'|'NetworkOut'|'StatusCheckFailed'|'StatusCheckFailed_Instance'|'StatusCheckFailed_System'|'ClientTLSNegotiationErrorCount'|'HealthyHostCount'|'UnhealthyHostCount'|'HTTPCode_LB_4XX_Count'|'HTTPCode_LB_5XX_Count'|'HTTPCode_Instance_2XX_Count'|'HTTPCode_Instance_3XX_Count'|'HTTPCode_Instance_4XX_Count'|'HTTPCode_Instance_5XX_Count'|'InstanceResponseTime'|'RejectedConnectionCount'|'RequestCount'|'DatabaseConnections'|'DiskQueueDepth'|'FreeStorageSpace'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'BurstCapacityTime'|'BurstCapacityPercentage',
    monitoredResourceName='string',
    comparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    threshold=123.0,
    evaluationPeriods=123,
    datapointsToAlarm=123,
    treatMissingData='breaching'|'notBreaching'|'ignore'|'missing',
    contactProtocols=[
        'Email'|'SMS',
    ],
    notificationTriggers=[
        'OK'|'ALARM'|'INSUFFICIENT_DATA',
    ],
    notificationEnabled=True|False
)

type alarmName

string

param alarmName

[REQUIRED]

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

type metricName

string

param metricName

[REQUIRED]

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

Instances : BurstCapacityPercentage , BurstCapacityTime , CPUUtilization , NetworkIn , NetworkOut , StatusCheckFailed , StatusCheckFailed_Instance , and StatusCheckFailed_System .
Load balancers : ClientTLSNegotiationErrorCount , HealthyHostCount , UnhealthyHostCount , HTTPCode_LB_4XX_Count , HTTPCode_LB_5XX_Count , HTTPCode_Instance_2XX_Count , HTTPCode_Instance_3XX_Count , HTTPCode_Instance_4XX_Count , HTTPCode_Instance_5XX_Count , InstanceResponseTime , RejectedConnectionCount , and RequestCount .
Relational databases : CPUUtilization , DatabaseConnections , DiskQueueDepth , FreeStorageSpace , NetworkReceiveThroughput , and NetworkTransmitThroughput .

For more information about these metrics, see Metrics available in Lightsail.

type monitoredResourceName

string

param monitoredResourceName

[REQUIRED]

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

type comparisonOperator

string

param comparisonOperator

[REQUIRED]

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

type threshold

float

param threshold

[REQUIRED]

The value against which the specified statistic is compared.

type evaluationPeriods

integer

param evaluationPeriods

[REQUIRED]

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value ( evaluationPeriods ) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

type datapointsToAlarm

integer

param datapointsToAlarm

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value ( datapointsToAlarm ) is the M.

type treatMissingData

string

param treatMissingData

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
ignore - Ignore the missing data. Maintains the current alarm state.
missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

type contactProtocols

list

param contactProtocols

The contact protocols to use for the alarm, such as Email , SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

(string) --

type notificationTriggers

list

param notificationTriggers

The alarm states that trigger a notification.

An alarm has the following possible states:

ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.
If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

(string) --

type notificationEnabled

boolean

param notificationEnabled

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPorts request. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

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

type portInfos

list

param portInfos

[REQUIRED]

An array of objects to describe the ports to open for the specified instance.

(dict) --

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
- fromPort (integer) --
  
  The first port in a range of open ports on an instance.
  
  Allowed ports:
  - TCP and UDP - 0 to 65535
  - ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
- toPort (integer) --
  
  The last port in a range of open ports on an instance.
  
  Allowed ports:
  - TCP and UDP - 0 to 65535
  - ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .
- protocol (string) --
  
  The IP protocol name.
  
  The name 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.
  - icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
- cidrs (list) --
  
  The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.
  
  Examples:
  - To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 .
  - To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
  For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
  - (string) --
- cidrListAliases (list) --
  
  An alias that defines access for a preconfigured range of IP addresses.
  
  The only alias currently supported is lightsail-connect , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
  - (string) --

type instanceName

string

param instanceName

[REQUIRED]

The name of the instance for which to open ports.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

RebootRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.reboot_relational_database(
    relationalDatabaseName='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of your database to reboot.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

ResetDistributionCache (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

See also: AWS API Documentation

Request Syntax

client.reset_distribution_cache(
    distributionName='string'
)

type distributionName

string

param distributionName

The name of the distribution for which to reset cache.

Use the GetDistributions action to get a list of distribution names that you can specify.

rtype

dict

returns

Response Syntax

{
    'status': 'string',
    'createTime': datetime(2015, 1, 1),
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- status (string) --
  
  The status of the reset cache request.
- createTime (datetime) --
  
  The timestamp of the reset cache request (e.g., 1479734909.17 ) in Unix time format.
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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.

SendContactMethodVerification (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Warning

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

See also: AWS API Documentation

Request Syntax

client.send_contact_method_verification(
    protocol='Email'
)

type protocol

string

param protocol

[REQUIRED]

The protocol to verify, such as Email or SMS (text messaging).

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

Note

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

StartRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.start_relational_database(
    relationalDatabaseName='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of your database to start.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Stops a specific Amazon Lightsail instance that is currently running.

Note

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

StopRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.stop_relational_database(
    relationalDatabaseName='string',
    relationalDatabaseSnapshotName='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of your database to stop.

type relationalDatabaseSnapshotName

string

param relationalDatabaseSnapshotName

The name of your new database snapshot to be created before stopping your database.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

TagResource (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceName='string',
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type resourceName

string

param resourceName

[REQUIRED]

The name of the resource to which you are adding tags.

type resourceArn

string

param resourceArn

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

type tags

list

param tags

[REQUIRED]

The tag key and optional value.

(dict) --

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.
- key (string) --
  
  The key of the tag.
  
  Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
- value (string) --
  
  The value of the tag.
  
  Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

TestAlarm (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol ( Email and/or SMS ) configured for the alarm.

See also: AWS API Documentation

Request Syntax

client.test_alarm(
    alarmName='string',
    state='OK'|'ALARM'|'INSUFFICIENT_DATA'
)

type alarmName

string

param alarmName

[REQUIRED]

The name of the alarm to test.

type state

string

param state

[REQUIRED]

The alarm state to test.

An alarm has the following possible states that can be tested:

ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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.

UntagResource (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name . For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceName='string',
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceName

string

param resourceName

[REQUIRED]

The name of the resource from which you are removing a tag.

type resourceArn

string

param resourceArn

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

type tagKeys

list

param tagKeys

[REQUIRED]

The tag keys to delete from the specified resource.

(string) --

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

UpdateDistribution (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution

See also: AWS API Documentation

Request Syntax

client.update_distribution(
    distributionName='string',
    origin={
        'name': 'string',
        'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2',
        'protocolPolicy': 'http-only'|'https-only'
    },
    defaultCacheBehavior={
        'behavior': 'dont-cache'|'cache'
    },
    cacheBehaviorSettings={
        'defaultTTL': 123,
        'minimumTTL': 123,
        'maximumTTL': 123,
        'allowedHTTPMethods': 'string',
        'cachedHTTPMethods': 'string',
        'forwardedCookies': {
            'option': 'none'|'allow-list'|'all',
            'cookiesAllowList': [
                'string',
            ]
        },
        'forwardedHeaders': {
            'option': 'none'|'allow-list'|'all',
            'headersAllowList': [
                'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
            ]
        },
        'forwardedQueryStrings': {
            'option': True|False,
            'queryStringsAllowList': [
                'string',
            ]
        }
    },
    cacheBehaviors=[
        {
            'path': 'string',
            'behavior': 'dont-cache'|'cache'
        },
    ],
    isEnabled=True|False
)

type distributionName

string

param distributionName

[REQUIRED]

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

type origin

dict

param origin

An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.

The distribution pulls, caches, and serves content from the origin.

name (string) --

The name of the origin resource.
regionName (string) --

The AWS Region name of the origin resource.
protocolPolicy (string) --

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

type defaultCacheBehavior

dict

param defaultCacheBehavior

An object that describes the default cache behavior for the distribution.

behavior (string) --

The cache behavior of the distribution.

The following cache behaviors can be specified:
- cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
- dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

type cacheBehaviorSettings

dict

param cacheBehaviorSettings

An object that describes the cache behavior settings for the distribution.

Note

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

defaultTTL (integer) --

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

Note

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
minimumTTL (integer) --

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects.
allowedHTTPMethods (string) --

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:
- GET,HEAD - The distribution forwards the GET and HEAD methods.
- GET,HEAD,OPTIONS - The distribution forwards the GET , HEAD , and OPTIONS methods.
- GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET , HEAD , OPTIONS , PUT , PATCH , POST , and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --

The HTTP method responses that are cached by your distribution.

You can specify the following options:
- GET,HEAD - The distribution caches responses to the GET and HEAD methods.
- GET,HEAD,OPTIONS - The distribution caches responses to the GET , HEAD , and OPTIONS methods.
forwardedCookies (dict) --

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
- option (string) --
  
  Specifies which cookies to forward to the distribution's origin for a cache behavior: all , none , or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
- cookiesAllowList (list) --
  
  The specific cookies to forward to your distribution's origin.
  - (string) --
forwardedHeaders (dict) --

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
- option (string) --
  
  The headers that you want your distribution to forward to your origin and base caching on.
  
  You can configure your distribution to do one of the following:
  - all - Forward all headers to your origin.
  - none - Forward only the default headers.
  - allow-list - Forward only the headers you specify using the headersAllowList parameter.
- headersAllowList (list) --
  
  The specific headers to forward to your distribution's origin.
  - (string) --
forwardedQueryStrings (dict) --

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
- option (boolean) --
  
  Indicates whether the distribution forwards and caches based on query strings.
- queryStringsAllowList (list) --
  
  The specific query strings that the distribution forwards to the origin.
  
  Your distribution will cache content based on the specified query strings.
  
  If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
  - (string) --

type cacheBehaviors

list

param cacheBehaviors

An array of objects that describe the per-path cache behavior for the distribution.

(dict) --

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache , then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

if the cacheBehavior's behavior is set to 'cache', then
- path (string) --
  
  The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/* ), and file types ( *.html, *jpg, *js ). Directories and file paths are case-sensitive.
  
  Examples:
  - Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
  - Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
  - Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
  - Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
- behavior (string) --
  
  The cache behavior for the specified path.
  
  You can specify one of the following per-path cache behaviors:
  - cache - This behavior caches the specified path.
  - dont-cache - This behavior doesn't cache the specified path.

type isEnabled

boolean

param isEnabled

Indicates whether to enable the distribution.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- operation (dict) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - 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 AWS 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.

UpdateDistributionBundle (updated)

Link ¶
Changes (response)

{'operation': {'operationType': {'CreateContainerService',
                                 'CreateContainerServiceDeployment',
                                 'CreateContainerServiceRegistryLogin',
                                 'DeleteContainerImage',
                                 'DeleteContainerService',
                                 'RegisterContainerImage',
                                 'UpdateContainerService'},
               'resourceType': {'ContainerService'}}}

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.

Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

See also: AWS API Documentation

Request Syntax

client.update_distribution_bundle(
    distributionName='string',
    bundleId='string'
)

type distributionName

string

param distributionName

The name of the distribution for which to update the bundle.

Use the GetDistributions action to get a list of distribution names that you can specify.

type bundleId

string

param bundleId

The bundle ID of the new bundle to apply to your distribution.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

rtype

dict

returns

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) --
- 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 AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Lightsail Dev Guide.

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, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:
- A
- CNAME
- MX
- NS
- SOA
- SRV
- TXT
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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

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

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name . For more information, see the Lightsail Dev Guide.

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': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

UpdateRelationalDatabase (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.update_relational_database(
    relationalDatabaseName='string',
    masterUserPassword='string',
    rotateMasterUserPassword=True|False,
    preferredBackupWindow='string',
    preferredMaintenanceWindow='string',
    enableBackupRetention=True|False,
    disableBackupRetention=True|False,
    publiclyAccessible=True|False,
    applyImmediately=True|False,
    caCertificateIdentifier='string'
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of your database to update.

type masterUserPassword

string

param masterUserPassword

The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain 8 to 41 characters.

type rotateMasterUserPassword

boolean

param rotateMasterUserPassword

When true , the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

type preferredBackupWindow

string

param preferredBackupWindow

The daily time range during which automated backups are created for your database if automated backups are enabled.

Constraints:

Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30
Specified in Coordinated Universal Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

type preferredMaintenanceWindow

string

param preferredMaintenanceWindow

The weekly time range during which system maintenance can occur on your database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

Must be in the ddd:hh24:mi-ddd:hh24:mi format.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be at least 30 minutes.
Specified in Coordinated Universal Time (UTC).
Example: Tue:17:00-Tue:17:30

type enableBackupRetention

boolean

param enableBackupRetention

When true , enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

type disableBackupRetention

boolean

param disableBackupRetention

When true , disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

type publiclyAccessible

boolean

param publiclyAccessible

Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

type applyImmediately

boolean

param applyImmediately

When true , applies changes immediately. When false , applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

type caCertificateIdentifier

string

param caCertificateIdentifier

Indicates the certificate that needs to be associated with the database.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.

UpdateRelationalDatabaseParameters (updated)

Link ¶
Changes (response)

{'operations': {'operationType': {'CreateContainerService',
                                  'CreateContainerServiceDeployment',
                                  'CreateContainerServiceRegistryLogin',
                                  'DeleteContainerImage',
                                  'DeleteContainerService',
                                  'RegisterContainerImage',
                                  'UpdateContainerService'},
                'resourceType': {'ContainerService'}}}

Allows the update of one or more parameters of a database in Amazon Lightsail.

Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot . Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

See also: AWS API Documentation

Request Syntax

client.update_relational_database_parameters(
    relationalDatabaseName='string',
    parameters=[
        {
            'allowedValues': 'string',
            'applyMethod': 'string',
            'applyType': 'string',
            'dataType': 'string',
            'description': 'string',
            'isModifiable': True|False,
            'parameterName': 'string',
            'parameterValue': 'string'
        },
    ]
)

type relationalDatabaseName

string

param relationalDatabaseName

[REQUIRED]

The name of your database for which to update parameters.

type parameters

list

param parameters

[REQUIRED]

The database parameters to update.

(dict) --

Describes the parameters of a database.
- allowedValues (string) --
  
  Specifies the valid range of values for the parameter.
- applyMethod (string) --
  
  Indicates when parameter updates are applied.
  
  Can be immediate or pending-reboot .
- applyType (string) --
  
  Specifies the engine-specific parameter type.
- dataType (string) --
  
  Specifies the valid data type for the parameter.
- description (string) --
  
  Provides a description of the parameter.
- isModifiable (boolean) --
  
  A Boolean value indicating whether the parameter can be modified.
- parameterName (string) --
  
  Specifies the name of the parameter.
- parameterValue (string) --
  
  Specifies the value of the parameter.

rtype

dict

returns

Response Syntax

{
    'operations': [
        {
            'id': 'string',
            'resourceName': 'string',
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'
            },
            'isTerminal': True|False,
            'operationDetails': 'string',
            'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage',
            'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
            'statusChangedAt': datetime(2015, 1, 1),
            'errorCode': 'string',
            'errorDetails': 'string'
        },
    ]
}

Response Structure

(dict) --
- operations (list) --
  
  An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
  - (dict) --
    
    Describes the API operation.
    - id (string) --
      
      The ID of the operation.
    - resourceName (string) --
      
      The resource name.
    - resourceType (string) --
      
      The resource type.
    - createdAt (datetime) --
      
      The timestamp when the operation was initialized (e.g., 1479816991.349 ).
    - location (dict) --
      
      The AWS 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.