

*********
Lightsail
*********



======
Client
======



.. py: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 <https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-how-to-set-up-and-configure-aws-cli>`__.

   

  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 <https://docs.aws.amazon.com/general/latest/gr/lightsail.html>`__ in the *Amazon Web Services General Reference*.

  ::

    
    import boto3
    
    client = boto3.client('lightsail')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  lightsail/client/allocate_static_ip
  lightsail/client/attach_certificate_to_distribution
  lightsail/client/attach_disk
  lightsail/client/attach_instances_to_load_balancer
  lightsail/client/attach_load_balancer_tls_certificate
  lightsail/client/attach_static_ip
  lightsail/client/can_paginate
  lightsail/client/close
  lightsail/client/close_instance_public_ports
  lightsail/client/copy_snapshot
  lightsail/client/create_bucket
  lightsail/client/create_bucket_access_key
  lightsail/client/create_certificate
  lightsail/client/create_cloud_formation_stack
  lightsail/client/create_contact_method
  lightsail/client/create_container_service
  lightsail/client/create_container_service_deployment
  lightsail/client/create_container_service_registry_login
  lightsail/client/create_disk
  lightsail/client/create_disk_from_snapshot
  lightsail/client/create_disk_snapshot
  lightsail/client/create_distribution
  lightsail/client/create_domain
  lightsail/client/create_domain_entry
  lightsail/client/create_gui_session_access_details
  lightsail/client/create_instance_snapshot
  lightsail/client/create_instances
  lightsail/client/create_instances_from_snapshot
  lightsail/client/create_key_pair
  lightsail/client/create_load_balancer
  lightsail/client/create_load_balancer_tls_certificate
  lightsail/client/create_relational_database
  lightsail/client/create_relational_database_from_snapshot
  lightsail/client/create_relational_database_snapshot
  lightsail/client/delete_alarm
  lightsail/client/delete_auto_snapshot
  lightsail/client/delete_bucket
  lightsail/client/delete_bucket_access_key
  lightsail/client/delete_certificate
  lightsail/client/delete_contact_method
  lightsail/client/delete_container_image
  lightsail/client/delete_container_service
  lightsail/client/delete_disk
  lightsail/client/delete_disk_snapshot
  lightsail/client/delete_distribution
  lightsail/client/delete_domain
  lightsail/client/delete_domain_entry
  lightsail/client/delete_instance
  lightsail/client/delete_instance_snapshot
  lightsail/client/delete_key_pair
  lightsail/client/delete_known_host_keys
  lightsail/client/delete_load_balancer
  lightsail/client/delete_load_balancer_tls_certificate
  lightsail/client/delete_relational_database
  lightsail/client/delete_relational_database_snapshot
  lightsail/client/detach_certificate_from_distribution
  lightsail/client/detach_disk
  lightsail/client/detach_instances_from_load_balancer
  lightsail/client/detach_static_ip
  lightsail/client/disable_add_on
  lightsail/client/download_default_key_pair
  lightsail/client/enable_add_on
  lightsail/client/export_snapshot
  lightsail/client/get_active_names
  lightsail/client/get_alarms
  lightsail/client/get_auto_snapshots
  lightsail/client/get_blueprints
  lightsail/client/get_bucket_access_keys
  lightsail/client/get_bucket_bundles
  lightsail/client/get_bucket_metric_data
  lightsail/client/get_buckets
  lightsail/client/get_bundles
  lightsail/client/get_certificates
  lightsail/client/get_cloud_formation_stack_records
  lightsail/client/get_contact_methods
  lightsail/client/get_container_api_metadata
  lightsail/client/get_container_images
  lightsail/client/get_container_log
  lightsail/client/get_container_service_deployments
  lightsail/client/get_container_service_metric_data
  lightsail/client/get_container_service_powers
  lightsail/client/get_container_services
  lightsail/client/get_cost_estimate
  lightsail/client/get_disk
  lightsail/client/get_disk_snapshot
  lightsail/client/get_disk_snapshots
  lightsail/client/get_disks
  lightsail/client/get_distribution_bundles
  lightsail/client/get_distribution_latest_cache_reset
  lightsail/client/get_distribution_metric_data
  lightsail/client/get_distributions
  lightsail/client/get_domain
  lightsail/client/get_domains
  lightsail/client/get_export_snapshot_records
  lightsail/client/get_instance
  lightsail/client/get_instance_access_details
  lightsail/client/get_instance_metric_data
  lightsail/client/get_instance_port_states
  lightsail/client/get_instance_snapshot
  lightsail/client/get_instance_snapshots
  lightsail/client/get_instance_state
  lightsail/client/get_instances
  lightsail/client/get_key_pair
  lightsail/client/get_key_pairs
  lightsail/client/get_load_balancer
  lightsail/client/get_load_balancer_metric_data
  lightsail/client/get_load_balancer_tls_certificates
  lightsail/client/get_load_balancer_tls_policies
  lightsail/client/get_load_balancers
  lightsail/client/get_operation
  lightsail/client/get_operations
  lightsail/client/get_operations_for_resource
  lightsail/client/get_paginator
  lightsail/client/get_regions
  lightsail/client/get_relational_database
  lightsail/client/get_relational_database_blueprints
  lightsail/client/get_relational_database_bundles
  lightsail/client/get_relational_database_events
  lightsail/client/get_relational_database_log_events
  lightsail/client/get_relational_database_log_streams
  lightsail/client/get_relational_database_master_user_password
  lightsail/client/get_relational_database_metric_data
  lightsail/client/get_relational_database_parameters
  lightsail/client/get_relational_database_snapshot
  lightsail/client/get_relational_database_snapshots
  lightsail/client/get_relational_databases
  lightsail/client/get_setup_history
  lightsail/client/get_static_ip
  lightsail/client/get_static_ips
  lightsail/client/get_waiter
  lightsail/client/import_key_pair
  lightsail/client/is_vpc_peered
  lightsail/client/open_instance_public_ports
  lightsail/client/peer_vpc
  lightsail/client/put_alarm
  lightsail/client/put_instance_public_ports
  lightsail/client/reboot_instance
  lightsail/client/reboot_relational_database
  lightsail/client/register_container_image
  lightsail/client/release_static_ip
  lightsail/client/reset_distribution_cache
  lightsail/client/send_contact_method_verification
  lightsail/client/set_ip_address_type
  lightsail/client/set_resource_access_for_bucket
  lightsail/client/setup_instance_https
  lightsail/client/start_gui_session
  lightsail/client/start_instance
  lightsail/client/start_relational_database
  lightsail/client/stop_gui_session
  lightsail/client/stop_instance
  lightsail/client/stop_relational_database
  lightsail/client/tag_resource
  lightsail/client/test_alarm
  lightsail/client/unpeer_vpc
  lightsail/client/untag_resource
  lightsail/client/update_bucket
  lightsail/client/update_bucket_bundle
  lightsail/client/update_container_service
  lightsail/client/update_distribution
  lightsail/client/update_distribution_bundle
  lightsail/client/update_domain_entry
  lightsail/client/update_instance_metadata_options
  lightsail/client/update_load_balancer_attribute
  lightsail/client/update_relational_database
  lightsail/client/update_relational_database_parameters


==========
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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  lightsail/paginator/GetActiveNames
  lightsail/paginator/GetBlueprints
  lightsail/paginator/GetBundles
  lightsail/paginator/GetCloudFormationStackRecords
  lightsail/paginator/GetDiskSnapshots
  lightsail/paginator/GetDisks
  lightsail/paginator/GetDomains
  lightsail/paginator/GetExportSnapshotRecords
  lightsail/paginator/GetInstanceSnapshots
  lightsail/paginator/GetInstances
  lightsail/paginator/GetKeyPairs
  lightsail/paginator/GetLoadBalancers
  lightsail/paginator/GetOperations
  lightsail/paginator/GetRelationalDatabaseBlueprints
  lightsail/paginator/GetRelationalDatabaseBundles
  lightsail/paginator/GetRelationalDatabaseEvents
  lightsail/paginator/GetRelationalDatabaseParameters
  lightsail/paginator/GetRelationalDatabaseSnapshots
  lightsail/paginator/GetRelationalDatabases
  lightsail/paginator/GetStaticIps
