LightsailClient#
Auto-generated documentation for Lightsail type annotations stubs module mypy-boto3-lightsail.
LightsailClient#
Type annotations and code completion for boto3.client("lightsail")
.
boto3 documentation
# LightsailClient usage example
from boto3.session import Session
from mypy_boto3_lightsail.client import LightsailClient
def get_lightsail_client() -> LightsailClient:
return Session().client("lightsail")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("lightsail").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("lightsail")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.AccountSetupInProgressException,
client.exceptions.ClientError,
client.exceptions.InvalidInputException,
client.exceptions.NotFoundException,
client.exceptions.OperationFailureException,
client.exceptions.ServiceException,
client.exceptions.UnauthenticatedException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_lightsail.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
allocate_static_ip#
Allocates a static IP address.
Type annotations and code completion for boto3.client("lightsail").allocate_static_ip
method.
boto3 documentation
# allocate_static_ip method definition
def allocate_static_ip(
self,
*,
staticIpName: str,
) -> AllocateStaticIpResultTypeDef: # (1)
...
# allocate_static_ip method usage example with argument unpacking
kwargs: AllocateStaticIpRequestRequestTypeDef = { # (1)
"staticIpName": ...,
}
parent.allocate_static_ip(**kwargs)
attach_certificate_to_distribution#
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
Type annotations and code completion for boto3.client("lightsail").attach_certificate_to_distribution
method.
boto3 documentation
# attach_certificate_to_distribution method definition
def attach_certificate_to_distribution(
self,
*,
distributionName: str,
certificateName: str,
) -> AttachCertificateToDistributionResultTypeDef: # (1)
...
# attach_certificate_to_distribution method usage example with argument unpacking
kwargs: AttachCertificateToDistributionRequestRequestTypeDef = { # (1)
"distributionName": ...,
"certificateName": ...,
}
parent.attach_certificate_to_distribution(**kwargs)
attach_disk#
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
Type annotations and code completion for boto3.client("lightsail").attach_disk
method.
boto3 documentation
# attach_disk method definition
def attach_disk(
self,
*,
diskName: str,
instanceName: str,
diskPath: str,
autoMounting: bool = ...,
) -> AttachDiskResultTypeDef: # (1)
...
# attach_disk method usage example with argument unpacking
kwargs: AttachDiskRequestRequestTypeDef = { # (1)
"diskName": ...,
"instanceName": ...,
"diskPath": ...,
}
parent.attach_disk(**kwargs)
attach_instances_to_load_balancer#
Attaches one or more Lightsail instances to a load balancer.
Type annotations and code completion for boto3.client("lightsail").attach_instances_to_load_balancer
method.
boto3 documentation
# attach_instances_to_load_balancer method definition
def attach_instances_to_load_balancer(
self,
*,
loadBalancerName: str,
instanceNames: Sequence[str],
) -> AttachInstancesToLoadBalancerResultTypeDef: # (1)
...
# attach_instances_to_load_balancer method usage example with argument unpacking
kwargs: AttachInstancesToLoadBalancerRequestRequestTypeDef = { # (1)
"loadBalancerName": ...,
"instanceNames": ...,
}
parent.attach_instances_to_load_balancer(**kwargs)
attach_load_balancer_tls_certificate#
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
Type annotations and code completion for boto3.client("lightsail").attach_load_balancer_tls_certificate
method.
boto3 documentation
# attach_load_balancer_tls_certificate method definition
def attach_load_balancer_tls_certificate(
self,
*,
loadBalancerName: str,
certificateName: str,
) -> AttachLoadBalancerTlsCertificateResultTypeDef: # (1)
...
# attach_load_balancer_tls_certificate method usage example with argument unpacking
kwargs: AttachLoadBalancerTlsCertificateRequestRequestTypeDef = { # (1)
"loadBalancerName": ...,
"certificateName": ...,
}
parent.attach_load_balancer_tls_certificate(**kwargs)
attach_static_ip#
Attaches a static IP address to a specific Amazon Lightsail instance.
Type annotations and code completion for boto3.client("lightsail").attach_static_ip
method.
boto3 documentation
# attach_static_ip method definition
def attach_static_ip(
self,
*,
staticIpName: str,
instanceName: str,
) -> AttachStaticIpResultTypeDef: # (1)
...
# attach_static_ip method usage example with argument unpacking
kwargs: AttachStaticIpRequestRequestTypeDef = { # (1)
"staticIpName": ...,
"instanceName": ...,
}
parent.attach_static_ip(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("lightsail").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("lightsail").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
close_instance_public_ports#
Closes ports for a specific Amazon Lightsail instance.
Type annotations and code completion for boto3.client("lightsail").close_instance_public_ports
method.
boto3 documentation
# close_instance_public_ports method definition
def close_instance_public_ports(
self,
*,
portInfo: PortInfoTypeDef, # (1)
instanceName: str,
) -> CloseInstancePublicPortsResultTypeDef: # (2)
...
# close_instance_public_ports method usage example with argument unpacking
kwargs: CloseInstancePublicPortsRequestRequestTypeDef = { # (1)
"portInfo": ...,
"instanceName": ...,
}
parent.close_instance_public_ports(**kwargs)
copy_snapshot#
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.
Type annotations and code completion for boto3.client("lightsail").copy_snapshot
method.
boto3 documentation
# copy_snapshot method definition
def copy_snapshot(
self,
*,
targetSnapshotName: str,
sourceRegion: RegionNameType, # (1)
sourceSnapshotName: str = ...,
sourceResourceName: str = ...,
restoreDate: str = ...,
useLatestRestorableAutoSnapshot: bool = ...,
) -> CopySnapshotResultTypeDef: # (2)
...
# copy_snapshot method usage example with argument unpacking
kwargs: CopySnapshotRequestRequestTypeDef = { # (1)
"targetSnapshotName": ...,
"sourceRegion": ...,
}
parent.copy_snapshot(**kwargs)
create_bucket#
Creates an Amazon Lightsail bucket.
Type annotations and code completion for boto3.client("lightsail").create_bucket
method.
boto3 documentation
# create_bucket method definition
def create_bucket(
self,
*,
bucketName: str,
bundleId: str,
tags: Sequence[TagTypeDef] = ..., # (1)
enableObjectVersioning: bool = ...,
) -> CreateBucketResultTypeDef: # (2)
...
- See TagTypeDef
- See CreateBucketResultTypeDef
# create_bucket method usage example with argument unpacking
kwargs: CreateBucketRequestRequestTypeDef = { # (1)
"bucketName": ...,
"bundleId": ...,
}
parent.create_bucket(**kwargs)
create_bucket_access_key#
Creates a new access key for the specified Amazon Lightsail bucket.
Type annotations and code completion for boto3.client("lightsail").create_bucket_access_key
method.
boto3 documentation
# create_bucket_access_key method definition
def create_bucket_access_key(
self,
*,
bucketName: str,
) -> CreateBucketAccessKeyResultTypeDef: # (1)
...
# create_bucket_access_key method usage example with argument unpacking
kwargs: CreateBucketAccessKeyRequestRequestTypeDef = { # (1)
"bucketName": ...,
}
parent.create_bucket_access_key(**kwargs)
create_certificate#
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
Type annotations and code completion for boto3.client("lightsail").create_certificate
method.
boto3 documentation
# create_certificate method definition
def create_certificate(
self,
*,
certificateName: str,
domainName: str,
subjectAlternativeNames: Sequence[str] = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateCertificateResultTypeDef: # (2)
...
# create_certificate method usage example with argument unpacking
kwargs: CreateCertificateRequestRequestTypeDef = { # (1)
"certificateName": ...,
"domainName": ...,
}
parent.create_certificate(**kwargs)
create_cloud_formation_stack#
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.
Type annotations and code completion for boto3.client("lightsail").create_cloud_formation_stack
method.
boto3 documentation
# create_cloud_formation_stack method definition
def create_cloud_formation_stack(
self,
*,
instances: Sequence[InstanceEntryTypeDef], # (1)
) -> CreateCloudFormationStackResultTypeDef: # (2)
...
# create_cloud_formation_stack method usage example with argument unpacking
kwargs: CreateCloudFormationStackRequestRequestTypeDef = { # (1)
"instances": ...,
}
parent.create_cloud_formation_stack(**kwargs)
create_contact_method#
Creates an email or SMS text message contact method.
Type annotations and code completion for boto3.client("lightsail").create_contact_method
method.
boto3 documentation
# create_contact_method method definition
def create_contact_method(
self,
*,
protocol: ContactProtocolType, # (1)
contactEndpoint: str,
) -> CreateContactMethodResultTypeDef: # (2)
...
# create_contact_method method usage example with argument unpacking
kwargs: CreateContactMethodRequestRequestTypeDef = { # (1)
"protocol": ...,
"contactEndpoint": ...,
}
parent.create_contact_method(**kwargs)
create_container_service#
Creates an Amazon Lightsail container service.
Type annotations and code completion for boto3.client("lightsail").create_container_service
method.
boto3 documentation
# create_container_service method definition
def create_container_service(
self,
*,
serviceName: str,
power: ContainerServicePowerNameType, # (1)
scale: int,
tags: Sequence[TagTypeDef] = ..., # (2)
publicDomainNames: Mapping[str, Sequence[str]] = ...,
deployment: ContainerServiceDeploymentRequestTypeDef = ..., # (3)
privateRegistryAccess: PrivateRegistryAccessRequestTypeDef = ..., # (4)
) -> CreateContainerServiceResultTypeDef: # (5)
...
- See ContainerServicePowerNameType
- See TagTypeDef
- See ContainerServiceDeploymentRequestTypeDef
- See PrivateRegistryAccessRequestTypeDef
- See CreateContainerServiceResultTypeDef
# create_container_service method usage example with argument unpacking
kwargs: CreateContainerServiceRequestRequestTypeDef = { # (1)
"serviceName": ...,
"power": ...,
"scale": ...,
}
parent.create_container_service(**kwargs)
create_container_service_deployment#
Creates a deployment for your Amazon Lightsail container service.
Type annotations and code completion for boto3.client("lightsail").create_container_service_deployment
method.
boto3 documentation
# create_container_service_deployment method definition
def create_container_service_deployment(
self,
*,
serviceName: str,
containers: Mapping[str, ContainerTypeDef] = ..., # (1)
publicEndpoint: EndpointRequestTypeDef = ..., # (2)
) -> CreateContainerServiceDeploymentResultTypeDef: # (3)
...
# create_container_service_deployment method usage example with argument unpacking
kwargs: CreateContainerServiceDeploymentRequestRequestTypeDef = { # (1)
"serviceName": ...,
}
parent.create_container_service_deployment(**kwargs)
create_container_service_registry_login#
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine.
Type annotations and code completion for boto3.client("lightsail").create_container_service_registry_login
method.
boto3 documentation
# create_container_service_registry_login method definition
def create_container_service_registry_login(
self,
) -> CreateContainerServiceRegistryLoginResultTypeDef: # (1)
...
create_disk#
Creates a block storage disk that can be attached to an Amazon Lightsail
instance in the same Availability Zone (e.g.,
us-east-2a
).
Type annotations and code completion for boto3.client("lightsail").create_disk
method.
boto3 documentation
# create_disk method definition
def create_disk(
self,
*,
diskName: str,
availabilityZone: str,
sizeInGb: int,
tags: Sequence[TagTypeDef] = ..., # (1)
addOns: Sequence[AddOnRequestTypeDef] = ..., # (2)
) -> CreateDiskResultTypeDef: # (3)
...
- See TagTypeDef
- See AddOnRequestTypeDef
- See CreateDiskResultTypeDef
# create_disk method usage example with argument unpacking
kwargs: CreateDiskRequestRequestTypeDef = { # (1)
"diskName": ...,
"availabilityZone": ...,
"sizeInGb": ...,
}
parent.create_disk(**kwargs)
create_disk_from_snapshot#
Creates a block storage disk from a manual or automatic snapshot of a disk.
Type annotations and code completion for boto3.client("lightsail").create_disk_from_snapshot
method.
boto3 documentation
# create_disk_from_snapshot method definition
def create_disk_from_snapshot(
self,
*,
diskName: str,
availabilityZone: str,
sizeInGb: int,
diskSnapshotName: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
addOns: Sequence[AddOnRequestTypeDef] = ..., # (2)
sourceDiskName: str = ...,
restoreDate: str = ...,
useLatestRestorableAutoSnapshot: bool = ...,
) -> CreateDiskFromSnapshotResultTypeDef: # (3)
...
# create_disk_from_snapshot method usage example with argument unpacking
kwargs: CreateDiskFromSnapshotRequestRequestTypeDef = { # (1)
"diskName": ...,
"availabilityZone": ...,
"sizeInGb": ...,
}
parent.create_disk_from_snapshot(**kwargs)
create_disk_snapshot#
Creates a snapshot of a block storage disk.
Type annotations and code completion for boto3.client("lightsail").create_disk_snapshot
method.
boto3 documentation
# create_disk_snapshot method definition
def create_disk_snapshot(
self,
*,
diskSnapshotName: str,
diskName: str = ...,
instanceName: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateDiskSnapshotResultTypeDef: # (2)
...