LightsailClient

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

1. See AllocateStaticIpResultTypeDef

# allocate_static_ip method usage example with argument unpacking

kwargs: AllocateStaticIpRequestRequestTypeDef = {  # (1)
    "staticIpName": ...,
}

parent.allocate_static_ip(**kwargs)

1. See AllocateStaticIpRequestRequestTypeDef

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

1. See AttachCertificateToDistributionResultTypeDef

# attach_certificate_to_distribution method usage example with argument unpacking

kwargs: AttachCertificateToDistributionRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
    "certificateName": ...,
}

parent.attach_certificate_to_distribution(**kwargs)

1. See AttachCertificateToDistributionRequestRequestTypeDef

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

1. See AttachDiskResultTypeDef

# attach_disk method usage example with argument unpacking

kwargs: AttachDiskRequestRequestTypeDef = {  # (1)
    "diskName": ...,
    "instanceName": ...,
    "diskPath": ...,
}

parent.attach_disk(**kwargs)

1. See AttachDiskRequestRequestTypeDef

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

1. See AttachInstancesToLoadBalancerResultTypeDef

# attach_instances_to_load_balancer method usage example with argument unpacking

kwargs: AttachInstancesToLoadBalancerRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "instanceNames": ...,
}

parent.attach_instances_to_load_balancer(**kwargs)

1. See AttachInstancesToLoadBalancerRequestRequestTypeDef

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

1. See AttachLoadBalancerTlsCertificateResultTypeDef

# attach_load_balancer_tls_certificate method usage example with argument unpacking

kwargs: AttachLoadBalancerTlsCertificateRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "certificateName": ...,
}

parent.attach_load_balancer_tls_certificate(**kwargs)

1. See AttachLoadBalancerTlsCertificateRequestRequestTypeDef

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

1. See AttachStaticIpResultTypeDef

# attach_static_ip method usage example with argument unpacking

kwargs: AttachStaticIpRequestRequestTypeDef = {  # (1)
    "staticIpName": ...,
    "instanceName": ...,
}

parent.attach_static_ip(**kwargs)

1. See AttachStaticIpRequestRequestTypeDef

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

1. See PortInfoTypeDef
2. See CloseInstancePublicPortsResultTypeDef

# close_instance_public_ports method usage example with argument unpacking

kwargs: CloseInstancePublicPortsRequestRequestTypeDef = {  # (1)
    "portInfo": ...,
    "instanceName": ...,
}

parent.close_instance_public_ports(**kwargs)

1. See CloseInstancePublicPortsRequestRequestTypeDef

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

1. See RegionNameType
2. See CopySnapshotResultTypeDef

# copy_snapshot method usage example with argument unpacking

kwargs: CopySnapshotRequestRequestTypeDef = {  # (1)
    "targetSnapshotName": ...,
    "sourceRegion": ...,
}

parent.copy_snapshot(**kwargs)

1. See CopySnapshotRequestRequestTypeDef

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

1. See TagTypeDef
2. See CreateBucketResultTypeDef

# create_bucket method usage example with argument unpacking

kwargs: CreateBucketRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
    "bundleId": ...,
}

parent.create_bucket(**kwargs)

1. See CreateBucketRequestRequestTypeDef

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

1. See CreateBucketAccessKeyResultTypeDef

# create_bucket_access_key method usage example with argument unpacking

kwargs: CreateBucketAccessKeyRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
}

parent.create_bucket_access_key(**kwargs)

1. See CreateBucketAccessKeyRequestRequestTypeDef

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

1. See TagTypeDef
2. See CreateCertificateResultTypeDef

# create_certificate method usage example with argument unpacking

kwargs: CreateCertificateRequestRequestTypeDef = {  # (1)
    "certificateName": ...,
    "domainName": ...,
}

parent.create_certificate(**kwargs)

1. See CreateCertificateRequestRequestTypeDef

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

1. See InstanceEntryTypeDef
2. See CreateCloudFormationStackResultTypeDef

# create_cloud_formation_stack method usage example with argument unpacking

kwargs: CreateCloudFormationStackRequestRequestTypeDef = {  # (1)
    "instances": ...,
}

parent.create_cloud_formation_stack(**kwargs)

1. See CreateCloudFormationStackRequestRequestTypeDef

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

1. See ContactProtocolType
2. See CreateContactMethodResultTypeDef

# create_contact_method method usage example with argument unpacking

kwargs: CreateContactMethodRequestRequestTypeDef = {  # (1)
    "protocol": ...,
    "contactEndpoint": ...,
}

parent.create_contact_method(**kwargs)

1. See CreateContactMethodRequestRequestTypeDef

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

1. See ContainerServicePowerNameType
2. See TagTypeDef
3. See ContainerServiceDeploymentRequestTypeDef
4. See PrivateRegistryAccessRequestTypeDef
5. See CreateContainerServiceResultTypeDef

# create_container_service method usage example with argument unpacking

kwargs: CreateContainerServiceRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
    "power": ...,
    "scale": ...,
}

parent.create_container_service(**kwargs)

1. See CreateContainerServiceRequestRequestTypeDef

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, ContainerUnionTypeDef] = ...,  # (1)
    publicEndpoint: EndpointRequestTypeDef = ...,  # (2)
) -> CreateContainerServiceDeploymentResultTypeDef:  # (3)
    ...

1. See ContainerTypeDef ContainerOutputTypeDef
2. See EndpointRequestTypeDef
3. See CreateContainerServiceDeploymentResultTypeDef

# create_container_service_deployment method usage example with argument unpacking

kwargs: CreateContainerServiceDeploymentRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.create_container_service_deployment(**kwargs)

1. See CreateContainerServiceDeploymentRequestRequestTypeDef

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

1. See CreateContainerServiceRegistryLoginResultTypeDef

create_disk

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone ( 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)
    ...

1. See TagTypeDef
2. See AddOnRequestTypeDef
3. See CreateDiskResultTypeDef

# create_disk method usage example with argument unpacking

kwargs: CreateDiskRequestRequestTypeDef = {  # (1)
    "diskName": ...,
    "availabilityZone": ...,
    "sizeInGb": ...,
}

parent.create_disk(**kwargs)

1. See CreateDiskRequestRequestTypeDef

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

1. See TagTypeDef
2. See AddOnRequestTypeDef
3. See CreateDiskFromSnapshotResultTypeDef

# create_disk_from_snapshot method usage example with argument unpacking

kwargs: CreateDiskFromSnapshotRequestRequestTypeDef = {  # (1)
    "diskName": ...,
    "availabilityZone": ...,
    "sizeInGb": ...,
}

parent.create_disk_from_snapshot(**kwargs)

1. See CreateDiskFromSnapshotRequestRequestTypeDef

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

1. See TagTypeDef
2. See CreateDiskSnapshotResultTypeDef

# create_disk_snapshot method usage example with argument unpacking

kwargs: CreateDiskSnapshotRequestRequestTypeDef = {  # (1)
    "diskSnapshotName": ...,
}

parent.create_disk_snapshot(**kwargs)

1. See CreateDiskSnapshotRequestRequestTypeDef

create_distribution

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

Type annotations and code completion for boto3.client("lightsail").create_distribution method. boto3 documentation

# create_distribution method definition

def create_distribution(
    self,
    *,
    distributionName: str,
    origin: InputOriginTypeDef,  # (1)
    defaultCacheBehavior: CacheBehaviorTypeDef,  # (2)
    bundleId: str,
    cacheBehaviorSettings: CacheSettingsTypeDef = ...,  # (3)
    cacheBehaviors: Sequence[CacheBehaviorPerPathTypeDef] = ...,  # (4)
    ipAddressType: IpAddressTypeType = ...,  # (5)
    tags: Sequence[TagTypeDef] = ...,  # (6)
    certificateName: str = ...,
    viewerMinimumTlsProtocolVersion: ViewerMinimumTlsProtocolVersionEnumType = ...,  # (7)
) -> CreateDistributionResultTypeDef:  # (8)
    ...

1. See InputOriginTypeDef
2. See CacheBehaviorTypeDef
3. See CacheSettingsTypeDef
4. See CacheBehaviorPerPathTypeDef
5. See IpAddressTypeType
6. See TagTypeDef
7. See ViewerMinimumTlsProtocolVersionEnumType
8. See CreateDistributionResultTypeDef

# create_distribution method usage example with argument unpacking

kwargs: CreateDistributionRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
    "origin": ...,
    "defaultCacheBehavior": ...,
    "bundleId": ...,
}

parent.create_distribution(**kwargs)

1. See CreateDistributionRequestRequestTypeDef

create_domain

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

Type annotations and code completion for boto3.client("lightsail").create_domain method. boto3 documentation

# create_domain method definition

def create_domain(
    self,
    *,
    domainName: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDomainResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateDomainResultTypeDef

# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.create_domain(**kwargs)

1. See CreateDomainRequestRequestTypeDef

create_domain_entry

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

Type annotations and code completion for boto3.client("lightsail").create_domain_entry method. boto3 documentation

# create_domain_entry method definition

def create_domain_entry(
    self,
    *,
    domainName: str,
    domainEntry: DomainEntryTypeDef,  # (1)
) -> CreateDomainEntryResultTypeDef:  # (2)
    ...

1. See DomainEntryTypeDef
2. See CreateDomainEntryResultTypeDef

# create_domain_entry method usage example with argument unpacking

kwargs: CreateDomainEntryRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "domainEntry": ...,
}

parent.create_domain_entry(**kwargs)

1. See CreateDomainEntryRequestRequestTypeDef

create_gui_session_access_details

Creates two URLs that are used to access a virtual computer's graphical user interface (GUI) session.

Type annotations and code completion for boto3.client("lightsail").create_gui_session_access_details method. boto3 documentation

# create_gui_session_access_details method definition

def create_gui_session_access_details(
    self,
    *,
    resourceName: str,
) -> CreateGUISessionAccessDetailsResultTypeDef:  # (1)
    ...

1. See CreateGUISessionAccessDetailsResultTypeDef

# create_gui_session_access_details method usage example with argument unpacking

kwargs: CreateGUISessionAccessDetailsRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.create_gui_session_access_details(**kwargs)

1. See CreateGUISessionAccessDetailsRequestRequestTypeDef

create_instance_snapshot

Creates a snapshot of a specific virtual private server, or instance.

Type annotations and code completion for boto3.client("lightsail").create_instance_snapshot method. boto3 documentation

# create_instance_snapshot method definition

def create_instance_snapshot(
    self,
    *,
    instanceSnapshotName: str,
    instanceName: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateInstanceSnapshotResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateInstanceSnapshotResultTypeDef

# create_instance_snapshot method usage example with argument unpacking

kwargs: CreateInstanceSnapshotRequestRequestTypeDef = {  # (1)
    "instanceSnapshotName": ...,
    "instanceName": ...,
}

parent.create_instance_snapshot(**kwargs)

1. See CreateInstanceSnapshotRequestRequestTypeDef

create_instances

Creates one or more Amazon Lightsail instances.

Type annotations and code completion for boto3.client("lightsail").create_instances method. boto3 documentation

# create_instances method definition

def create_instances(
    self,
    *,
    instanceNames: Sequence[str],
    availabilityZone: str,
    blueprintId: str,
    bundleId: str,
    customImageName: str = ...,
    userData: str = ...,
    keyPairName: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    addOns: Sequence[AddOnRequestTypeDef] = ...,  # (2)
    ipAddressType: IpAddressTypeType = ...,  # (3)
) -> CreateInstancesResultTypeDef:  # (4)
    ...

1. See TagTypeDef
2. See AddOnRequestTypeDef
3. See IpAddressTypeType
4. See CreateInstancesResultTypeDef

# create_instances method usage example with argument unpacking

kwargs: CreateInstancesRequestRequestTypeDef = {  # (1)
    "instanceNames": ...,
    "availabilityZone": ...,
    "blueprintId": ...,
    "bundleId": ...,
}

parent.create_instances(**kwargs)

1. See CreateInstancesRequestRequestTypeDef

create_instances_from_snapshot

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

Type annotations and code completion for boto3.client("lightsail").create_instances_from_snapshot method. boto3 documentation

# create_instances_from_snapshot method definition

def create_instances_from_snapshot(
    self,
    *,
    instanceNames: Sequence[str],
    availabilityZone: str,
    bundleId: str,
    attachedDiskMapping: Mapping[str, Sequence[DiskMapTypeDef]] = ...,  # (1)
    instanceSnapshotName: str = ...,
    userData: str = ...,
    keyPairName: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    addOns: Sequence[AddOnRequestTypeDef] = ...,  # (3)
    ipAddressType: IpAddressTypeType = ...,  # (4)
    sourceInstanceName: str = ...,
    restoreDate: str = ...,
    useLatestRestorableAutoSnapshot: bool = ...,
) -> CreateInstancesFromSnapshotResultTypeDef:  # (5)
    ...

1. See DiskMapTypeDef
2. See TagTypeDef
3. See AddOnRequestTypeDef
4. See IpAddressTypeType
5. See CreateInstancesFromSnapshotResultTypeDef

# create_instances_from_snapshot method usage example with argument unpacking

kwargs: CreateInstancesFromSnapshotRequestRequestTypeDef = {  # (1)
    "instanceNames": ...,
    "availabilityZone": ...,
    "bundleId": ...,
}

parent.create_instances_from_snapshot(**kwargs)

1. See CreateInstancesFromSnapshotRequestRequestTypeDef

create_key_pair

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Type annotations and code completion for boto3.client("lightsail").create_key_pair method. boto3 documentation

# create_key_pair method definition

def create_key_pair(
    self,
    *,
    keyPairName: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateKeyPairResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateKeyPairResultTypeDef

# create_key_pair method usage example with argument unpacking

kwargs: CreateKeyPairRequestRequestTypeDef = {  # (1)
    "keyPairName": ...,
}

parent.create_key_pair(**kwargs)

1. See CreateKeyPairRequestRequestTypeDef

create_load_balancer

Creates a Lightsail load balancer.

Type annotations and code completion for boto3.client("lightsail").create_load_balancer method. boto3 documentation

# create_load_balancer method definition

def create_load_balancer(
    self,
    *,
    loadBalancerName: str,
    instancePort: int,
    healthCheckPath: str = ...,
    certificateName: str = ...,
    certificateDomainName: str = ...,
    certificateAlternativeNames: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    ipAddressType: IpAddressTypeType = ...,  # (2)
    tlsPolicyName: str = ...,
) -> CreateLoadBalancerResultTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See IpAddressTypeType
3. See CreateLoadBalancerResultTypeDef

# create_load_balancer method usage example with argument unpacking

kwargs: CreateLoadBalancerRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "instancePort": ...,
}

parent.create_load_balancer(**kwargs)

1. See CreateLoadBalancerRequestRequestTypeDef

create_load_balancer_tls_certificate

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

Type annotations and code completion for boto3.client("lightsail").create_load_balancer_tls_certificate method. boto3 documentation

# create_load_balancer_tls_certificate method definition

def create_load_balancer_tls_certificate(
    self,
    *,
    loadBalancerName: str,
    certificateName: str,
    certificateDomainName: str,
    certificateAlternativeNames: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateLoadBalancerTlsCertificateResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateLoadBalancerTlsCertificateResultTypeDef

# create_load_balancer_tls_certificate method usage example with argument unpacking

kwargs: CreateLoadBalancerTlsCertificateRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "certificateName": ...,
    "certificateDomainName": ...,
}

parent.create_load_balancer_tls_certificate(**kwargs)

1. See CreateLoadBalancerTlsCertificateRequestRequestTypeDef

create_relational_database

Creates a new database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").create_relational_database method. boto3 documentation

# create_relational_database method definition

def create_relational_database(
    self,
    *,
    relationalDatabaseName: str,
    relationalDatabaseBlueprintId: str,
    relationalDatabaseBundleId: str,
    masterDatabaseName: str,
    masterUsername: str,
    availabilityZone: str = ...,
    masterUserPassword: str = ...,
    preferredBackupWindow: str = ...,
    preferredMaintenanceWindow: str = ...,
    publiclyAccessible: bool = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRelationalDatabaseResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateRelationalDatabaseResultTypeDef

# create_relational_database method usage example with argument unpacking

kwargs: CreateRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
    "relationalDatabaseBlueprintId": ...,
    "relationalDatabaseBundleId": ...,
    "masterDatabaseName": ...,
    "masterUsername": ...,
}

parent.create_relational_database(**kwargs)

1. See CreateRelationalDatabaseRequestRequestTypeDef

create_relational_database_from_snapshot

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

Type annotations and code completion for boto3.client("lightsail").create_relational_database_from_snapshot method. boto3 documentation

# create_relational_database_from_snapshot method definition

def create_relational_database_from_snapshot(
    self,
    *,
    relationalDatabaseName: str,
    availabilityZone: str = ...,
    publiclyAccessible: bool = ...,
    relationalDatabaseSnapshotName: str = ...,
    relationalDatabaseBundleId: str = ...,
    sourceRelationalDatabaseName: str = ...,
    restoreTime: TimestampTypeDef = ...,
    useLatestRestorableTime: bool = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRelationalDatabaseFromSnapshotResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateRelationalDatabaseFromSnapshotResultTypeDef

# create_relational_database_from_snapshot method usage example with argument unpacking

kwargs: CreateRelationalDatabaseFromSnapshotRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.create_relational_database_from_snapshot(**kwargs)

1. See CreateRelationalDatabaseFromSnapshotRequestRequestTypeDef

create_relational_database_snapshot

Creates a snapshot of your database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").create_relational_database_snapshot method. boto3 documentation

# create_relational_database_snapshot method definition

def create_relational_database_snapshot(
    self,
    *,
    relationalDatabaseName: str,
    relationalDatabaseSnapshotName: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRelationalDatabaseSnapshotResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateRelationalDatabaseSnapshotResultTypeDef

# create_relational_database_snapshot method usage example with argument unpacking

kwargs: CreateRelationalDatabaseSnapshotRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
    "relationalDatabaseSnapshotName": ...,
}

parent.create_relational_database_snapshot(**kwargs)

1. See CreateRelationalDatabaseSnapshotRequestRequestTypeDef

delete_alarm

Deletes an alarm.

Type annotations and code completion for boto3.client("lightsail").delete_alarm method. boto3 documentation

# delete_alarm method definition

def delete_alarm(
    self,
    *,
    alarmName: str,
) -> DeleteAlarmResultTypeDef:  # (1)
    ...

1. See DeleteAlarmResultTypeDef

# delete_alarm method usage example with argument unpacking

kwargs: DeleteAlarmRequestRequestTypeDef = {  # (1)
    "alarmName": ...,
}

parent.delete_alarm(**kwargs)

1. See DeleteAlarmRequestRequestTypeDef

delete_auto_snapshot

Deletes an automatic snapshot of an instance or disk.

Type annotations and code completion for boto3.client("lightsail").delete_auto_snapshot method. boto3 documentation

# delete_auto_snapshot method definition

def delete_auto_snapshot(
    self,
    *,
    resourceName: str,
    date: str,
) -> DeleteAutoSnapshotResultTypeDef:  # (1)
    ...

1. See DeleteAutoSnapshotResultTypeDef

# delete_auto_snapshot method usage example with argument unpacking

kwargs: DeleteAutoSnapshotRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "date": ...,
}

parent.delete_auto_snapshot(**kwargs)

1. See DeleteAutoSnapshotRequestRequestTypeDef

delete_bucket

Deletes a Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").delete_bucket method. boto3 documentation

# delete_bucket method definition

def delete_bucket(
    self,
    *,
    bucketName: str,
    forceDelete: bool = ...,
) -> DeleteBucketResultTypeDef:  # (1)
    ...

1. See DeleteBucketResultTypeDef

# delete_bucket method usage example with argument unpacking

kwargs: DeleteBucketRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
}

parent.delete_bucket(**kwargs)

1. See DeleteBucketRequestRequestTypeDef

delete_bucket_access_key

Deletes an access key for the specified Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").delete_bucket_access_key method. boto3 documentation

# delete_bucket_access_key method definition

def delete_bucket_access_key(
    self,
    *,
    bucketName: str,
    accessKeyId: str,
) -> DeleteBucketAccessKeyResultTypeDef:  # (1)
    ...

1. See DeleteBucketAccessKeyResultTypeDef

# delete_bucket_access_key method usage example with argument unpacking

kwargs: DeleteBucketAccessKeyRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
    "accessKeyId": ...,
}

parent.delete_bucket_access_key(**kwargs)

1. See DeleteBucketAccessKeyRequestRequestTypeDef

delete_certificate

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

Type annotations and code completion for boto3.client("lightsail").delete_certificate method. boto3 documentation

# delete_certificate method definition

def delete_certificate(
    self,
    *,
    certificateName: str,
) -> DeleteCertificateResultTypeDef:  # (1)
    ...

1. See DeleteCertificateResultTypeDef

# delete_certificate method usage example with argument unpacking

kwargs: DeleteCertificateRequestRequestTypeDef = {  # (1)
    "certificateName": ...,
}

parent.delete_certificate(**kwargs)

1. See DeleteCertificateRequestRequestTypeDef

delete_contact_method

Deletes a contact method.

Type annotations and code completion for boto3.client("lightsail").delete_contact_method method. boto3 documentation

# delete_contact_method method definition

def delete_contact_method(
    self,
    *,
    protocol: ContactProtocolType,  # (1)
) -> DeleteContactMethodResultTypeDef:  # (2)
    ...

1. See ContactProtocolType
2. See DeleteContactMethodResultTypeDef

# delete_contact_method method usage example with argument unpacking

kwargs: DeleteContactMethodRequestRequestTypeDef = {  # (1)
    "protocol": ...,
}

parent.delete_contact_method(**kwargs)

1. See DeleteContactMethodRequestRequestTypeDef

delete_container_image

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

Type annotations and code completion for boto3.client("lightsail").delete_container_image method. boto3 documentation

# delete_container_image method definition

def delete_container_image(
    self,
    *,
    serviceName: str,
    image: str,
) -> Dict[str, Any]:
    ...

# delete_container_image method usage example with argument unpacking

kwargs: DeleteContainerImageRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
    "image": ...,
}

parent.delete_container_image(**kwargs)

1. See DeleteContainerImageRequestRequestTypeDef

delete_container_service

Deletes your Amazon Lightsail container service.

Type annotations and code completion for boto3.client("lightsail").delete_container_service method. boto3 documentation

# delete_container_service method definition

def delete_container_service(
    self,
    *,
    serviceName: str,
) -> Dict[str, Any]:
    ...

# delete_container_service method usage example with argument unpacking

kwargs: DeleteContainerServiceRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.delete_container_service(**kwargs)

1. See DeleteContainerServiceRequestRequestTypeDef

delete_disk

Deletes the specified block storage disk.

Type annotations and code completion for boto3.client("lightsail").delete_disk method. boto3 documentation

# delete_disk method definition

def delete_disk(
    self,
    *,
    diskName: str,
    forceDeleteAddOns: bool = ...,
) -> DeleteDiskResultTypeDef:  # (1)
    ...

1. See DeleteDiskResultTypeDef

# delete_disk method usage example with argument unpacking

kwargs: DeleteDiskRequestRequestTypeDef = {  # (1)
    "diskName": ...,
}

parent.delete_disk(**kwargs)

1. See DeleteDiskRequestRequestTypeDef

delete_disk_snapshot

Deletes the specified disk snapshot.

Type annotations and code completion for boto3.client("lightsail").delete_disk_snapshot method. boto3 documentation

# delete_disk_snapshot method definition

def delete_disk_snapshot(
    self,
    *,
    diskSnapshotName: str,
) -> DeleteDiskSnapshotResultTypeDef:  # (1)
    ...

1. See DeleteDiskSnapshotResultTypeDef

# delete_disk_snapshot method usage example with argument unpacking

kwargs: DeleteDiskSnapshotRequestRequestTypeDef = {  # (1)
    "diskSnapshotName": ...,
}

parent.delete_disk_snapshot(**kwargs)

1. See DeleteDiskSnapshotRequestRequestTypeDef

delete_distribution

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

Type annotations and code completion for boto3.client("lightsail").delete_distribution method. boto3 documentation

# delete_distribution method definition

def delete_distribution(
    self,
    *,
    distributionName: str = ...,
) -> DeleteDistributionResultTypeDef:  # (1)
    ...

1. See DeleteDistributionResultTypeDef

# delete_distribution method usage example with argument unpacking

kwargs: DeleteDistributionRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.delete_distribution(**kwargs)

1. See DeleteDistributionRequestRequestTypeDef

delete_domain

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

Type annotations and code completion for boto3.client("lightsail").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    domainName: str,
) -> DeleteDomainResultTypeDef:  # (1)
    ...

1. See DeleteDomainResultTypeDef

# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.delete_domain(**kwargs)

1. See DeleteDomainRequestRequestTypeDef

delete_domain_entry

Deletes a specific domain entry.

Type annotations and code completion for boto3.client("lightsail").delete_domain_entry method. boto3 documentation

# delete_domain_entry method definition

def delete_domain_entry(
    self,
    *,
    domainName: str,
    domainEntry: DomainEntryTypeDef,  # (1)
) -> DeleteDomainEntryResultTypeDef:  # (2)
    ...

1. See DomainEntryTypeDef
2. See DeleteDomainEntryResultTypeDef

# delete_domain_entry method usage example with argument unpacking

kwargs: DeleteDomainEntryRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "domainEntry": ...,
}

parent.delete_domain_entry(**kwargs)

1. See DeleteDomainEntryRequestRequestTypeDef

delete_instance

Deletes an Amazon Lightsail instance.

Type annotations and code completion for boto3.client("lightsail").delete_instance method. boto3 documentation

# delete_instance method definition

def delete_instance(
    self,
    *,
    instanceName: str,
    forceDeleteAddOns: bool = ...,
) -> DeleteInstanceResultTypeDef:  # (1)
    ...

1. See DeleteInstanceResultTypeDef

# delete_instance method usage example with argument unpacking

kwargs: DeleteInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.delete_instance(**kwargs)

1. See DeleteInstanceRequestRequestTypeDef

delete_instance_snapshot

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

Type annotations and code completion for boto3.client("lightsail").delete_instance_snapshot method. boto3 documentation

# delete_instance_snapshot method definition

def delete_instance_snapshot(
    self,
    *,
    instanceSnapshotName: str,
) -> DeleteInstanceSnapshotResultTypeDef:  # (1)
    ...

1. See DeleteInstanceSnapshotResultTypeDef

# delete_instance_snapshot method usage example with argument unpacking

kwargs: DeleteInstanceSnapshotRequestRequestTypeDef = {  # (1)
    "instanceSnapshotName": ...,
}

parent.delete_instance_snapshot(**kwargs)

1. See DeleteInstanceSnapshotRequestRequestTypeDef

delete_key_pair

Deletes the specified key pair by removing the public key from Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").delete_key_pair method. boto3 documentation

# delete_key_pair method definition

def delete_key_pair(
    self,
    *,
    keyPairName: str,
    expectedFingerprint: str = ...,
) -> DeleteKeyPairResultTypeDef:  # (1)
    ...

1. See DeleteKeyPairResultTypeDef

# delete_key_pair method usage example with argument unpacking

kwargs: DeleteKeyPairRequestRequestTypeDef = {  # (1)
    "keyPairName": ...,
}

parent.delete_key_pair(**kwargs)

1. See DeleteKeyPairRequestRequestTypeDef

delete_known_host_keys

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.

Type annotations and code completion for boto3.client("lightsail").delete_known_host_keys method. boto3 documentation

# delete_known_host_keys method definition

def delete_known_host_keys(
    self,
    *,
    instanceName: str,
) -> DeleteKnownHostKeysResultTypeDef:  # (1)
    ...

1. See DeleteKnownHostKeysResultTypeDef

# delete_known_host_keys method usage example with argument unpacking

kwargs: DeleteKnownHostKeysRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.delete_known_host_keys(**kwargs)

1. See DeleteKnownHostKeysRequestRequestTypeDef

delete_load_balancer

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.

Type annotations and code completion for boto3.client("lightsail").delete_load_balancer method. boto3 documentation

# delete_load_balancer method definition

def delete_load_balancer(
    self,
    *,
    loadBalancerName: str,
) -> DeleteLoadBalancerResultTypeDef:  # (1)
    ...

1. See DeleteLoadBalancerResultTypeDef

# delete_load_balancer method usage example with argument unpacking

kwargs: DeleteLoadBalancerRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
}

parent.delete_load_balancer(**kwargs)

1. See DeleteLoadBalancerRequestRequestTypeDef

delete_load_balancer_tls_certificate

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

Type annotations and code completion for boto3.client("lightsail").delete_load_balancer_tls_certificate method. boto3 documentation

# delete_load_balancer_tls_certificate method definition

def delete_load_balancer_tls_certificate(
    self,
    *,
    loadBalancerName: str,
    certificateName: str,
    force: bool = ...,
) -> DeleteLoadBalancerTlsCertificateResultTypeDef:  # (1)
    ...

1. See DeleteLoadBalancerTlsCertificateResultTypeDef

# delete_load_balancer_tls_certificate method usage example with argument unpacking

kwargs: DeleteLoadBalancerTlsCertificateRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "certificateName": ...,
}

parent.delete_load_balancer_tls_certificate(**kwargs)

1. See DeleteLoadBalancerTlsCertificateRequestRequestTypeDef

delete_relational_database

Deletes a database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").delete_relational_database method. boto3 documentation

# delete_relational_database method definition

def delete_relational_database(
    self,
    *,
    relationalDatabaseName: str,
    skipFinalSnapshot: bool = ...,
    finalRelationalDatabaseSnapshotName: str = ...,
) -> DeleteRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See DeleteRelationalDatabaseResultTypeDef

# delete_relational_database method usage example with argument unpacking

kwargs: DeleteRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.delete_relational_database(**kwargs)

1. See DeleteRelationalDatabaseRequestRequestTypeDef

delete_relational_database_snapshot

Deletes a database snapshot in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").delete_relational_database_snapshot method. boto3 documentation

# delete_relational_database_snapshot method definition

def delete_relational_database_snapshot(
    self,
    *,
    relationalDatabaseSnapshotName: str,
) -> DeleteRelationalDatabaseSnapshotResultTypeDef:  # (1)
    ...

1. See DeleteRelationalDatabaseSnapshotResultTypeDef

# delete_relational_database_snapshot method usage example with argument unpacking

kwargs: DeleteRelationalDatabaseSnapshotRequestRequestTypeDef = {  # (1)
    "relationalDatabaseSnapshotName": ...,
}

parent.delete_relational_database_snapshot(**kwargs)

1. See DeleteRelationalDatabaseSnapshotRequestRequestTypeDef

detach_certificate_from_distribution

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

Type annotations and code completion for boto3.client("lightsail").detach_certificate_from_distribution method. boto3 documentation

# detach_certificate_from_distribution method definition

def detach_certificate_from_distribution(
    self,
    *,
    distributionName: str,
) -> DetachCertificateFromDistributionResultTypeDef:  # (1)
    ...

1. See DetachCertificateFromDistributionResultTypeDef

# detach_certificate_from_distribution method usage example with argument unpacking

kwargs: DetachCertificateFromDistributionRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.detach_certificate_from_distribution(**kwargs)

1. See DetachCertificateFromDistributionRequestRequestTypeDef

detach_disk

Detaches a stopped block storage disk from a Lightsail instance.

Type annotations and code completion for boto3.client("lightsail").detach_disk method. boto3 documentation

# detach_disk method definition

def detach_disk(
    self,
    *,
    diskName: str,
) -> DetachDiskResultTypeDef:  # (1)
    ...

1. See DetachDiskResultTypeDef

# detach_disk method usage example with argument unpacking

kwargs: DetachDiskRequestRequestTypeDef = {  # (1)
    "diskName": ...,
}

parent.detach_disk(**kwargs)

1. See DetachDiskRequestRequestTypeDef

detach_instances_from_load_balancer

Detaches the specified instances from a Lightsail load balancer.

Type annotations and code completion for boto3.client("lightsail").detach_instances_from_load_balancer method. boto3 documentation

# detach_instances_from_load_balancer method definition

def detach_instances_from_load_balancer(
    self,
    *,
    loadBalancerName: str,
    instanceNames: Sequence[str],
) -> DetachInstancesFromLoadBalancerResultTypeDef:  # (1)
    ...

1. See DetachInstancesFromLoadBalancerResultTypeDef

# detach_instances_from_load_balancer method usage example with argument unpacking

kwargs: DetachInstancesFromLoadBalancerRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "instanceNames": ...,
}

parent.detach_instances_from_load_balancer(**kwargs)

1. See DetachInstancesFromLoadBalancerRequestRequestTypeDef

detach_static_ip

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

Type annotations and code completion for boto3.client("lightsail").detach_static_ip method. boto3 documentation

# detach_static_ip method definition

def detach_static_ip(
    self,
    *,
    staticIpName: str,
) -> DetachStaticIpResultTypeDef:  # (1)
    ...

1. See DetachStaticIpResultTypeDef

# detach_static_ip method usage example with argument unpacking

kwargs: DetachStaticIpRequestRequestTypeDef = {  # (1)
    "staticIpName": ...,
}

parent.detach_static_ip(**kwargs)

1. See DetachStaticIpRequestRequestTypeDef

disable_add_on

Disables an add-on for an Amazon Lightsail resource.

Type annotations and code completion for boto3.client("lightsail").disable_add_on method. boto3 documentation

# disable_add_on method definition

def disable_add_on(
    self,
    *,
    addOnType: AddOnTypeType,  # (1)
    resourceName: str,
) -> DisableAddOnResultTypeDef:  # (2)
    ...

1. See AddOnTypeType
2. See DisableAddOnResultTypeDef

# disable_add_on method usage example with argument unpacking

kwargs: DisableAddOnRequestRequestTypeDef = {  # (1)
    "addOnType": ...,
    "resourceName": ...,
}

parent.disable_add_on(**kwargs)

1. See DisableAddOnRequestRequestTypeDef

download_default_key_pair

Downloads the regional Amazon Lightsail default key pair.

Type annotations and code completion for boto3.client("lightsail").download_default_key_pair method. boto3 documentation

# download_default_key_pair method definition

def download_default_key_pair(
    self,
) -> DownloadDefaultKeyPairResultTypeDef:  # (1)
    ...

1. See DownloadDefaultKeyPairResultTypeDef

enable_add_on

Enables or modifies an add-on for an Amazon Lightsail resource.

Type annotations and code completion for boto3.client("lightsail").enable_add_on method. boto3 documentation

# enable_add_on method definition

def enable_add_on(
    self,
    *,
    resourceName: str,
    addOnRequest: AddOnRequestTypeDef,  # (1)
) -> EnableAddOnResultTypeDef:  # (2)
    ...

1. See AddOnRequestTypeDef
2. See EnableAddOnResultTypeDef

# enable_add_on method usage example with argument unpacking

kwargs: EnableAddOnRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "addOnRequest": ...,
}

parent.enable_add_on(**kwargs)

1. See EnableAddOnRequestRequestTypeDef

export_snapshot

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).

Type annotations and code completion for boto3.client("lightsail").export_snapshot method. boto3 documentation

# export_snapshot method definition

def export_snapshot(
    self,
    *,
    sourceSnapshotName: str,
) -> ExportSnapshotResultTypeDef:  # (1)
    ...

1. See ExportSnapshotResultTypeDef

# export_snapshot method usage example with argument unpacking

kwargs: ExportSnapshotRequestRequestTypeDef = {  # (1)
    "sourceSnapshotName": ...,
}

parent.export_snapshot(**kwargs)

1. See ExportSnapshotRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("lightsail").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_active_names

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

Type annotations and code completion for boto3.client("lightsail").get_active_names method. boto3 documentation

# get_active_names method definition

def get_active_names(
    self,
    *,
    pageToken: str = ...,
) -> GetActiveNamesResultTypeDef:  # (1)
    ...

1. See GetActiveNamesResultTypeDef

# get_active_names method usage example with argument unpacking

kwargs: GetActiveNamesRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_active_names(**kwargs)

1. See GetActiveNamesRequestRequestTypeDef

get_alarms

Returns information about the configured alarms.

Type annotations and code completion for boto3.client("lightsail").get_alarms method. boto3 documentation

# get_alarms method definition

def get_alarms(
    self,
    *,
    alarmName: str = ...,
    pageToken: str = ...,
    monitoredResourceName: str = ...,
) -> GetAlarmsResultTypeDef:  # (1)
    ...

1. See GetAlarmsResultTypeDef

# get_alarms method usage example with argument unpacking

kwargs: GetAlarmsRequestRequestTypeDef = {  # (1)
    "alarmName": ...,
}

parent.get_alarms(**kwargs)

1. See GetAlarmsRequestRequestTypeDef

get_auto_snapshots

Returns the available automatic snapshots for an instance or disk.

Type annotations and code completion for boto3.client("lightsail").get_auto_snapshots method. boto3 documentation

# get_auto_snapshots method definition

def get_auto_snapshots(
    self,
    *,
    resourceName: str,
) -> GetAutoSnapshotsResultTypeDef:  # (1)
    ...

1. See GetAutoSnapshotsResultTypeDef

# get_auto_snapshots method usage example with argument unpacking

kwargs: GetAutoSnapshotsRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.get_auto_snapshots(**kwargs)

1. See GetAutoSnapshotsRequestRequestTypeDef

get_blueprints

Returns the list of available instance images, or blueprints.

Type annotations and code completion for boto3.client("lightsail").get_blueprints method. boto3 documentation

# get_blueprints method definition

def get_blueprints(
    self,
    *,
    includeInactive: bool = ...,
    pageToken: str = ...,
    appCategory: AppCategoryType = ...,  # (1)
) -> GetBlueprintsResultTypeDef:  # (2)
    ...

1. See AppCategoryType
2. See GetBlueprintsResultTypeDef

# get_blueprints method usage example with argument unpacking

kwargs: GetBlueprintsRequestRequestTypeDef = {  # (1)
    "includeInactive": ...,
}

parent.get_blueprints(**kwargs)

1. See GetBlueprintsRequestRequestTypeDef

get_bucket_access_keys

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").get_bucket_access_keys method. boto3 documentation

# get_bucket_access_keys method definition

def get_bucket_access_keys(
    self,
    *,
    bucketName: str,
) -> GetBucketAccessKeysResultTypeDef:  # (1)
    ...

1. See GetBucketAccessKeysResultTypeDef

# get_bucket_access_keys method usage example with argument unpacking

kwargs: GetBucketAccessKeysRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
}

parent.get_bucket_access_keys(**kwargs)

1. See GetBucketAccessKeysRequestRequestTypeDef

get_bucket_bundles

Returns the bundles that you can apply to a Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").get_bucket_bundles method. boto3 documentation

# get_bucket_bundles method definition

def get_bucket_bundles(
    self,
    *,
    includeInactive: bool = ...,
) -> GetBucketBundlesResultTypeDef:  # (1)
    ...

1. See GetBucketBundlesResultTypeDef

# get_bucket_bundles method usage example with argument unpacking

kwargs: GetBucketBundlesRequestRequestTypeDef = {  # (1)
    "includeInactive": ...,
}

parent.get_bucket_bundles(**kwargs)

1. See GetBucketBundlesRequestRequestTypeDef

get_bucket_metric_data

Returns the data points of a specific metric for an Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").get_bucket_metric_data method. boto3 documentation

# get_bucket_metric_data method definition

def get_bucket_metric_data(
    self,
    *,
    bucketName: str,
    metricName: BucketMetricNameType,  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    period: int,
    statistics: Sequence[MetricStatisticType],  # (2)
    unit: MetricUnitType,  # (3)
) -> GetBucketMetricDataResultTypeDef:  # (4)
    ...

1. See BucketMetricNameType
2. See MetricStatisticType
3. See MetricUnitType
4. See GetBucketMetricDataResultTypeDef

# get_bucket_metric_data method usage example with argument unpacking

kwargs: GetBucketMetricDataRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
    "metricName": ...,
    "startTime": ...,
    "endTime": ...,
    "period": ...,
    "statistics": ...,
    "unit": ...,
}

parent.get_bucket_metric_data(**kwargs)

1. See GetBucketMetricDataRequestRequestTypeDef

get_buckets

Returns information about one or more Amazon Lightsail buckets.

Type annotations and code completion for boto3.client("lightsail").get_buckets method. boto3 documentation

# get_buckets method definition

def get_buckets(
    self,
    *,
    bucketName: str = ...,
    pageToken: str = ...,
    includeConnectedResources: bool = ...,
) -> GetBucketsResultTypeDef:  # (1)
    ...

1. See GetBucketsResultTypeDef

# get_buckets method usage example with argument unpacking

kwargs: GetBucketsRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
}

parent.get_buckets(**kwargs)

1. See GetBucketsRequestRequestTypeDef

get_bundles

Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

Type annotations and code completion for boto3.client("lightsail").get_bundles method. boto3 documentation

# get_bundles method definition

def get_bundles(
    self,
    *,
    includeInactive: bool = ...,
    pageToken: str = ...,
    appCategory: AppCategoryType = ...,  # (1)
) -> GetBundlesResultTypeDef:  # (2)
    ...

1. See AppCategoryType
2. See GetBundlesResultTypeDef

# get_bundles method usage example with argument unpacking

kwargs: GetBundlesRequestRequestTypeDef = {  # (1)
    "includeInactive": ...,
}

parent.get_bundles(**kwargs)

1. See GetBundlesRequestRequestTypeDef

get_certificates

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

Type annotations and code completion for boto3.client("lightsail").get_certificates method. boto3 documentation

# get_certificates method definition

def get_certificates(
    self,
    *,
    certificateStatuses: Sequence[CertificateStatusType] = ...,  # (1)
    includeCertificateDetails: bool = ...,
    certificateName: str = ...,
    pageToken: str = ...,
) -> GetCertificatesResultTypeDef:  # (2)
    ...

1. See CertificateStatusType
2. See GetCertificatesResultTypeDef

# get_certificates method usage example with argument unpacking

kwargs: GetCertificatesRequestRequestTypeDef = {  # (1)
    "certificateStatuses": ...,
}

parent.get_certificates(**kwargs)

1. See GetCertificatesRequestRequestTypeDef

get_cloud_formation_stack_records

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

Type annotations and code completion for boto3.client("lightsail").get_cloud_formation_stack_records method. boto3 documentation

# get_cloud_formation_stack_records method definition

def get_cloud_formation_stack_records(
    self,
    *,
    pageToken: str = ...,
) -> GetCloudFormationStackRecordsResultTypeDef:  # (1)
    ...

1. See GetCloudFormationStackRecordsResultTypeDef

# get_cloud_formation_stack_records method usage example with argument unpacking

kwargs: GetCloudFormationStackRecordsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_cloud_formation_stack_records(**kwargs)

1. See GetCloudFormationStackRecordsRequestRequestTypeDef

get_contact_methods

Returns information about the configured contact methods.

Type annotations and code completion for boto3.client("lightsail").get_contact_methods method. boto3 documentation

# get_contact_methods method definition

def get_contact_methods(
    self,
    *,
    protocols: Sequence[ContactProtocolType] = ...,  # (1)
) -> GetContactMethodsResultTypeDef:  # (2)
    ...

1. See ContactProtocolType
2. See GetContactMethodsResultTypeDef

# get_contact_methods method usage example with argument unpacking

kwargs: GetContactMethodsRequestRequestTypeDef = {  # (1)
    "protocols": ...,
}

parent.get_contact_methods(**kwargs)

1. See GetContactMethodsRequestRequestTypeDef

get_container_api_metadata

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

Type annotations and code completion for boto3.client("lightsail").get_container_api_metadata method. boto3 documentation

# get_container_api_metadata method definition

def get_container_api_metadata(
    self,
) -> GetContainerAPIMetadataResultTypeDef:  # (1)
    ...

1. See GetContainerAPIMetadataResultTypeDef

get_container_images

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

Type annotations and code completion for boto3.client("lightsail").get_container_images method. boto3 documentation

# get_container_images method definition

def get_container_images(
    self,
    *,
    serviceName: str,
) -> GetContainerImagesResultTypeDef:  # (1)
    ...

1. See GetContainerImagesResultTypeDef

# get_container_images method usage example with argument unpacking

kwargs: GetContainerImagesRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.get_container_images(**kwargs)

1. See GetContainerImagesRequestRequestTypeDef

get_container_log

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

Type annotations and code completion for boto3.client("lightsail").get_container_log method. boto3 documentation

# get_container_log method definition

def get_container_log(
    self,
    *,
    serviceName: str,
    containerName: str,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    filterPattern: str = ...,
    pageToken: str = ...,
) -> GetContainerLogResultTypeDef:  # (1)
    ...

1. See GetContainerLogResultTypeDef

# get_container_log method usage example with argument unpacking

kwargs: GetContainerLogRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
    "containerName": ...,
}

parent.get_container_log(**kwargs)

1. See GetContainerLogRequestRequestTypeDef

get_container_service_deployments

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.

Type annotations and code completion for boto3.client("lightsail").get_container_service_deployments method. boto3 documentation

# get_container_service_deployments method definition

def get_container_service_deployments(
    self,
    *,
    serviceName: str,
) -> GetContainerServiceDeploymentsResultTypeDef:  # (1)
    ...

1. See GetContainerServiceDeploymentsResultTypeDef

# get_container_service_deployments method usage example with argument unpacking

kwargs: GetContainerServiceDeploymentsRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.get_container_service_deployments(**kwargs)

1. See GetContainerServiceDeploymentsRequestRequestTypeDef

get_container_service_metric_data

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

Type annotations and code completion for boto3.client("lightsail").get_container_service_metric_data method. boto3 documentation

# get_container_service_metric_data method definition

def get_container_service_metric_data(
    self,
    *,
    serviceName: str,
    metricName: ContainerServiceMetricNameType,  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    period: int,
    statistics: Sequence[MetricStatisticType],  # (2)
) -> GetContainerServiceMetricDataResultTypeDef:  # (3)
    ...

1. See ContainerServiceMetricNameType
2. See MetricStatisticType
3. See GetContainerServiceMetricDataResultTypeDef

# get_container_service_metric_data method usage example with argument unpacking

kwargs: GetContainerServiceMetricDataRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
    "metricName": ...,
    "startTime": ...,
    "endTime": ...,
    "period": ...,
    "statistics": ...,
}

parent.get_container_service_metric_data(**kwargs)

1. See GetContainerServiceMetricDataRequestRequestTypeDef

get_container_service_powers

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

Type annotations and code completion for boto3.client("lightsail").get_container_service_powers method. boto3 documentation

# get_container_service_powers method definition

def get_container_service_powers(
    self,
) -> GetContainerServicePowersResultTypeDef:  # (1)
    ...

1. See GetContainerServicePowersResultTypeDef

get_container_services

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

Type annotations and code completion for boto3.client("lightsail").get_container_services method. boto3 documentation

# get_container_services method definition

def get_container_services(
    self,
    *,
    serviceName: str = ...,
) -> ContainerServicesListResultTypeDef:  # (1)
    ...

1. See ContainerServicesListResultTypeDef

# get_container_services method usage example with argument unpacking

kwargs: GetContainerServicesRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.get_container_services(**kwargs)

1. See GetContainerServicesRequestRequestTypeDef

get_cost_estimate

Retrieves information about the cost estimate for a specified resource.

Type annotations and code completion for boto3.client("lightsail").get_cost_estimate method. boto3 documentation

# get_cost_estimate method definition

def get_cost_estimate(
    self,
    *,
    resourceName: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
) -> GetCostEstimateResultTypeDef:  # (1)
    ...

1. See GetCostEstimateResultTypeDef

# get_cost_estimate method usage example with argument unpacking

kwargs: GetCostEstimateRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "startTime": ...,
    "endTime": ...,
}

parent.get_cost_estimate(**kwargs)

1. See GetCostEstimateRequestRequestTypeDef

get_disk

Returns information about a specific block storage disk.

Type annotations and code completion for boto3.client("lightsail").get_disk method. boto3 documentation

# get_disk method definition

def get_disk(
    self,
    *,
    diskName: str,
) -> GetDiskResultTypeDef:  # (1)
    ...

1. See GetDiskResultTypeDef

# get_disk method usage example with argument unpacking

kwargs: GetDiskRequestRequestTypeDef = {  # (1)
    "diskName": ...,
}

parent.get_disk(**kwargs)

1. See GetDiskRequestRequestTypeDef

get_disk_snapshot

Returns information about a specific block storage disk snapshot.

Type annotations and code completion for boto3.client("lightsail").get_disk_snapshot method. boto3 documentation

# get_disk_snapshot method definition

def get_disk_snapshot(
    self,
    *,
    diskSnapshotName: str,
) -> GetDiskSnapshotResultTypeDef:  # (1)
    ...

1. See GetDiskSnapshotResultTypeDef

# get_disk_snapshot method usage example with argument unpacking

kwargs: GetDiskSnapshotRequestRequestTypeDef = {  # (1)
    "diskSnapshotName": ...,
}

parent.get_disk_snapshot(**kwargs)

1. See GetDiskSnapshotRequestRequestTypeDef

get_disk_snapshots

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

Type annotations and code completion for boto3.client("lightsail").get_disk_snapshots method. boto3 documentation

# get_disk_snapshots method definition

def get_disk_snapshots(
    self,
    *,
    pageToken: str = ...,
) -> GetDiskSnapshotsResultTypeDef:  # (1)
    ...

1. See GetDiskSnapshotsResultTypeDef

# get_disk_snapshots method usage example with argument unpacking

kwargs: GetDiskSnapshotsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_disk_snapshots(**kwargs)

1. See GetDiskSnapshotsRequestRequestTypeDef

get_disks

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

Type annotations and code completion for boto3.client("lightsail").get_disks method. boto3 documentation

# get_disks method definition

def get_disks(
    self,
    *,
    pageToken: str = ...,
) -> GetDisksResultTypeDef:  # (1)
    ...

1. See GetDisksResultTypeDef

# get_disks method usage example with argument unpacking

kwargs: GetDisksRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_disks(**kwargs)

1. See GetDisksRequestRequestTypeDef

get_distribution_bundles

Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

Type annotations and code completion for boto3.client("lightsail").get_distribution_bundles method. boto3 documentation

# get_distribution_bundles method definition

def get_distribution_bundles(
    self,
) -> GetDistributionBundlesResultTypeDef:  # (1)
    ...

1. See GetDistributionBundlesResultTypeDef

get_distribution_latest_cache_reset

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

Type annotations and code completion for boto3.client("lightsail").get_distribution_latest_cache_reset method. boto3 documentation

# get_distribution_latest_cache_reset method definition

def get_distribution_latest_cache_reset(
    self,
    *,
    distributionName: str = ...,
) -> GetDistributionLatestCacheResetResultTypeDef:  # (1)
    ...

1. See GetDistributionLatestCacheResetResultTypeDef

# get_distribution_latest_cache_reset method usage example with argument unpacking

kwargs: GetDistributionLatestCacheResetRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.get_distribution_latest_cache_reset(**kwargs)

1. See GetDistributionLatestCacheResetRequestRequestTypeDef

get_distribution_metric_data

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Type annotations and code completion for boto3.client("lightsail").get_distribution_metric_data method. boto3 documentation

# get_distribution_metric_data method definition

def get_distribution_metric_data(
    self,
    *,
    distributionName: str,
    metricName: DistributionMetricNameType,  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    period: int,
    unit: MetricUnitType,  # (2)
    statistics: Sequence[MetricStatisticType],  # (3)
) -> GetDistributionMetricDataResultTypeDef:  # (4)
    ...

1. See DistributionMetricNameType
2. See MetricUnitType
3. See MetricStatisticType
4. See GetDistributionMetricDataResultTypeDef

# get_distribution_metric_data method usage example with argument unpacking

kwargs: GetDistributionMetricDataRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
    "metricName": ...,
    "startTime": ...,
    "endTime": ...,
    "period": ...,
    "unit": ...,
    "statistics": ...,
}

parent.get_distribution_metric_data(**kwargs)

1. See GetDistributionMetricDataRequestRequestTypeDef

get_distributions

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

Type annotations and code completion for boto3.client("lightsail").get_distributions method. boto3 documentation

# get_distributions method definition

def get_distributions(
    self,
    *,
    distributionName: str = ...,
    pageToken: str = ...,
) -> GetDistributionsResultTypeDef:  # (1)
    ...

1. See GetDistributionsResultTypeDef

# get_distributions method usage example with argument unpacking

kwargs: GetDistributionsRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.get_distributions(**kwargs)

1. See GetDistributionsRequestRequestTypeDef

get_domain

Returns information about a specific domain recordset.

Type annotations and code completion for boto3.client("lightsail").get_domain method. boto3 documentation

# get_domain method definition

def get_domain(
    self,
    *,
    domainName: str,
) -> GetDomainResultTypeDef:  # (1)
    ...

1. See GetDomainResultTypeDef

# get_domain method usage example with argument unpacking

kwargs: GetDomainRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.get_domain(**kwargs)

1. See GetDomainRequestRequestTypeDef

get_domains

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

Type annotations and code completion for boto3.client("lightsail").get_domains method. boto3 documentation

# get_domains method definition

def get_domains(
    self,
    *,
    pageToken: str = ...,
) -> GetDomainsResultTypeDef:  # (1)
    ...

1. See GetDomainsResultTypeDef

# get_domains method usage example with argument unpacking

kwargs: GetDomainsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_domains(**kwargs)

1. See GetDomainsRequestRequestTypeDef

get_export_snapshot_records

Returns all export snapshot records created as a result of the export snapshot operation.

Type annotations and code completion for boto3.client("lightsail").get_export_snapshot_records method. boto3 documentation

# get_export_snapshot_records method definition

def get_export_snapshot_records(
    self,
    *,
    pageToken: str = ...,
) -> GetExportSnapshotRecordsResultTypeDef:  # (1)
    ...

1. See GetExportSnapshotRecordsResultTypeDef

# get_export_snapshot_records method usage example with argument unpacking

kwargs: GetExportSnapshotRecordsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_export_snapshot_records(**kwargs)

1. See GetExportSnapshotRecordsRequestRequestTypeDef

get_instance

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

Type annotations and code completion for boto3.client("lightsail").get_instance method. boto3 documentation

# get_instance method definition

def get_instance(
    self,
    *,
    instanceName: str,
) -> GetInstanceResultTypeDef:  # (1)
    ...

1. See GetInstanceResultTypeDef

# get_instance method usage example with argument unpacking

kwargs: GetInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_instance(**kwargs)

1. See GetInstanceRequestRequestTypeDef

get_instance_access_details

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

Type annotations and code completion for boto3.client("lightsail").get_instance_access_details method. boto3 documentation

# get_instance_access_details method definition

def get_instance_access_details(
    self,
    *,
    instanceName: str,
    protocol: InstanceAccessProtocolType = ...,  # (1)
) -> GetInstanceAccessDetailsResultTypeDef:  # (2)
    ...

1. See InstanceAccessProtocolType
2. See GetInstanceAccessDetailsResultTypeDef

# get_instance_access_details method usage example with argument unpacking

kwargs: GetInstanceAccessDetailsRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_instance_access_details(**kwargs)

1. See GetInstanceAccessDetailsRequestRequestTypeDef

get_instance_metric_data

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

Type annotations and code completion for boto3.client("lightsail").get_instance_metric_data method. boto3 documentation

# get_instance_metric_data method definition

def get_instance_metric_data(
    self,
    *,
    instanceName: str,
    metricName: InstanceMetricNameType,  # (1)
    period: int,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    unit: MetricUnitType,  # (2)
    statistics: Sequence[MetricStatisticType],  # (3)
) -> GetInstanceMetricDataResultTypeDef:  # (4)
    ...

1. See InstanceMetricNameType
2. See MetricUnitType
3. See MetricStatisticType
4. See GetInstanceMetricDataResultTypeDef

# get_instance_metric_data method usage example with argument unpacking

kwargs: GetInstanceMetricDataRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
    "metricName": ...,
    "period": ...,
    "startTime": ...,
    "endTime": ...,
    "unit": ...,
    "statistics": ...,
}

parent.get_instance_metric_data(**kwargs)

1. See GetInstanceMetricDataRequestRequestTypeDef

get_instance_port_states

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

Type annotations and code completion for boto3.client("lightsail").get_instance_port_states method. boto3 documentation

# get_instance_port_states method definition

def get_instance_port_states(
    self,
    *,
    instanceName: str,
) -> GetInstancePortStatesResultTypeDef:  # (1)
    ...

1. See GetInstancePortStatesResultTypeDef

# get_instance_port_states method usage example with argument unpacking

kwargs: GetInstancePortStatesRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_instance_port_states(**kwargs)

1. See GetInstancePortStatesRequestRequestTypeDef

get_instance_snapshot

Returns information about a specific instance snapshot.

Type annotations and code completion for boto3.client("lightsail").get_instance_snapshot method. boto3 documentation

# get_instance_snapshot method definition

def get_instance_snapshot(
    self,
    *,
    instanceSnapshotName: str,
) -> GetInstanceSnapshotResultTypeDef:  # (1)
    ...

1. See GetInstanceSnapshotResultTypeDef

# get_instance_snapshot method usage example with argument unpacking

kwargs: GetInstanceSnapshotRequestRequestTypeDef = {  # (1)
    "instanceSnapshotName": ...,
}

parent.get_instance_snapshot(**kwargs)

1. See GetInstanceSnapshotRequestRequestTypeDef

get_instance_snapshots

Returns all instance snapshots for the user's account.

Type annotations and code completion for boto3.client("lightsail").get_instance_snapshots method. boto3 documentation

# get_instance_snapshots method definition

def get_instance_snapshots(
    self,
    *,
    pageToken: str = ...,
) -> GetInstanceSnapshotsResultTypeDef:  # (1)
    ...

1. See GetInstanceSnapshotsResultTypeDef

# get_instance_snapshots method usage example with argument unpacking

kwargs: GetInstanceSnapshotsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_instance_snapshots(**kwargs)

1. See GetInstanceSnapshotsRequestRequestTypeDef

get_instance_state

Returns the state of a specific instance.

Type annotations and code completion for boto3.client("lightsail").get_instance_state method. boto3 documentation

# get_instance_state method definition

def get_instance_state(
    self,
    *,
    instanceName: str,
) -> GetInstanceStateResultTypeDef:  # (1)
    ...

1. See GetInstanceStateResultTypeDef

# get_instance_state method usage example with argument unpacking

kwargs: GetInstanceStateRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.get_instance_state(**kwargs)

1. See GetInstanceStateRequestRequestTypeDef

get_instances

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

Type annotations and code completion for boto3.client("lightsail").get_instances method. boto3 documentation

# get_instances method definition

def get_instances(
    self,
    *,
    pageToken: str = ...,
) -> GetInstancesResultTypeDef:  # (1)
    ...

1. See GetInstancesResultTypeDef

# get_instances method usage example with argument unpacking

kwargs: GetInstancesRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_instances(**kwargs)

1. See GetInstancesRequestRequestTypeDef

get_key_pair

Returns information about a specific key pair.

Type annotations and code completion for boto3.client("lightsail").get_key_pair method. boto3 documentation

# get_key_pair method definition

def get_key_pair(
    self,
    *,
    keyPairName: str,
) -> GetKeyPairResultTypeDef:  # (1)
    ...

1. See GetKeyPairResultTypeDef

# get_key_pair method usage example with argument unpacking

kwargs: GetKeyPairRequestRequestTypeDef = {  # (1)
    "keyPairName": ...,
}

parent.get_key_pair(**kwargs)

1. See GetKeyPairRequestRequestTypeDef

get_key_pairs

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

Type annotations and code completion for boto3.client("lightsail").get_key_pairs method. boto3 documentation

# get_key_pairs method definition

def get_key_pairs(
    self,
    *,
    pageToken: str = ...,
    includeDefaultKeyPair: bool = ...,
) -> GetKeyPairsResultTypeDef:  # (1)
    ...

1. See GetKeyPairsResultTypeDef

# get_key_pairs method usage example with argument unpacking

kwargs: GetKeyPairsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_key_pairs(**kwargs)

1. See GetKeyPairsRequestRequestTypeDef

get_load_balancer

Returns information about the specified Lightsail load balancer.

Type annotations and code completion for boto3.client("lightsail").get_load_balancer method. boto3 documentation

# get_load_balancer method definition

def get_load_balancer(
    self,
    *,
    loadBalancerName: str,
) -> GetLoadBalancerResultTypeDef:  # (1)
    ...

1. See GetLoadBalancerResultTypeDef

# get_load_balancer method usage example with argument unpacking

kwargs: GetLoadBalancerRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
}

parent.get_load_balancer(**kwargs)

1. See GetLoadBalancerRequestRequestTypeDef

get_load_balancer_metric_data

Returns information about health metrics for your Lightsail load balancer.

Type annotations and code completion for boto3.client("lightsail").get_load_balancer_metric_data method. boto3 documentation

# get_load_balancer_metric_data method definition

def get_load_balancer_metric_data(
    self,
    *,
    loadBalancerName: str,
    metricName: LoadBalancerMetricNameType,  # (1)
    period: int,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    unit: MetricUnitType,  # (2)
    statistics: Sequence[MetricStatisticType],  # (3)
) -> GetLoadBalancerMetricDataResultTypeDef:  # (4)
    ...

1. See LoadBalancerMetricNameType
2. See MetricUnitType
3. See MetricStatisticType
4. See GetLoadBalancerMetricDataResultTypeDef

# get_load_balancer_metric_data method usage example with argument unpacking

kwargs: GetLoadBalancerMetricDataRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "metricName": ...,
    "period": ...,
    "startTime": ...,
    "endTime": ...,
    "unit": ...,
    "statistics": ...,
}

parent.get_load_balancer_metric_data(**kwargs)

1. See GetLoadBalancerMetricDataRequestRequestTypeDef

get_load_balancer_tls_certificates

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

Type annotations and code completion for boto3.client("lightsail").get_load_balancer_tls_certificates method. boto3 documentation

# get_load_balancer_tls_certificates method definition

def get_load_balancer_tls_certificates(
    self,
    *,
    loadBalancerName: str,
) -> GetLoadBalancerTlsCertificatesResultTypeDef:  # (1)
    ...

1. See GetLoadBalancerTlsCertificatesResultTypeDef

# get_load_balancer_tls_certificates method usage example with argument unpacking

kwargs: GetLoadBalancerTlsCertificatesRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
}

parent.get_load_balancer_tls_certificates(**kwargs)

1. See GetLoadBalancerTlsCertificatesRequestRequestTypeDef

get_load_balancer_tls_policies

Returns a list of TLS security policies that you can apply to Lightsail load balancers.

Type annotations and code completion for boto3.client("lightsail").get_load_balancer_tls_policies method. boto3 documentation

# get_load_balancer_tls_policies method definition

def get_load_balancer_tls_policies(
    self,
    *,
    pageToken: str = ...,
) -> GetLoadBalancerTlsPoliciesResultTypeDef:  # (1)
    ...

1. See GetLoadBalancerTlsPoliciesResultTypeDef

# get_load_balancer_tls_policies method usage example with argument unpacking

kwargs: GetLoadBalancerTlsPoliciesRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_load_balancer_tls_policies(**kwargs)

1. See GetLoadBalancerTlsPoliciesRequestRequestTypeDef

get_load_balancers

Returns information about all load balancers in an account.

Type annotations and code completion for boto3.client("lightsail").get_load_balancers method. boto3 documentation

# get_load_balancers method definition

def get_load_balancers(
    self,
    *,
    pageToken: str = ...,
) -> GetLoadBalancersResultTypeDef:  # (1)
    ...

1. See GetLoadBalancersResultTypeDef

# get_load_balancers method usage example with argument unpacking

kwargs: GetLoadBalancersRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_load_balancers(**kwargs)

1. See GetLoadBalancersRequestRequestTypeDef

get_operation

Returns information about a specific operation.

Type annotations and code completion for boto3.client("lightsail").get_operation method. boto3 documentation

# get_operation method definition

def get_operation(
    self,
    *,
    operationId: str,
) -> GetOperationResultTypeDef:  # (1)
    ...

1. See GetOperationResultTypeDef

# get_operation method usage example with argument unpacking

kwargs: GetOperationRequestRequestTypeDef = {  # (1)
    "operationId": ...,
}

parent.get_operation(**kwargs)

1. See GetOperationRequestRequestTypeDef

get_operations

Returns information about all operations.

Type annotations and code completion for boto3.client("lightsail").get_operations method. boto3 documentation

# get_operations method definition

def get_operations(
    self,
    *,
    pageToken: str = ...,
) -> GetOperationsResultTypeDef:  # (1)
    ...

1. See GetOperationsResultTypeDef

# get_operations method usage example with argument unpacking

kwargs: GetOperationsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_operations(**kwargs)

1. See GetOperationsRequestRequestTypeDef

get_operations_for_resource

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

Type annotations and code completion for boto3.client("lightsail").get_operations_for_resource method. boto3 documentation

# get_operations_for_resource method definition

def get_operations_for_resource(
    self,
    *,
    resourceName: str,
    pageToken: str = ...,
) -> GetOperationsForResourceResultTypeDef:  # (1)
    ...

1. See GetOperationsForResourceResultTypeDef

# get_operations_for_resource method usage example with argument unpacking

kwargs: GetOperationsForResourceRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.get_operations_for_resource(**kwargs)

1. See GetOperationsForResourceRequestRequestTypeDef

get_regions

Returns a list of all valid regions for Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_regions method. boto3 documentation

# get_regions method definition

def get_regions(
    self,
    *,
    includeAvailabilityZones: bool = ...,
    includeRelationalDatabaseAvailabilityZones: bool = ...,
) -> GetRegionsResultTypeDef:  # (1)
    ...

1. See GetRegionsResultTypeDef

# get_regions method usage example with argument unpacking

kwargs: GetRegionsRequestRequestTypeDef = {  # (1)
    "includeAvailabilityZones": ...,
}

parent.get_regions(**kwargs)

1. See GetRegionsRequestRequestTypeDef

get_relational_database

Returns information about a specific database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database method. boto3 documentation

# get_relational_database method definition

def get_relational_database(
    self,
    *,
    relationalDatabaseName: str,
) -> GetRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseResultTypeDef

# get_relational_database method usage example with argument unpacking

kwargs: GetRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.get_relational_database(**kwargs)

1. See GetRelationalDatabaseRequestRequestTypeDef

get_relational_database_blueprints

Returns a list of available database blueprints in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_blueprints method. boto3 documentation

# get_relational_database_blueprints method definition

def get_relational_database_blueprints(
    self,
    *,
    pageToken: str = ...,
) -> GetRelationalDatabaseBlueprintsResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseBlueprintsResultTypeDef

# get_relational_database_blueprints method usage example with argument unpacking

kwargs: GetRelationalDatabaseBlueprintsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_relational_database_blueprints(**kwargs)

1. See GetRelationalDatabaseBlueprintsRequestRequestTypeDef

get_relational_database_bundles

Returns the list of bundles that are available in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_bundles method. boto3 documentation

# get_relational_database_bundles method definition

def get_relational_database_bundles(
    self,
    *,
    pageToken: str = ...,
    includeInactive: bool = ...,
) -> GetRelationalDatabaseBundlesResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseBundlesResultTypeDef

# get_relational_database_bundles method usage example with argument unpacking

kwargs: GetRelationalDatabaseBundlesRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_relational_database_bundles(**kwargs)

1. See GetRelationalDatabaseBundlesRequestRequestTypeDef

get_relational_database_events

Returns a list of events for a specific database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_events method. boto3 documentation

# get_relational_database_events method definition

def get_relational_database_events(
    self,
    *,
    relationalDatabaseName: str,
    durationInMinutes: int = ...,
    pageToken: str = ...,
) -> GetRelationalDatabaseEventsResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseEventsResultTypeDef

# get_relational_database_events method usage example with argument unpacking

kwargs: GetRelationalDatabaseEventsRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.get_relational_database_events(**kwargs)

1. See GetRelationalDatabaseEventsRequestRequestTypeDef

get_relational_database_log_events

Returns a list of log events for a database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_log_events method. boto3 documentation

# get_relational_database_log_events method definition

def get_relational_database_log_events(
    self,
    *,
    relationalDatabaseName: str,
    logStreamName: str,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    startFromHead: bool = ...,
    pageToken: str = ...,
) -> GetRelationalDatabaseLogEventsResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseLogEventsResultTypeDef

# get_relational_database_log_events method usage example with argument unpacking

kwargs: GetRelationalDatabaseLogEventsRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
    "logStreamName": ...,
}

parent.get_relational_database_log_events(**kwargs)

1. See GetRelationalDatabaseLogEventsRequestRequestTypeDef

get_relational_database_log_streams

Returns a list of available log streams for a specific database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_log_streams method. boto3 documentation

# get_relational_database_log_streams method definition

def get_relational_database_log_streams(
    self,
    *,
    relationalDatabaseName: str,
) -> GetRelationalDatabaseLogStreamsResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseLogStreamsResultTypeDef

# get_relational_database_log_streams method usage example with argument unpacking

kwargs: GetRelationalDatabaseLogStreamsRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.get_relational_database_log_streams(**kwargs)

1. See GetRelationalDatabaseLogStreamsRequestRequestTypeDef

get_relational_database_master_user_password

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_master_user_password method. boto3 documentation

# get_relational_database_master_user_password method definition

def get_relational_database_master_user_password(
    self,
    *,
    relationalDatabaseName: str,
    passwordVersion: RelationalDatabasePasswordVersionType = ...,  # (1)
) -> GetRelationalDatabaseMasterUserPasswordResultTypeDef:  # (2)
    ...

1. See RelationalDatabasePasswordVersionType
2. See GetRelationalDatabaseMasterUserPasswordResultTypeDef

# get_relational_database_master_user_password method usage example with argument unpacking

kwargs: GetRelationalDatabaseMasterUserPasswordRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.get_relational_database_master_user_password(**kwargs)

1. See GetRelationalDatabaseMasterUserPasswordRequestRequestTypeDef

get_relational_database_metric_data

Returns the data points of the specified metric for a database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_metric_data method. boto3 documentation

# get_relational_database_metric_data method definition

def get_relational_database_metric_data(
    self,
    *,
    relationalDatabaseName: str,
    metricName: RelationalDatabaseMetricNameType,  # (1)
    period: int,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    unit: MetricUnitType,  # (2)
    statistics: Sequence[MetricStatisticType],  # (3)
) -> GetRelationalDatabaseMetricDataResultTypeDef:  # (4)
    ...

1. See RelationalDatabaseMetricNameType
2. See MetricUnitType
3. See MetricStatisticType
4. See GetRelationalDatabaseMetricDataResultTypeDef

# get_relational_database_metric_data method usage example with argument unpacking

kwargs: GetRelationalDatabaseMetricDataRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
    "metricName": ...,
    "period": ...,
    "startTime": ...,
    "endTime": ...,
    "unit": ...,
    "statistics": ...,
}

parent.get_relational_database_metric_data(**kwargs)

1. See GetRelationalDatabaseMetricDataRequestRequestTypeDef

get_relational_database_parameters

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_parameters method. boto3 documentation

# get_relational_database_parameters method definition

def get_relational_database_parameters(
    self,
    *,
    relationalDatabaseName: str,
    pageToken: str = ...,
) -> GetRelationalDatabaseParametersResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseParametersResultTypeDef

# get_relational_database_parameters method usage example with argument unpacking

kwargs: GetRelationalDatabaseParametersRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.get_relational_database_parameters(**kwargs)

1. See GetRelationalDatabaseParametersRequestRequestTypeDef

get_relational_database_snapshot

Returns information about a specific database snapshot in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_database_snapshot method. boto3 documentation

# get_relational_database_snapshot method definition

def get_relational_database_snapshot(
    self,
    *,
    relationalDatabaseSnapshotName: str,
) -> GetRelationalDatabaseSnapshotResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseSnapshotResultTypeDef

# get_relational_database_snapshot method usage example with argument unpacking

kwargs: GetRelationalDatabaseSnapshotRequestRequestTypeDef = {  # (1)
    "relationalDatabaseSnapshotName": ...,
}

parent.get_relational_database_snapshot(**kwargs)

1. See GetRelationalDatabaseSnapshotRequestRequestTypeDef

get_relational_database_snapshots

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

Type annotations and code completion for boto3.client("lightsail").get_relational_database_snapshots method. boto3 documentation

# get_relational_database_snapshots method definition

def get_relational_database_snapshots(
    self,
    *,
    pageToken: str = ...,
) -> GetRelationalDatabaseSnapshotsResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabaseSnapshotsResultTypeDef

# get_relational_database_snapshots method usage example with argument unpacking

kwargs: GetRelationalDatabaseSnapshotsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_relational_database_snapshots(**kwargs)

1. See GetRelationalDatabaseSnapshotsRequestRequestTypeDef

get_relational_databases

Returns information about all of your databases in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").get_relational_databases method. boto3 documentation

# get_relational_databases method definition

def get_relational_databases(
    self,
    *,
    pageToken: str = ...,
) -> GetRelationalDatabasesResultTypeDef:  # (1)
    ...

1. See GetRelationalDatabasesResultTypeDef

# get_relational_databases method usage example with argument unpacking

kwargs: GetRelationalDatabasesRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_relational_databases(**kwargs)

1. See GetRelationalDatabasesRequestRequestTypeDef

get_setup_history

Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

Type annotations and code completion for boto3.client("lightsail").get_setup_history method. boto3 documentation

# get_setup_history method definition

def get_setup_history(
    self,
    *,
    resourceName: str,
    pageToken: str = ...,
) -> GetSetupHistoryResultTypeDef:  # (1)
    ...

1. See GetSetupHistoryResultTypeDef

# get_setup_history method usage example with argument unpacking

kwargs: GetSetupHistoryRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.get_setup_history(**kwargs)

1. See GetSetupHistoryRequestRequestTypeDef

get_static_ip

Returns information about an Amazon Lightsail static IP.

Type annotations and code completion for boto3.client("lightsail").get_static_ip method. boto3 documentation

# get_static_ip method definition

def get_static_ip(
    self,
    *,
    staticIpName: str,
) -> GetStaticIpResultTypeDef:  # (1)
    ...

1. See GetStaticIpResultTypeDef

# get_static_ip method usage example with argument unpacking

kwargs: GetStaticIpRequestRequestTypeDef = {  # (1)
    "staticIpName": ...,
}

parent.get_static_ip(**kwargs)

1. See GetStaticIpRequestRequestTypeDef

get_static_ips

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

Type annotations and code completion for boto3.client("lightsail").get_static_ips method. boto3 documentation

# get_static_ips method definition

def get_static_ips(
    self,
    *,
    pageToken: str = ...,
) -> GetStaticIpsResultTypeDef:  # (1)
    ...

1. See GetStaticIpsResultTypeDef

# get_static_ips method usage example with argument unpacking

kwargs: GetStaticIpsRequestRequestTypeDef = {  # (1)
    "pageToken": ...,
}

parent.get_static_ips(**kwargs)

1. See GetStaticIpsRequestRequestTypeDef

import_key_pair

Imports a public SSH key from a specific key pair.

Type annotations and code completion for boto3.client("lightsail").import_key_pair method. boto3 documentation

# import_key_pair method definition

def import_key_pair(
    self,
    *,
    keyPairName: str,
    publicKeyBase64: str,
) -> ImportKeyPairResultTypeDef:  # (1)
    ...

1. See ImportKeyPairResultTypeDef

# import_key_pair method usage example with argument unpacking

kwargs: ImportKeyPairRequestRequestTypeDef = {  # (1)
    "keyPairName": ...,
    "publicKeyBase64": ...,
}

parent.import_key_pair(**kwargs)

1. See ImportKeyPairRequestRequestTypeDef

is_vpc_peered

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

Type annotations and code completion for boto3.client("lightsail").is_vpc_peered method. boto3 documentation

# is_vpc_peered method definition

def is_vpc_peered(
    self,
) -> IsVpcPeeredResultTypeDef:  # (1)
    ...

1. See IsVpcPeeredResultTypeDef

open_instance_public_ports

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.

Type annotations and code completion for boto3.client("lightsail").open_instance_public_ports method. boto3 documentation

# open_instance_public_ports method definition

def open_instance_public_ports(
    self,
    *,
    portInfo: PortInfoTypeDef,  # (1)
    instanceName: str,
) -> OpenInstancePublicPortsResultTypeDef:  # (2)
    ...

1. See PortInfoTypeDef
2. See OpenInstancePublicPortsResultTypeDef

# open_instance_public_ports method usage example with argument unpacking

kwargs: OpenInstancePublicPortsRequestRequestTypeDef = {  # (1)
    "portInfo": ...,
    "instanceName": ...,
}

parent.open_instance_public_ports(**kwargs)

1. See OpenInstancePublicPortsRequestRequestTypeDef

peer_vpc

Peers the Lightsail VPC with the user's default VPC.

Type annotations and code completion for boto3.client("lightsail").peer_vpc method. boto3 documentation

# peer_vpc method definition

def peer_vpc(
    self,
) -> PeerVpcResultTypeDef:  # (1)
    ...

1. See PeerVpcResultTypeDef

put_alarm

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

Type annotations and code completion for boto3.client("lightsail").put_alarm method. boto3 documentation

# put_alarm method definition

def put_alarm(
    self,
    *,
    alarmName: str,
    metricName: MetricNameType,  # (1)
    monitoredResourceName: str,
    comparisonOperator: ComparisonOperatorType,  # (2)
    threshold: float,
    evaluationPeriods: int,
    datapointsToAlarm: int = ...,
    treatMissingData: TreatMissingDataType = ...,  # (3)
    contactProtocols: Sequence[ContactProtocolType] = ...,  # (4)
    notificationTriggers: Sequence[AlarmStateType] = ...,  # (5)
    notificationEnabled: bool = ...,
) -> PutAlarmResultTypeDef:  # (6)
    ...

1. See MetricNameType
2. See ComparisonOperatorType
3. See TreatMissingDataType
4. See ContactProtocolType
5. See AlarmStateType
6. See PutAlarmResultTypeDef

# put_alarm method usage example with argument unpacking

kwargs: PutAlarmRequestRequestTypeDef = {  # (1)
    "alarmName": ...,
    "metricName": ...,
    "monitoredResourceName": ...,
    "comparisonOperator": ...,
    "threshold": ...,
    "evaluationPeriods": ...,
}

parent.put_alarm(**kwargs)

1. See PutAlarmRequestRequestTypeDef

put_instance_public_ports

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.

Type annotations and code completion for boto3.client("lightsail").put_instance_public_ports method. boto3 documentation

# put_instance_public_ports method definition

def put_instance_public_ports(
    self,
    *,
    portInfos: Sequence[PortInfoTypeDef],  # (1)
    instanceName: str,
) -> PutInstancePublicPortsResultTypeDef:  # (2)
    ...

1. See PortInfoTypeDef
2. See PutInstancePublicPortsResultTypeDef

# put_instance_public_ports method usage example with argument unpacking

kwargs: PutInstancePublicPortsRequestRequestTypeDef = {  # (1)
    "portInfos": ...,
    "instanceName": ...,
}

parent.put_instance_public_ports(**kwargs)

1. See PutInstancePublicPortsRequestRequestTypeDef

reboot_instance

Restarts a specific instance.

Type annotations and code completion for boto3.client("lightsail").reboot_instance method. boto3 documentation

# reboot_instance method definition

def reboot_instance(
    self,
    *,
    instanceName: str,
) -> RebootInstanceResultTypeDef:  # (1)
    ...

1. See RebootInstanceResultTypeDef

# reboot_instance method usage example with argument unpacking

kwargs: RebootInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.reboot_instance(**kwargs)

1. See RebootInstanceRequestRequestTypeDef

reboot_relational_database

Restarts a specific database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").reboot_relational_database method. boto3 documentation

# reboot_relational_database method definition

def reboot_relational_database(
    self,
    *,
    relationalDatabaseName: str,
) -> RebootRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See RebootRelationalDatabaseResultTypeDef

# reboot_relational_database method usage example with argument unpacking

kwargs: RebootRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.reboot_relational_database(**kwargs)

1. See RebootRelationalDatabaseRequestRequestTypeDef

register_container_image

Registers a container image to your Amazon Lightsail container service.

Type annotations and code completion for boto3.client("lightsail").register_container_image method. boto3 documentation

# register_container_image method definition

def register_container_image(
    self,
    *,
    serviceName: str,
    label: str,
    digest: str,
) -> RegisterContainerImageResultTypeDef:  # (1)
    ...

1. See RegisterContainerImageResultTypeDef

# register_container_image method usage example with argument unpacking

kwargs: RegisterContainerImageRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
    "label": ...,
    "digest": ...,
}

parent.register_container_image(**kwargs)

1. See RegisterContainerImageRequestRequestTypeDef

release_static_ip

Deletes a specific static IP from your account.

Type annotations and code completion for boto3.client("lightsail").release_static_ip method. boto3 documentation

# release_static_ip method definition

def release_static_ip(
    self,
    *,
    staticIpName: str,
) -> ReleaseStaticIpResultTypeDef:  # (1)
    ...

1. See ReleaseStaticIpResultTypeDef

# release_static_ip method usage example with argument unpacking

kwargs: ReleaseStaticIpRequestRequestTypeDef = {  # (1)
    "staticIpName": ...,
}

parent.release_static_ip(**kwargs)

1. See ReleaseStaticIpRequestRequestTypeDef

reset_distribution_cache

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

Type annotations and code completion for boto3.client("lightsail").reset_distribution_cache method. boto3 documentation

# reset_distribution_cache method definition

def reset_distribution_cache(
    self,
    *,
    distributionName: str = ...,
) -> ResetDistributionCacheResultTypeDef:  # (1)
    ...

1. See ResetDistributionCacheResultTypeDef

# reset_distribution_cache method usage example with argument unpacking

kwargs: ResetDistributionCacheRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.reset_distribution_cache(**kwargs)

1. See ResetDistributionCacheRequestRequestTypeDef

send_contact_method_verification

Sends a verification request to an email contact method to ensure it's owned by the requester.

Type annotations and code completion for boto3.client("lightsail").send_contact_method_verification method. boto3 documentation

# send_contact_method_verification method definition

def send_contact_method_verification(
    self,
    *,
    protocol: ContactMethodVerificationProtocolType,  # (1)
) -> SendContactMethodVerificationResultTypeDef:  # (2)
    ...

1. See ContactMethodVerificationProtocolType
2. See SendContactMethodVerificationResultTypeDef

# send_contact_method_verification method usage example with argument unpacking

kwargs: SendContactMethodVerificationRequestRequestTypeDef = {  # (1)
    "protocol": ...,
}

parent.send_contact_method_verification(**kwargs)

1. See SendContactMethodVerificationRequestRequestTypeDef

set_ip_address_type

Sets the IP address type for an Amazon Lightsail resource.

Type annotations and code completion for boto3.client("lightsail").set_ip_address_type method. boto3 documentation

# set_ip_address_type method definition

def set_ip_address_type(
    self,
    *,
    resourceType: ResourceTypeType,  # (1)
    resourceName: str,
    ipAddressType: IpAddressTypeType,  # (2)
    acceptBundleUpdate: bool = ...,
) -> SetIpAddressTypeResultTypeDef:  # (3)
    ...

1. See ResourceTypeType
2. See IpAddressTypeType
3. See SetIpAddressTypeResultTypeDef

# set_ip_address_type method usage example with argument unpacking

kwargs: SetIpAddressTypeRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
    "resourceName": ...,
    "ipAddressType": ...,
}

parent.set_ip_address_type(**kwargs)

1. See SetIpAddressTypeRequestRequestTypeDef

set_resource_access_for_bucket

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").set_resource_access_for_bucket method. boto3 documentation

# set_resource_access_for_bucket method definition

def set_resource_access_for_bucket(
    self,
    *,
    resourceName: str,
    bucketName: str,
    access: ResourceBucketAccessType,  # (1)
) -> SetResourceAccessForBucketResultTypeDef:  # (2)
    ...

1. See ResourceBucketAccessType
2. See SetResourceAccessForBucketResultTypeDef

# set_resource_access_for_bucket method usage example with argument unpacking

kwargs: SetResourceAccessForBucketRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "bucketName": ...,
    "access": ...,
}

parent.set_resource_access_for_bucket(**kwargs)

1. See SetResourceAccessForBucketRequestRequestTypeDef

setup_instance_https

Creates an SSL/TLS certificate that secures traffic for your website.

Type annotations and code completion for boto3.client("lightsail").setup_instance_https method. boto3 documentation

# setup_instance_https method definition

def setup_instance_https(
    self,
    *,
    instanceName: str,
    emailAddress: str,
    domainNames: Sequence[str],
    certificateProvider: CertificateProviderType,  # (1)
) -> SetupInstanceHttpsResultTypeDef:  # (2)
    ...

1. See CertificateProviderType
2. See SetupInstanceHttpsResultTypeDef

# setup_instance_https method usage example with argument unpacking

kwargs: SetupInstanceHttpsRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
    "emailAddress": ...,
    "domainNames": ...,
    "certificateProvider": ...,
}

parent.setup_instance_https(**kwargs)

1. See SetupInstanceHttpsRequestRequestTypeDef

start_gui_session

Initiates a graphical user interface (GUI) session that's used to access a virtual computer's operating system and application.

Type annotations and code completion for boto3.client("lightsail").start_gui_session method. boto3 documentation

# start_gui_session method definition

def start_gui_session(
    self,
    *,
    resourceName: str,
) -> StartGUISessionResultTypeDef:  # (1)
    ...

1. See StartGUISessionResultTypeDef

# start_gui_session method usage example with argument unpacking

kwargs: StartGUISessionRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.start_gui_session(**kwargs)

1. See StartGUISessionRequestRequestTypeDef

start_instance

Starts a specific Amazon Lightsail instance from a stopped state.

Type annotations and code completion for boto3.client("lightsail").start_instance method. boto3 documentation

# start_instance method definition

def start_instance(
    self,
    *,
    instanceName: str,
) -> StartInstanceResultTypeDef:  # (1)
    ...

1. See StartInstanceResultTypeDef

# start_instance method usage example with argument unpacking

kwargs: StartInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.start_instance(**kwargs)

1. See StartInstanceRequestRequestTypeDef

start_relational_database

Starts a specific database from a stopped state in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").start_relational_database method. boto3 documentation

# start_relational_database method definition

def start_relational_database(
    self,
    *,
    relationalDatabaseName: str,
) -> StartRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See StartRelationalDatabaseResultTypeDef

# start_relational_database method usage example with argument unpacking

kwargs: StartRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.start_relational_database(**kwargs)

1. See StartRelationalDatabaseRequestRequestTypeDef

stop_gui_session

Terminates a web-based NICE DCV session that's used to access a virtual computer's operating system or application.

Type annotations and code completion for boto3.client("lightsail").stop_gui_session method. boto3 documentation

# stop_gui_session method definition

def stop_gui_session(
    self,
    *,
    resourceName: str,
) -> StopGUISessionResultTypeDef:  # (1)
    ...

1. See StopGUISessionResultTypeDef

# stop_gui_session method usage example with argument unpacking

kwargs: StopGUISessionRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
}

parent.stop_gui_session(**kwargs)

1. See StopGUISessionRequestRequestTypeDef

stop_instance

Stops a specific Amazon Lightsail instance that is currently running.

Type annotations and code completion for boto3.client("lightsail").stop_instance method. boto3 documentation

# stop_instance method definition

def stop_instance(
    self,
    *,
    instanceName: str,
    force: bool = ...,
) -> StopInstanceResultTypeDef:  # (1)
    ...

1. See StopInstanceResultTypeDef

# stop_instance method usage example with argument unpacking

kwargs: StopInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.stop_instance(**kwargs)

1. See StopInstanceRequestRequestTypeDef

stop_relational_database

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

Type annotations and code completion for boto3.client("lightsail").stop_relational_database method. boto3 documentation

# stop_relational_database method definition

def stop_relational_database(
    self,
    *,
    relationalDatabaseName: str,
    relationalDatabaseSnapshotName: str = ...,
) -> StopRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See StopRelationalDatabaseResultTypeDef

# stop_relational_database method usage example with argument unpacking

kwargs: StopRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.stop_relational_database(**kwargs)

1. See StopRelationalDatabaseRequestRequestTypeDef

tag_resource

Adds one or more tags to the specified Amazon Lightsail resource.

Type annotations and code completion for boto3.client("lightsail").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceName: str,
    tags: Sequence[TagTypeDef],  # (1)
    resourceArn: str = ...,
) -> TagResourceResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See TagResourceResultTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

test_alarm

Tests an alarm by displaying a banner on the Amazon Lightsail console.

Type annotations and code completion for boto3.client("lightsail").test_alarm method. boto3 documentation

# test_alarm method definition

def test_alarm(
    self,
    *,
    alarmName: str,
    state: AlarmStateType,  # (1)
) -> TestAlarmResultTypeDef:  # (2)
    ...

1. See AlarmStateType
2. See TestAlarmResultTypeDef

# test_alarm method usage example with argument unpacking

kwargs: TestAlarmRequestRequestTypeDef = {  # (1)
    "alarmName": ...,
    "state": ...,
}

parent.test_alarm(**kwargs)

1. See TestAlarmRequestRequestTypeDef

unpeer_vpc

Unpeers the Lightsail VPC from the user's default VPC.

Type annotations and code completion for boto3.client("lightsail").unpeer_vpc method. boto3 documentation

# unpeer_vpc method definition

def unpeer_vpc(
    self,
) -> UnpeerVpcResultTypeDef:  # (1)
    ...

1. See UnpeerVpcResultTypeDef

untag_resource

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

Type annotations and code completion for boto3.client("lightsail").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceName: str,
    tagKeys: Sequence[str],
    resourceArn: str = ...,
) -> UntagResourceResultTypeDef:  # (1)
    ...

1. See UntagResourceResultTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceName": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_bucket

Updates an existing Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").update_bucket method. boto3 documentation

# update_bucket method definition

def update_bucket(
    self,
    *,
    bucketName: str,
    accessRules: AccessRulesTypeDef = ...,  # (1)
    versioning: str = ...,
    readonlyAccessAccounts: Sequence[str] = ...,
    accessLogConfig: BucketAccessLogConfigTypeDef = ...,  # (2)
) -> UpdateBucketResultTypeDef:  # (3)
    ...

1. See AccessRulesTypeDef
2. See BucketAccessLogConfigTypeDef
3. See UpdateBucketResultTypeDef

# update_bucket method usage example with argument unpacking

kwargs: UpdateBucketRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
}

parent.update_bucket(**kwargs)

1. See UpdateBucketRequestRequestTypeDef

update_bucket_bundle

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

Type annotations and code completion for boto3.client("lightsail").update_bucket_bundle method. boto3 documentation

# update_bucket_bundle method definition

def update_bucket_bundle(
    self,
    *,
    bucketName: str,
    bundleId: str,
) -> UpdateBucketBundleResultTypeDef:  # (1)
    ...

1. See UpdateBucketBundleResultTypeDef

# update_bucket_bundle method usage example with argument unpacking

kwargs: UpdateBucketBundleRequestRequestTypeDef = {  # (1)
    "bucketName": ...,
    "bundleId": ...,
}

parent.update_bucket_bundle(**kwargs)

1. See UpdateBucketBundleRequestRequestTypeDef

update_container_service

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

Type annotations and code completion for boto3.client("lightsail").update_container_service method. boto3 documentation

# update_container_service method definition

def update_container_service(
    self,
    *,
    serviceName: str,
    power: ContainerServicePowerNameType = ...,  # (1)
    scale: int = ...,
    isDisabled: bool = ...,
    publicDomainNames: Mapping[str, Sequence[str]] = ...,
    privateRegistryAccess: PrivateRegistryAccessRequestTypeDef = ...,  # (2)
) -> UpdateContainerServiceResultTypeDef:  # (3)
    ...

1. See ContainerServicePowerNameType
2. See PrivateRegistryAccessRequestTypeDef
3. See UpdateContainerServiceResultTypeDef

# update_container_service method usage example with argument unpacking

kwargs: UpdateContainerServiceRequestRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.update_container_service(**kwargs)

1. See UpdateContainerServiceRequestRequestTypeDef

update_distribution

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

Type annotations and code completion for boto3.client("lightsail").update_distribution method. boto3 documentation

# update_distribution method definition

def update_distribution(
    self,
    *,
    distributionName: str,
    origin: InputOriginTypeDef = ...,  # (1)
    defaultCacheBehavior: CacheBehaviorTypeDef = ...,  # (2)
    cacheBehaviorSettings: CacheSettingsTypeDef = ...,  # (3)
    cacheBehaviors: Sequence[CacheBehaviorPerPathTypeDef] = ...,  # (4)
    isEnabled: bool = ...,
    viewerMinimumTlsProtocolVersion: ViewerMinimumTlsProtocolVersionEnumType = ...,  # (5)
    certificateName: str = ...,
    useDefaultCertificate: bool = ...,
) -> UpdateDistributionResultTypeDef:  # (6)
    ...

1. See InputOriginTypeDef
2. See CacheBehaviorTypeDef
3. See CacheSettingsTypeDef
4. See CacheBehaviorPerPathTypeDef
5. See ViewerMinimumTlsProtocolVersionEnumType
6. See UpdateDistributionResultTypeDef

# update_distribution method usage example with argument unpacking

kwargs: UpdateDistributionRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.update_distribution(**kwargs)

1. See UpdateDistributionRequestRequestTypeDef

update_distribution_bundle

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

Type annotations and code completion for boto3.client("lightsail").update_distribution_bundle method. boto3 documentation

# update_distribution_bundle method definition

def update_distribution_bundle(
    self,
    *,
    distributionName: str = ...,
    bundleId: str = ...,
) -> UpdateDistributionBundleResultTypeDef:  # (1)
    ...

1. See UpdateDistributionBundleResultTypeDef

# update_distribution_bundle method usage example with argument unpacking

kwargs: UpdateDistributionBundleRequestRequestTypeDef = {  # (1)
    "distributionName": ...,
}

parent.update_distribution_bundle(**kwargs)

1. See UpdateDistributionBundleRequestRequestTypeDef

update_domain_entry

Updates a domain recordset after it is created.

Type annotations and code completion for boto3.client("lightsail").update_domain_entry method. boto3 documentation

# update_domain_entry method definition

def update_domain_entry(
    self,
    *,
    domainName: str,
    domainEntry: DomainEntryTypeDef,  # (1)
) -> UpdateDomainEntryResultTypeDef:  # (2)
    ...

1. See DomainEntryTypeDef
2. See UpdateDomainEntryResultTypeDef

# update_domain_entry method usage example with argument unpacking

kwargs: UpdateDomainEntryRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "domainEntry": ...,
}

parent.update_domain_entry(**kwargs)

1. See UpdateDomainEntryRequestRequestTypeDef

update_instance_metadata_options

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.

Type annotations and code completion for boto3.client("lightsail").update_instance_metadata_options method. boto3 documentation

# update_instance_metadata_options method definition

def update_instance_metadata_options(
    self,
    *,
    instanceName: str,
    httpTokens: HttpTokensType = ...,  # (1)
    httpEndpoint: HttpEndpointType = ...,  # (2)
    httpPutResponseHopLimit: int = ...,
    httpProtocolIpv6: HttpProtocolIpv6Type = ...,  # (3)
) -> UpdateInstanceMetadataOptionsResultTypeDef:  # (4)
    ...

1. See HttpTokensType
2. See HttpEndpointType
3. See HttpProtocolIpv6Type
4. See UpdateInstanceMetadataOptionsResultTypeDef

# update_instance_metadata_options method usage example with argument unpacking

kwargs: UpdateInstanceMetadataOptionsRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.update_instance_metadata_options(**kwargs)

1. See UpdateInstanceMetadataOptionsRequestRequestTypeDef

update_load_balancer_attribute

Updates the specified attribute for a load balancer.

Type annotations and code completion for boto3.client("lightsail").update_load_balancer_attribute method. boto3 documentation

# update_load_balancer_attribute method definition

def update_load_balancer_attribute(
    self,
    *,
    loadBalancerName: str,
    attributeName: LoadBalancerAttributeNameType,  # (1)
    attributeValue: str,
) -> UpdateLoadBalancerAttributeResultTypeDef:  # (2)
    ...

1. See LoadBalancerAttributeNameType
2. See UpdateLoadBalancerAttributeResultTypeDef

# update_load_balancer_attribute method usage example with argument unpacking

kwargs: UpdateLoadBalancerAttributeRequestRequestTypeDef = {  # (1)
    "loadBalancerName": ...,
    "attributeName": ...,
    "attributeValue": ...,
}

parent.update_load_balancer_attribute(**kwargs)

1. See UpdateLoadBalancerAttributeRequestRequestTypeDef

update_relational_database

Allows the update of one or more attributes of a database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").update_relational_database method. boto3 documentation

# update_relational_database method definition

def update_relational_database(
    self,
    *,
    relationalDatabaseName: str,
    masterUserPassword: str = ...,
    rotateMasterUserPassword: bool = ...,
    preferredBackupWindow: str = ...,
    preferredMaintenanceWindow: str = ...,
    enableBackupRetention: bool = ...,
    disableBackupRetention: bool = ...,
    publiclyAccessible: bool = ...,
    applyImmediately: bool = ...,
    caCertificateIdentifier: str = ...,
    relationalDatabaseBlueprintId: str = ...,
) -> UpdateRelationalDatabaseResultTypeDef:  # (1)
    ...

1. See UpdateRelationalDatabaseResultTypeDef

# update_relational_database method usage example with argument unpacking

kwargs: UpdateRelationalDatabaseRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
}

parent.update_relational_database(**kwargs)

1. See UpdateRelationalDatabaseRequestRequestTypeDef

update_relational_database_parameters

Allows the update of one or more parameters of a database in Amazon Lightsail.

Type annotations and code completion for boto3.client("lightsail").update_relational_database_parameters method. boto3 documentation

# update_relational_database_parameters method definition

def update_relational_database_parameters(
    self,
    *,
    relationalDatabaseName: str,
    parameters: Sequence[RelationalDatabaseParameterTypeDef],  # (1)
) -> UpdateRelationalDatabaseParametersResultTypeDef:  # (2)
    ...

1. See RelationalDatabaseParameterTypeDef
2. See UpdateRelationalDatabaseParametersResultTypeDef

# update_relational_database_parameters method usage example with argument unpacking

kwargs: UpdateRelationalDatabaseParametersRequestRequestTypeDef = {  # (1)
    "relationalDatabaseName": ...,
    "parameters": ...,
}

parent.update_relational_database_parameters(**kwargs)

1. See UpdateRelationalDatabaseParametersRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("lightsail").get_paginator method with overloads.

• client.get_paginator("get_active_names") -> GetActiveNamesPaginator
• client.get_paginator("get_blueprints") -> GetBlueprintsPaginator
• client.get_paginator("get_bundles") -> GetBundlesPaginator
• client.get_paginator("get_cloud_formation_stack_records") -> GetCloudFormationStackRecordsPaginator
• client.get_paginator("get_disk_snapshots") -> GetDiskSnapshotsPaginator
• client.get_paginator("get_disks") -> GetDisksPaginator
• client.get_paginator("get_domains") -> GetDomainsPaginator
• client.get_paginator("get_export_snapshot_records") -> GetExportSnapshotRecordsPaginator
• client.get_paginator("get_instance_snapshots") -> GetInstanceSnapshotsPaginator
• client.get_paginator("get_instances") -> GetInstancesPaginator
• client.get_paginator("get_key_pairs") -> GetKeyPairsPaginator
• client.get_paginator("get_load_balancers") -> GetLoadBalancersPaginator
• client.get_paginator("get_operations") -> GetOperationsPaginator
• client.get_paginator("get_relational_database_blueprints") -> GetRelationalDatabaseBlueprintsPaginator
• client.get_paginator("get_relational_database_bundles") -> GetRelationalDatabaseBundlesPaginator
• client.get_paginator("get_relational_database_events") -> GetRelationalDatabaseEventsPaginator
• client.get_paginator("get_relational_database_parameters") -> GetRelationalDatabaseParametersPaginator
• client.get_paginator("get_relational_database_snapshots") -> GetRelationalDatabaseSnapshotsPaginator
• client.get_paginator("get_relational_databases") -> GetRelationalDatabasesPaginator
• client.get_paginator("get_static_ips") -> GetStaticIpsPaginator