Lightsail#
Client#
- class Lightsail.Client#
A low-level client representing Amazon Lightsail
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
import boto3 client = boto3.client('lightsail')
These are the available methods:
- allocate_static_ip
- attach_certificate_to_distribution
- attach_disk
- attach_instances_to_load_balancer
- attach_load_balancer_tls_certificate
- attach_static_ip
- can_paginate
- close
- close_instance_public_ports
- copy_snapshot
- create_bucket
- create_bucket_access_key
- create_certificate
- create_cloud_formation_stack
- create_contact_method
- create_container_service
- create_container_service_deployment
- create_container_service_registry_login
- create_disk
- create_disk_from_snapshot
- create_disk_snapshot
- create_distribution
- create_domain
- create_domain_entry
- create_gui_session_access_details
- create_instance_snapshot
- create_instances
- create_instances_from_snapshot
- create_key_pair
- create_load_balancer
- create_load_balancer_tls_certificate
- create_relational_database
- create_relational_database_from_snapshot
- create_relational_database_snapshot
- delete_alarm
- delete_auto_snapshot
- delete_bucket
- delete_bucket_access_key
- delete_certificate
- delete_contact_method
- delete_container_image
- delete_container_service
- delete_disk
- delete_disk_snapshot
- delete_distribution
- delete_domain
- delete_domain_entry
- delete_instance
- delete_instance_snapshot
- delete_key_pair
- delete_known_host_keys
- delete_load_balancer
- delete_load_balancer_tls_certificate
- delete_relational_database
- delete_relational_database_snapshot
- detach_certificate_from_distribution
- detach_disk
- detach_instances_from_load_balancer
- detach_static_ip
- disable_add_on
- download_default_key_pair
- enable_add_on
- export_snapshot
- get_active_names
- get_alarms
- get_auto_snapshots
- get_blueprints
- get_bucket_access_keys
- get_bucket_bundles
- get_bucket_metric_data
- get_buckets
- get_bundles
- get_certificates
- get_cloud_formation_stack_records
- get_contact_methods
- get_container_api_metadata
- get_container_images
- get_container_log
- get_container_service_deployments
- get_container_service_metric_data
- get_container_service_powers
- get_container_services
- get_cost_estimate
- get_disk
- get_disk_snapshot
- get_disk_snapshots
- get_disks
- get_distribution_bundles
- get_distribution_latest_cache_reset
- get_distribution_metric_data
- get_distributions
- get_domain
- get_domains
- get_export_snapshot_records
- get_instance
- get_instance_access_details
- get_instance_metric_data
- get_instance_port_states
- get_instance_snapshot
- get_instance_snapshots
- get_instance_state
- get_instances
- get_key_pair
- get_key_pairs
- get_load_balancer
- get_load_balancer_metric_data
- get_load_balancer_tls_certificates
- get_load_balancer_tls_policies
- get_load_balancers
- get_operation
- get_operations
- get_operations_for_resource
- get_paginator
- get_regions
- get_relational_database
- get_relational_database_blueprints
- get_relational_database_bundles
- get_relational_database_events
- get_relational_database_log_events
- get_relational_database_log_streams
- get_relational_database_master_user_password
- get_relational_database_metric_data
- get_relational_database_parameters
- get_relational_database_snapshot
- get_relational_database_snapshots
- get_relational_databases
- get_setup_history
- get_static_ip
- get_static_ips
- get_waiter
- import_key_pair
- is_vpc_peered
- open_instance_public_ports
- peer_vpc
- put_alarm
- put_instance_public_ports
- reboot_instance
- reboot_relational_database
- register_container_image
- release_static_ip
- reset_distribution_cache
- send_contact_method_verification
- set_ip_address_type
- set_resource_access_for_bucket
- setup_instance_https
- start_gui_session
- start_instance
- start_relational_database
- stop_gui_session
- stop_instance
- stop_relational_database
- tag_resource
- test_alarm
- unpeer_vpc
- untag_resource
- update_bucket
- update_bucket_bundle
- update_container_service
- update_distribution
- update_distribution_bundle
- update_domain_entry
- update_instance_metadata_options
- update_load_balancer_attribute
- update_relational_database
- update_relational_database_parameters
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- GetActiveNames
- GetBlueprints
- GetBundles
- GetCloudFormationStackRecords
- GetDiskSnapshots
- GetDisks
- GetDomains
- GetExportSnapshotRecords
- GetInstanceSnapshots
- GetInstances
- GetKeyPairs
- GetLoadBalancers
- GetOperations
- GetRelationalDatabaseBlueprints
- GetRelationalDatabaseBundles
- GetRelationalDatabaseEvents
- GetRelationalDatabaseParameters
- GetRelationalDatabaseSnapshots
- GetRelationalDatabases
- GetStaticIps