diff options
Diffstat (limited to 'python-mypy-boto3-lightsail.spec')
| -rw-r--r-- | python-mypy-boto3-lightsail.spec | 3022 |
1 files changed, 3022 insertions, 0 deletions
diff --git a/python-mypy-boto3-lightsail.spec b/python-mypy-boto3-lightsail.spec new file mode 100644 index 0000000..20b1f83 --- /dev/null +++ b/python-mypy-boto3-lightsail.spec @@ -0,0 +1,3022 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-lightsail +Version: 1.26.81 +Release: 1 +Summary: Type annotations for boto3.Lightsail 1.26.81 service generated with mypy-boto3-builder 7.12.4 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c0/09/218f17eb436127db969386d7a22714b081a969ced0db4b864b2c4d65ce18/mypy-boto3-lightsail-1.26.81.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-lightsail"></a> + +# mypy-boto3-lightsail + +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-lightsail) + + + +Type annotations for +[boto3.Lightsail 1.26.81](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lightsail.html#Lightsail) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-lightsail docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lightsail](#mypy-boto3-lightsail) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Lightsail`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lightsail` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lightsail]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[lightsail]' + + +# standalone installation +python -m pip install mypy-boto3-lightsail +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-lightsail +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lightsail]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[lightsail]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`LightsailClient` provides annotations for `boto3.client("lightsail")`. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient + +client: LightsailClient = Session().client("lightsail") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lightsail.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient +from mypy_boto3_lightsail.paginator import ( + GetActiveNamesPaginator, + GetBlueprintsPaginator, + GetBundlesPaginator, + GetCloudFormationStackRecordsPaginator, + GetDiskSnapshotsPaginator, + GetDisksPaginator, + GetDomainsPaginator, + GetExportSnapshotRecordsPaginator, + GetInstanceSnapshotsPaginator, + GetInstancesPaginator, + GetKeyPairsPaginator, + GetLoadBalancersPaginator, + GetOperationsPaginator, + GetRelationalDatabaseBlueprintsPaginator, + GetRelationalDatabaseBundlesPaginator, + GetRelationalDatabaseEventsPaginator, + GetRelationalDatabaseParametersPaginator, + GetRelationalDatabaseSnapshotsPaginator, + GetRelationalDatabasesPaginator, + GetStaticIpsPaginator, +) + +client: LightsailClient = Session().client("lightsail") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_active_names_paginator: GetActiveNamesPaginator = client.get_paginator("get_active_names") +get_blueprints_paginator: GetBlueprintsPaginator = client.get_paginator("get_blueprints") +get_bundles_paginator: GetBundlesPaginator = client.get_paginator("get_bundles") +get_cloud_formation_stack_records_paginator: GetCloudFormationStackRecordsPaginator = ( + client.get_paginator("get_cloud_formation_stack_records") +) +get_disk_snapshots_paginator: GetDiskSnapshotsPaginator = client.get_paginator("get_disk_snapshots") +get_disks_paginator: GetDisksPaginator = client.get_paginator("get_disks") +get_domains_paginator: GetDomainsPaginator = client.get_paginator("get_domains") +get_export_snapshot_records_paginator: GetExportSnapshotRecordsPaginator = client.get_paginator( + "get_export_snapshot_records" +) +get_instance_snapshots_paginator: GetInstanceSnapshotsPaginator = client.get_paginator( + "get_instance_snapshots" +) +get_instances_paginator: GetInstancesPaginator = client.get_paginator("get_instances") +get_key_pairs_paginator: GetKeyPairsPaginator = client.get_paginator("get_key_pairs") +get_load_balancers_paginator: GetLoadBalancersPaginator = client.get_paginator("get_load_balancers") +get_operations_paginator: GetOperationsPaginator = client.get_paginator("get_operations") +get_relational_database_blueprints_paginator: GetRelationalDatabaseBlueprintsPaginator = ( + client.get_paginator("get_relational_database_blueprints") +) +get_relational_database_bundles_paginator: GetRelationalDatabaseBundlesPaginator = ( + client.get_paginator("get_relational_database_bundles") +) +get_relational_database_events_paginator: GetRelationalDatabaseEventsPaginator = ( + client.get_paginator("get_relational_database_events") +) +get_relational_database_parameters_paginator: GetRelationalDatabaseParametersPaginator = ( + client.get_paginator("get_relational_database_parameters") +) +get_relational_database_snapshots_paginator: GetRelationalDatabaseSnapshotsPaginator = ( + client.get_paginator("get_relational_database_snapshots") +) +get_relational_databases_paginator: GetRelationalDatabasesPaginator = client.get_paginator( + "get_relational_databases" +) +get_static_ips_paginator: GetStaticIpsPaginator = client.get_paginator("get_static_ips") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_lightsail.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_lightsail.literals import ( + AccessDirectionType, + AccessTypeType, + AccountLevelBpaSyncStatusType, + AddOnTypeType, + AlarmStateType, + AppCategoryType, + AutoMountStatusType, + AutoSnapshotStatusType, + BPAStatusMessageType, + BehaviorEnumType, + BlueprintTypeType, + BucketMetricNameType, + CertificateDomainValidationStatusType, + CertificateStatusType, + CloudFormationStackRecordSourceTypeType, + ComparisonOperatorType, + ContactMethodStatusType, + ContactMethodVerificationProtocolType, + ContactProtocolType, + ContainerServiceDeploymentStateType, + ContainerServiceMetricNameType, + ContainerServicePowerNameType, + ContainerServiceProtocolType, + ContainerServiceStateDetailCodeType, + ContainerServiceStateType, + CurrencyType, + DiskSnapshotStateType, + DiskStateType, + DistributionMetricNameType, + DnsRecordCreationStateCodeType, + ExportSnapshotRecordSourceTypeType, + ForwardValuesType, + GetActiveNamesPaginatorName, + GetBlueprintsPaginatorName, + GetBundlesPaginatorName, + GetCloudFormationStackRecordsPaginatorName, + GetDiskSnapshotsPaginatorName, + GetDisksPaginatorName, + GetDomainsPaginatorName, + GetExportSnapshotRecordsPaginatorName, + GetInstanceSnapshotsPaginatorName, + GetInstancesPaginatorName, + GetKeyPairsPaginatorName, + GetLoadBalancersPaginatorName, + GetOperationsPaginatorName, + GetRelationalDatabaseBlueprintsPaginatorName, + GetRelationalDatabaseBundlesPaginatorName, + GetRelationalDatabaseEventsPaginatorName, + GetRelationalDatabaseParametersPaginatorName, + GetRelationalDatabaseSnapshotsPaginatorName, + GetRelationalDatabasesPaginatorName, + GetStaticIpsPaginatorName, + HeaderEnumType, + HttpEndpointType, + HttpProtocolIpv6Type, + HttpTokensType, + InstanceAccessProtocolType, + InstanceHealthReasonType, + InstanceHealthStateType, + InstanceMetadataStateType, + InstanceMetricNameType, + InstancePlatformType, + InstanceSnapshotStateType, + IpAddressTypeType, + LoadBalancerAttributeNameType, + LoadBalancerMetricNameType, + LoadBalancerProtocolType, + LoadBalancerStateType, + LoadBalancerTlsCertificateDnsRecordCreationStateCodeType, + LoadBalancerTlsCertificateDomainStatusType, + LoadBalancerTlsCertificateFailureReasonType, + LoadBalancerTlsCertificateRenewalStatusType, + LoadBalancerTlsCertificateRevocationReasonType, + LoadBalancerTlsCertificateStatusType, + MetricNameType, + MetricStatisticType, + MetricUnitType, + NameServersUpdateStateCodeType, + NetworkProtocolType, + OperationStatusType, + OperationTypeType, + OriginProtocolPolicyEnumType, + PortAccessTypeType, + PortInfoSourceTypeType, + PortStateType, + PricingUnitType, + R53HostedZoneDeletionStateCodeType, + RecordStateType, + RegionNameType, + RelationalDatabaseEngineType, + RelationalDatabaseMetricNameType, + RelationalDatabasePasswordVersionType, + RenewalStatusType, + ResourceBucketAccessType, + ResourceTypeType, + StatusType, + StatusTypeType, + TreatMissingDataType, + LightsailServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccessDirectionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lightsail.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lightsail.type_defs import ( + AccessKeyLastUsedTypeDef, + AccessRulesTypeDef, + AccountLevelBpaSyncTypeDef, + AutoSnapshotAddOnRequestTypeDef, + StopInstanceOnIdleRequestTypeDef, + AddOnTypeDef, + MonitoredResourceInfoTypeDef, + ResourceLocationTypeDef, + AllocateStaticIpRequestRequestTypeDef, + ResponseMetadataTypeDef, + AttachCertificateToDistributionRequestRequestTypeDef, + AttachDiskRequestRequestTypeDef, + AttachInstancesToLoadBalancerRequestRequestTypeDef, + AttachLoadBalancerTlsCertificateRequestRequestTypeDef, + AttachStaticIpRequestRequestTypeDef, + AttachedDiskTypeDef, + AvailabilityZoneTypeDef, + BlueprintTypeDef, + BucketAccessLogConfigTypeDef, + BucketBundleTypeDef, + BucketStateTypeDef, + ResourceReceivingAccessTypeDef, + TagTypeDef, + BundleTypeDef, + CacheBehaviorPerPathTypeDef, + CacheBehaviorTypeDef, + CookieObjectTypeDef, + HeaderObjectTypeDef, + QueryStringObjectTypeDef, + PortInfoTypeDef, + CloudFormationStackRecordSourceInfoTypeDef, + DestinationInfoTypeDef, + ContainerImageTypeDef, + ContainerTypeDef, + ContainerServiceECRImagePullerRoleRequestTypeDef, + ContainerServiceECRImagePullerRoleTypeDef, + ContainerServiceHealthCheckConfigTypeDef, + ContainerServiceLogEventTypeDef, + ContainerServicePowerTypeDef, + ContainerServiceRegistryLoginTypeDef, + ContainerServiceStateDetailTypeDef, + CopySnapshotRequestRequestTypeDef, + CreateBucketAccessKeyRequestRequestTypeDef, + InstanceEntryTypeDef, + CreateContactMethodRequestRequestTypeDef, + InputOriginTypeDef, + DomainEntryTypeDef, + CreateGUISessionAccessDetailsRequestRequestTypeDef, + SessionTypeDef, + DiskMapTypeDef, + DeleteAlarmRequestRequestTypeDef, + DeleteAutoSnapshotRequestRequestTypeDef, + DeleteBucketAccessKeyRequestRequestTypeDef, + DeleteBucketRequestRequestTypeDef, + DeleteCertificateRequestRequestTypeDef, + DeleteContactMethodRequestRequestTypeDef, + DeleteContainerImageRequestRequestTypeDef, + DeleteContainerServiceRequestRequestTypeDef, + DeleteDiskRequestRequestTypeDef, + DeleteDiskSnapshotRequestRequestTypeDef, + DeleteDistributionRequestRequestTypeDef, + DeleteDomainRequestRequestTypeDef, + DeleteInstanceRequestRequestTypeDef, + DeleteInstanceSnapshotRequestRequestTypeDef, + DeleteKeyPairRequestRequestTypeDef, + DeleteKnownHostKeysRequestRequestTypeDef, + DeleteLoadBalancerRequestRequestTypeDef, + DeleteLoadBalancerTlsCertificateRequestRequestTypeDef, + DeleteRelationalDatabaseRequestRequestTypeDef, + DeleteRelationalDatabaseSnapshotRequestRequestTypeDef, + DetachCertificateFromDistributionRequestRequestTypeDef, + DetachDiskRequestRequestTypeDef, + DetachInstancesFromLoadBalancerRequestRequestTypeDef, + DetachStaticIpRequestRequestTypeDef, + DisableAddOnRequestRequestTypeDef, + DiskInfoTypeDef, + DiskSnapshotInfoTypeDef, + DistributionBundleTypeDef, + DnsRecordCreationStateTypeDef, + ResourceRecordTypeDef, + TimePeriodTypeDef, + ExportSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetActiveNamesRequestRequestTypeDef, + GetAlarmsRequestRequestTypeDef, + GetAutoSnapshotsRequestRequestTypeDef, + GetBlueprintsRequestRequestTypeDef, + GetBucketAccessKeysRequestRequestTypeDef, + GetBucketBundlesRequestRequestTypeDef, + GetBucketMetricDataRequestRequestTypeDef, + MetricDatapointTypeDef, + GetBucketsRequestRequestTypeDef, + GetBundlesRequestRequestTypeDef, + GetCertificatesRequestRequestTypeDef, + GetCloudFormationStackRecordsRequestRequestTypeDef, + GetContactMethodsRequestRequestTypeDef, + GetContainerImagesRequestRequestTypeDef, + GetContainerLogRequestRequestTypeDef, + GetContainerServiceDeploymentsRequestRequestTypeDef, + GetContainerServiceMetricDataRequestRequestTypeDef, + GetContainerServicesRequestRequestTypeDef, + GetCostEstimateRequestRequestTypeDef, + GetDiskRequestRequestTypeDef, + GetDiskSnapshotRequestRequestTypeDef, + GetDiskSnapshotsRequestRequestTypeDef, + GetDisksRequestRequestTypeDef, + GetDistributionLatestCacheResetRequestRequestTypeDef, + GetDistributionMetricDataRequestRequestTypeDef, + GetDistributionsRequestRequestTypeDef, + GetDomainRequestRequestTypeDef, + GetDomainsRequestRequestTypeDef, + GetExportSnapshotRecordsRequestRequestTypeDef, + GetInstanceAccessDetailsRequestRequestTypeDef, + GetInstanceMetricDataRequestRequestTypeDef, + GetInstancePortStatesRequestRequestTypeDef, + InstancePortStateTypeDef, + GetInstanceRequestRequestTypeDef, + GetInstanceSnapshotRequestRequestTypeDef, + GetInstanceSnapshotsRequestRequestTypeDef, + GetInstanceStateRequestRequestTypeDef, + InstanceStateTypeDef, + GetInstancesRequestRequestTypeDef, + GetKeyPairRequestRequestTypeDef, + GetKeyPairsRequestRequestTypeDef, + GetLoadBalancerMetricDataRequestRequestTypeDef, + GetLoadBalancerRequestRequestTypeDef, + GetLoadBalancerTlsCertificatesRequestRequestTypeDef, + GetLoadBalancerTlsPoliciesRequestRequestTypeDef, + LoadBalancerTlsPolicyTypeDef, + GetLoadBalancersRequestRequestTypeDef, + GetOperationRequestRequestTypeDef, + GetOperationsForResourceRequestRequestTypeDef, + GetOperationsRequestRequestTypeDef, + GetRegionsRequestRequestTypeDef, + GetRelationalDatabaseBlueprintsRequestRequestTypeDef, + RelationalDatabaseBlueprintTypeDef, + GetRelationalDatabaseBundlesRequestRequestTypeDef, + RelationalDatabaseBundleTypeDef, + GetRelationalDatabaseEventsRequestRequestTypeDef, + RelationalDatabaseEventTypeDef, + GetRelationalDatabaseLogEventsRequestRequestTypeDef, + LogEventTypeDef, + GetRelationalDatabaseLogStreamsRequestRequestTypeDef, + GetRelationalDatabaseMasterUserPasswordRequestRequestTypeDef, + GetRelationalDatabaseMetricDataRequestRequestTypeDef, + GetRelationalDatabaseParametersRequestRequestTypeDef, + RelationalDatabaseParameterTypeDef, + GetRelationalDatabaseRequestRequestTypeDef, + GetRelationalDatabaseSnapshotRequestRequestTypeDef, + GetRelationalDatabaseSnapshotsRequestRequestTypeDef, + GetRelationalDatabasesRequestRequestTypeDef, + GetStaticIpRequestRequestTypeDef, + GetStaticIpsRequestRequestTypeDef, + HostKeyAttributesTypeDef, + ImportKeyPairRequestRequestTypeDef, + PasswordDataTypeDef, + InstanceHealthSummaryTypeDef, + InstanceMetadataOptionsTypeDef, + InstancePortInfoTypeDef, + MonthlyTransferTypeDef, + OriginTypeDef, + LoadBalancerTlsCertificateDnsRecordCreationStateTypeDef, + LoadBalancerTlsCertificateDomainValidationOptionTypeDef, + LoadBalancerTlsCertificateSummaryTypeDef, + NameServersUpdateStateTypeDef, + PendingMaintenanceActionTypeDef, + PendingModifiedRelationalDatabaseValuesTypeDef, + PutAlarmRequestRequestTypeDef, + R53HostedZoneDeletionStateTypeDef, + RebootInstanceRequestRequestTypeDef, + RebootRelationalDatabaseRequestRequestTypeDef, + RegisterContainerImageRequestRequestTypeDef, + RelationalDatabaseEndpointTypeDef, + RelationalDatabaseHardwareTypeDef, + ReleaseStaticIpRequestRequestTypeDef, + ResetDistributionCacheRequestRequestTypeDef, + SendContactMethodVerificationRequestRequestTypeDef, + SetIpAddressTypeRequestRequestTypeDef, + SetResourceAccessForBucketRequestRequestTypeDef, + StartGUISessionRequestRequestTypeDef, + StartInstanceRequestRequestTypeDef, + StartRelationalDatabaseRequestRequestTypeDef, + StopGUISessionRequestRequestTypeDef, + StopInstanceRequestRequestTypeDef, + StopRelationalDatabaseRequestRequestTypeDef, + TestAlarmRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateBucketBundleRequestRequestTypeDef, + UpdateDistributionBundleRequestRequestTypeDef, + UpdateInstanceMetadataOptionsRequestRequestTypeDef, + UpdateLoadBalancerAttributeRequestRequestTypeDef, + UpdateRelationalDatabaseRequestRequestTypeDef, + AccessKeyTypeDef, + AddOnRequestTypeDef, + AlarmTypeDef, + ContactMethodTypeDef, + OperationTypeDef, + StaticIpTypeDef, + DownloadDefaultKeyPairResultTypeDef, + GetActiveNamesResultTypeDef, + GetContainerAPIMetadataResultTypeDef, + GetDistributionLatestCacheResetResultTypeDef, + GetRelationalDatabaseLogStreamsResultTypeDef, + GetRelationalDatabaseMasterUserPasswordResultTypeDef, + IsVpcPeeredResultTypeDef, + AutoSnapshotDetailsTypeDef, + RegionTypeDef, + GetBlueprintsResultTypeDef, + UpdateBucketRequestRequestTypeDef, + GetBucketBundlesResultTypeDef, + BucketTypeDef, + CreateBucketRequestRequestTypeDef, + CreateCertificateRequestRequestTypeDef, + CreateDiskSnapshotRequestRequestTypeDef, + CreateDomainRequestRequestTypeDef, + CreateInstanceSnapshotRequestRequestTypeDef, + CreateKeyPairRequestRequestTypeDef, + CreateLoadBalancerRequestRequestTypeDef, + CreateLoadBalancerTlsCertificateRequestRequestTypeDef, + CreateRelationalDatabaseFromSnapshotRequestRequestTypeDef, + CreateRelationalDatabaseRequestRequestTypeDef, + CreateRelationalDatabaseSnapshotRequestRequestTypeDef, + DiskSnapshotTypeDef, + DiskTypeDef, + KeyPairTypeDef, + RelationalDatabaseSnapshotTypeDef, + TagResourceRequestRequestTypeDef, + GetBundlesResultTypeDef, + CacheSettingsTypeDef, + CloseInstancePublicPortsRequestRequestTypeDef, + OpenInstancePublicPortsRequestRequestTypeDef, + PutInstancePublicPortsRequestRequestTypeDef, + CloudFormationStackRecordTypeDef, + GetContainerImagesResultTypeDef, + RegisterContainerImageResultTypeDef, + PrivateRegistryAccessRequestTypeDef, + PrivateRegistryAccessTypeDef, + ContainerServiceEndpointTypeDef, + EndpointRequestTypeDef, + GetContainerLogResultTypeDef, + GetContainerServicePowersResultTypeDef, + CreateContainerServiceRegistryLoginResultTypeDef, + CreateCloudFormationStackRequestRequestTypeDef, + CreateDomainEntryRequestRequestTypeDef, + DeleteDomainEntryRequestRequestTypeDef, + UpdateDomainEntryRequestRequestTypeDef, + CreateGUISessionAccessDetailsResultTypeDef, + InstanceSnapshotInfoTypeDef, + GetDistributionBundlesResultTypeDef, + DomainValidationRecordTypeDef, + EstimateByTimeTypeDef, + GetActiveNamesRequestGetActiveNamesPaginateTypeDef, + GetBlueprintsRequestGetBlueprintsPaginateTypeDef, + GetBundlesRequestGetBundlesPaginateTypeDef, + GetCloudFormationStackRecordsRequestGetCloudFormationStackRecordsPaginateTypeDef, + GetDiskSnapshotsRequestGetDiskSnapshotsPaginateTypeDef, + GetDisksRequestGetDisksPaginateTypeDef, + GetDomainsRequestGetDomainsPaginateTypeDef, + GetExportSnapshotRecordsRequestGetExportSnapshotRecordsPaginateTypeDef, + GetInstanceSnapshotsRequestGetInstanceSnapshotsPaginateTypeDef, + GetInstancesRequestGetInstancesPaginateTypeDef, + GetKeyPairsRequestGetKeyPairsPaginateTypeDef, + GetLoadBalancersRequestGetLoadBalancersPaginateTypeDef, + GetOperationsRequestGetOperationsPaginateTypeDef, + GetRelationalDatabaseBlueprintsRequestGetRelationalDatabaseBlueprintsPaginateTypeDef, + GetRelationalDatabaseBundlesRequestGetRelationalDatabaseBundlesPaginateTypeDef, + GetRelationalDatabaseEventsRequestGetRelationalDatabaseEventsPaginateTypeDef, + GetRelationalDatabaseParametersRequestGetRelationalDatabaseParametersPaginateTypeDef, + GetRelationalDatabaseSnapshotsRequestGetRelationalDatabaseSnapshotsPaginateTypeDef, + GetRelationalDatabasesRequestGetRelationalDatabasesPaginateTypeDef, + GetStaticIpsRequestGetStaticIpsPaginateTypeDef, + GetBucketMetricDataResultTypeDef, + GetContainerServiceMetricDataResultTypeDef, + GetDistributionMetricDataResultTypeDef, + GetInstanceMetricDataResultTypeDef, + GetLoadBalancerMetricDataResultTypeDef, + GetRelationalDatabaseMetricDataResultTypeDef, + GetInstancePortStatesResultTypeDef, + GetInstanceStateResultTypeDef, + GetLoadBalancerTlsPoliciesResultTypeDef, + GetRelationalDatabaseBlueprintsResultTypeDef, + GetRelationalDatabaseBundlesResultTypeDef, + GetRelationalDatabaseEventsResultTypeDef, + GetRelationalDatabaseLogEventsResultTypeDef, + GetRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseParametersRequestRequestTypeDef, + InstanceAccessDetailsTypeDef, + InstanceNetworkingTypeDef, + LoadBalancerTlsCertificateDomainValidationRecordTypeDef, + LoadBalancerTlsCertificateRenewalSummaryTypeDef, + LoadBalancerTypeDef, + RegisteredDomainDelegationInfoTypeDef, + RelationalDatabaseTypeDef, + GetBucketAccessKeysResultTypeDef, + CreateDiskFromSnapshotRequestRequestTypeDef, + CreateDiskRequestRequestTypeDef, + CreateInstancesFromSnapshotRequestRequestTypeDef, + CreateInstancesRequestRequestTypeDef, + EnableAddOnRequestRequestTypeDef, + GetAlarmsResultTypeDef, + GetContactMethodsResultTypeDef, + AllocateStaticIpResultTypeDef, + AttachCertificateToDistributionResultTypeDef, + AttachDiskResultTypeDef, + AttachInstancesToLoadBalancerResultTypeDef, + AttachLoadBalancerTlsCertificateResultTypeDef, + AttachStaticIpResultTypeDef, + CloseInstancePublicPortsResultTypeDef, + CopySnapshotResultTypeDef, + CreateBucketAccessKeyResultTypeDef, + CreateCloudFormationStackResultTypeDef, + CreateContactMethodResultTypeDef, + CreateDiskFromSnapshotResultTypeDef, + CreateDiskResultTypeDef, + CreateDiskSnapshotResultTypeDef, + CreateDomainEntryResultTypeDef, + CreateDomainResultTypeDef, + CreateInstanceSnapshotResultTypeDef, + CreateInstancesFromSnapshotResultTypeDef, + CreateInstancesResultTypeDef, + CreateLoadBalancerResultTypeDef, + CreateLoadBalancerTlsCertificateResultTypeDef, + CreateRelationalDatabaseFromSnapshotResultTypeDef, + CreateRelationalDatabaseResultTypeDef, + CreateRelationalDatabaseSnapshotResultTypeDef, + DeleteAlarmResultTypeDef, + DeleteAutoSnapshotResultTypeDef, + DeleteBucketAccessKeyResultTypeDef, + DeleteBucketResultTypeDef, + DeleteCertificateResultTypeDef, + DeleteContactMethodResultTypeDef, + DeleteDiskResultTypeDef, + DeleteDiskSnapshotResultTypeDef, + DeleteDistributionResultTypeDef, + DeleteDomainEntryResultTypeDef, + DeleteDomainResultTypeDef, + DeleteInstanceResultTypeDef, + DeleteInstanceSnapshotResultTypeDef, + DeleteKeyPairResultTypeDef, + DeleteKnownHostKeysResultTypeDef, + DeleteLoadBalancerResultTypeDef, + DeleteLoadBalancerTlsCertificateResultTypeDef, + DeleteRelationalDatabaseResultTypeDef, + DeleteRelationalDatabaseSnapshotResultTypeDef, + DetachCertificateFromDistributionResultTypeDef, + DetachDiskResultTypeDef, + DetachInstancesFromLoadBalancerResultTypeDef, + DetachStaticIpResultTypeDef, + DisableAddOnResultTypeDef, + EnableAddOnResultTypeDef, + ExportSnapshotResultTypeDef, + GetOperationResultTypeDef, + GetOperationsForResourceResultTypeDef, + GetOperationsResultTypeDef, + ImportKeyPairResultTypeDef, + OpenInstancePublicPortsResultTypeDef, + PeerVpcResultTypeDef, + PutAlarmResultTypeDef, + PutInstancePublicPortsResultTypeDef, + RebootInstanceResultTypeDef, + RebootRelationalDatabaseResultTypeDef, + ReleaseStaticIpResultTypeDef, + ResetDistributionCacheResultTypeDef, + SendContactMethodVerificationResultTypeDef, + SetIpAddressTypeResultTypeDef, + SetResourceAccessForBucketResultTypeDef, + StartGUISessionResultTypeDef, + StartInstanceResultTypeDef, + StartRelationalDatabaseResultTypeDef, + StopGUISessionResultTypeDef, + StopInstanceResultTypeDef, + StopRelationalDatabaseResultTypeDef, + TagResourceResultTypeDef, + TestAlarmResultTypeDef, + UnpeerVpcResultTypeDef, + UntagResourceResultTypeDef, + UpdateBucketBundleResultTypeDef, + UpdateDistributionBundleResultTypeDef, + UpdateDistributionResultTypeDef, + UpdateDomainEntryResultTypeDef, + UpdateInstanceMetadataOptionsResultTypeDef, + UpdateLoadBalancerAttributeResultTypeDef, + UpdateRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseResultTypeDef, + GetStaticIpResultTypeDef, + GetStaticIpsResultTypeDef, + GetAutoSnapshotsResultTypeDef, + GetRegionsResultTypeDef, + CreateBucketResultTypeDef, + GetBucketsResultTypeDef, + UpdateBucketResultTypeDef, + GetDiskSnapshotResultTypeDef, + GetDiskSnapshotsResultTypeDef, + GetDiskResultTypeDef, + GetDisksResultTypeDef, + InstanceHardwareTypeDef, + InstanceSnapshotTypeDef, + CreateKeyPairResultTypeDef, + GetKeyPairResultTypeDef, + GetKeyPairsResultTypeDef, + GetRelationalDatabaseSnapshotResultTypeDef, + GetRelationalDatabaseSnapshotsResultTypeDef, + CreateDistributionRequestRequestTypeDef, + LightsailDistributionTypeDef, + UpdateDistributionRequestRequestTypeDef, + GetCloudFormationStackRecordsResultTypeDef, + UpdateContainerServiceRequestRequestTypeDef, + ContainerServiceDeploymentTypeDef, + ContainerServiceDeploymentRequestTypeDef, + CreateContainerServiceDeploymentRequestRequestTypeDef, + ExportSnapshotRecordSourceInfoTypeDef, + RenewalSummaryTypeDef, + CostEstimateTypeDef, + GetInstanceAccessDetailsResultTypeDef, + LoadBalancerTlsCertificateTypeDef, + GetLoadBalancerResultTypeDef, + GetLoadBalancersResultTypeDef, + DomainTypeDef, + GetRelationalDatabaseResultTypeDef, + GetRelationalDatabasesResultTypeDef, + InstanceTypeDef, + GetInstanceSnapshotResultTypeDef, + GetInstanceSnapshotsResultTypeDef, + CreateDistributionResultTypeDef, + GetDistributionsResultTypeDef, + ContainerServiceTypeDef, + GetContainerServiceDeploymentsResultTypeDef, + CreateContainerServiceRequestRequestTypeDef, + ExportSnapshotRecordTypeDef, + CertificateTypeDef, + ResourceBudgetEstimateTypeDef, + GetLoadBalancerTlsCertificatesResultTypeDef, + GetDomainResultTypeDef, + GetDomainsResultTypeDef, + GetInstanceResultTypeDef, + GetInstancesResultTypeDef, + ContainerServicesListResultTypeDef, + CreateContainerServiceDeploymentResultTypeDef, + CreateContainerServiceResultTypeDef, + UpdateContainerServiceResultTypeDef, + GetExportSnapshotRecordsResultTypeDef, + CertificateSummaryTypeDef, + GetCostEstimateResultTypeDef, + CreateCertificateResultTypeDef, + GetCertificatesResultTypeDef, +) + + +def get_structure() -> AccessKeyLastUsedTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-lightsail` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-lightsail +Summary: Type annotations for boto3.Lightsail 1.26.81 service generated with mypy-boto3-builder 7.12.4 +Provides: python-mypy-boto3-lightsail +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-lightsail +<a id="mypy-boto3-lightsail"></a> + +# mypy-boto3-lightsail + +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-lightsail) + + + +Type annotations for +[boto3.Lightsail 1.26.81](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lightsail.html#Lightsail) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-lightsail docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lightsail](#mypy-boto3-lightsail) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Lightsail`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lightsail` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lightsail]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[lightsail]' + + +# standalone installation +python -m pip install mypy-boto3-lightsail +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-lightsail +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lightsail]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[lightsail]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`LightsailClient` provides annotations for `boto3.client("lightsail")`. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient + +client: LightsailClient = Session().client("lightsail") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lightsail.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient +from mypy_boto3_lightsail.paginator import ( + GetActiveNamesPaginator, + GetBlueprintsPaginator, + GetBundlesPaginator, + GetCloudFormationStackRecordsPaginator, + GetDiskSnapshotsPaginator, + GetDisksPaginator, + GetDomainsPaginator, + GetExportSnapshotRecordsPaginator, + GetInstanceSnapshotsPaginator, + GetInstancesPaginator, + GetKeyPairsPaginator, + GetLoadBalancersPaginator, + GetOperationsPaginator, + GetRelationalDatabaseBlueprintsPaginator, + GetRelationalDatabaseBundlesPaginator, + GetRelationalDatabaseEventsPaginator, + GetRelationalDatabaseParametersPaginator, + GetRelationalDatabaseSnapshotsPaginator, + GetRelationalDatabasesPaginator, + GetStaticIpsPaginator, +) + +client: LightsailClient = Session().client("lightsail") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_active_names_paginator: GetActiveNamesPaginator = client.get_paginator("get_active_names") +get_blueprints_paginator: GetBlueprintsPaginator = client.get_paginator("get_blueprints") +get_bundles_paginator: GetBundlesPaginator = client.get_paginator("get_bundles") +get_cloud_formation_stack_records_paginator: GetCloudFormationStackRecordsPaginator = ( + client.get_paginator("get_cloud_formation_stack_records") +) +get_disk_snapshots_paginator: GetDiskSnapshotsPaginator = client.get_paginator("get_disk_snapshots") +get_disks_paginator: GetDisksPaginator = client.get_paginator("get_disks") +get_domains_paginator: GetDomainsPaginator = client.get_paginator("get_domains") +get_export_snapshot_records_paginator: GetExportSnapshotRecordsPaginator = client.get_paginator( + "get_export_snapshot_records" +) +get_instance_snapshots_paginator: GetInstanceSnapshotsPaginator = client.get_paginator( + "get_instance_snapshots" +) +get_instances_paginator: GetInstancesPaginator = client.get_paginator("get_instances") +get_key_pairs_paginator: GetKeyPairsPaginator = client.get_paginator("get_key_pairs") +get_load_balancers_paginator: GetLoadBalancersPaginator = client.get_paginator("get_load_balancers") +get_operations_paginator: GetOperationsPaginator = client.get_paginator("get_operations") +get_relational_database_blueprints_paginator: GetRelationalDatabaseBlueprintsPaginator = ( + client.get_paginator("get_relational_database_blueprints") +) +get_relational_database_bundles_paginator: GetRelationalDatabaseBundlesPaginator = ( + client.get_paginator("get_relational_database_bundles") +) +get_relational_database_events_paginator: GetRelationalDatabaseEventsPaginator = ( + client.get_paginator("get_relational_database_events") +) +get_relational_database_parameters_paginator: GetRelationalDatabaseParametersPaginator = ( + client.get_paginator("get_relational_database_parameters") +) +get_relational_database_snapshots_paginator: GetRelationalDatabaseSnapshotsPaginator = ( + client.get_paginator("get_relational_database_snapshots") +) +get_relational_databases_paginator: GetRelationalDatabasesPaginator = client.get_paginator( + "get_relational_databases" +) +get_static_ips_paginator: GetStaticIpsPaginator = client.get_paginator("get_static_ips") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_lightsail.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_lightsail.literals import ( + AccessDirectionType, + AccessTypeType, + AccountLevelBpaSyncStatusType, + AddOnTypeType, + AlarmStateType, + AppCategoryType, + AutoMountStatusType, + AutoSnapshotStatusType, + BPAStatusMessageType, + BehaviorEnumType, + BlueprintTypeType, + BucketMetricNameType, + CertificateDomainValidationStatusType, + CertificateStatusType, + CloudFormationStackRecordSourceTypeType, + ComparisonOperatorType, + ContactMethodStatusType, + ContactMethodVerificationProtocolType, + ContactProtocolType, + ContainerServiceDeploymentStateType, + ContainerServiceMetricNameType, + ContainerServicePowerNameType, + ContainerServiceProtocolType, + ContainerServiceStateDetailCodeType, + ContainerServiceStateType, + CurrencyType, + DiskSnapshotStateType, + DiskStateType, + DistributionMetricNameType, + DnsRecordCreationStateCodeType, + ExportSnapshotRecordSourceTypeType, + ForwardValuesType, + GetActiveNamesPaginatorName, + GetBlueprintsPaginatorName, + GetBundlesPaginatorName, + GetCloudFormationStackRecordsPaginatorName, + GetDiskSnapshotsPaginatorName, + GetDisksPaginatorName, + GetDomainsPaginatorName, + GetExportSnapshotRecordsPaginatorName, + GetInstanceSnapshotsPaginatorName, + GetInstancesPaginatorName, + GetKeyPairsPaginatorName, + GetLoadBalancersPaginatorName, + GetOperationsPaginatorName, + GetRelationalDatabaseBlueprintsPaginatorName, + GetRelationalDatabaseBundlesPaginatorName, + GetRelationalDatabaseEventsPaginatorName, + GetRelationalDatabaseParametersPaginatorName, + GetRelationalDatabaseSnapshotsPaginatorName, + GetRelationalDatabasesPaginatorName, + GetStaticIpsPaginatorName, + HeaderEnumType, + HttpEndpointType, + HttpProtocolIpv6Type, + HttpTokensType, + InstanceAccessProtocolType, + InstanceHealthReasonType, + InstanceHealthStateType, + InstanceMetadataStateType, + InstanceMetricNameType, + InstancePlatformType, + InstanceSnapshotStateType, + IpAddressTypeType, + LoadBalancerAttributeNameType, + LoadBalancerMetricNameType, + LoadBalancerProtocolType, + LoadBalancerStateType, + LoadBalancerTlsCertificateDnsRecordCreationStateCodeType, + LoadBalancerTlsCertificateDomainStatusType, + LoadBalancerTlsCertificateFailureReasonType, + LoadBalancerTlsCertificateRenewalStatusType, + LoadBalancerTlsCertificateRevocationReasonType, + LoadBalancerTlsCertificateStatusType, + MetricNameType, + MetricStatisticType, + MetricUnitType, + NameServersUpdateStateCodeType, + NetworkProtocolType, + OperationStatusType, + OperationTypeType, + OriginProtocolPolicyEnumType, + PortAccessTypeType, + PortInfoSourceTypeType, + PortStateType, + PricingUnitType, + R53HostedZoneDeletionStateCodeType, + RecordStateType, + RegionNameType, + RelationalDatabaseEngineType, + RelationalDatabaseMetricNameType, + RelationalDatabasePasswordVersionType, + RenewalStatusType, + ResourceBucketAccessType, + ResourceTypeType, + StatusType, + StatusTypeType, + TreatMissingDataType, + LightsailServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccessDirectionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lightsail.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lightsail.type_defs import ( + AccessKeyLastUsedTypeDef, + AccessRulesTypeDef, + AccountLevelBpaSyncTypeDef, + AutoSnapshotAddOnRequestTypeDef, + StopInstanceOnIdleRequestTypeDef, + AddOnTypeDef, + MonitoredResourceInfoTypeDef, + ResourceLocationTypeDef, + AllocateStaticIpRequestRequestTypeDef, + ResponseMetadataTypeDef, + AttachCertificateToDistributionRequestRequestTypeDef, + AttachDiskRequestRequestTypeDef, + AttachInstancesToLoadBalancerRequestRequestTypeDef, + AttachLoadBalancerTlsCertificateRequestRequestTypeDef, + AttachStaticIpRequestRequestTypeDef, + AttachedDiskTypeDef, + AvailabilityZoneTypeDef, + BlueprintTypeDef, + BucketAccessLogConfigTypeDef, + BucketBundleTypeDef, + BucketStateTypeDef, + ResourceReceivingAccessTypeDef, + TagTypeDef, + BundleTypeDef, + CacheBehaviorPerPathTypeDef, + CacheBehaviorTypeDef, + CookieObjectTypeDef, + HeaderObjectTypeDef, + QueryStringObjectTypeDef, + PortInfoTypeDef, + CloudFormationStackRecordSourceInfoTypeDef, + DestinationInfoTypeDef, + ContainerImageTypeDef, + ContainerTypeDef, + ContainerServiceECRImagePullerRoleRequestTypeDef, + ContainerServiceECRImagePullerRoleTypeDef, + ContainerServiceHealthCheckConfigTypeDef, + ContainerServiceLogEventTypeDef, + ContainerServicePowerTypeDef, + ContainerServiceRegistryLoginTypeDef, + ContainerServiceStateDetailTypeDef, + CopySnapshotRequestRequestTypeDef, + CreateBucketAccessKeyRequestRequestTypeDef, + InstanceEntryTypeDef, + CreateContactMethodRequestRequestTypeDef, + InputOriginTypeDef, + DomainEntryTypeDef, + CreateGUISessionAccessDetailsRequestRequestTypeDef, + SessionTypeDef, + DiskMapTypeDef, + DeleteAlarmRequestRequestTypeDef, + DeleteAutoSnapshotRequestRequestTypeDef, + DeleteBucketAccessKeyRequestRequestTypeDef, + DeleteBucketRequestRequestTypeDef, + DeleteCertificateRequestRequestTypeDef, + DeleteContactMethodRequestRequestTypeDef, + DeleteContainerImageRequestRequestTypeDef, + DeleteContainerServiceRequestRequestTypeDef, + DeleteDiskRequestRequestTypeDef, + DeleteDiskSnapshotRequestRequestTypeDef, + DeleteDistributionRequestRequestTypeDef, + DeleteDomainRequestRequestTypeDef, + DeleteInstanceRequestRequestTypeDef, + DeleteInstanceSnapshotRequestRequestTypeDef, + DeleteKeyPairRequestRequestTypeDef, + DeleteKnownHostKeysRequestRequestTypeDef, + DeleteLoadBalancerRequestRequestTypeDef, + DeleteLoadBalancerTlsCertificateRequestRequestTypeDef, + DeleteRelationalDatabaseRequestRequestTypeDef, + DeleteRelationalDatabaseSnapshotRequestRequestTypeDef, + DetachCertificateFromDistributionRequestRequestTypeDef, + DetachDiskRequestRequestTypeDef, + DetachInstancesFromLoadBalancerRequestRequestTypeDef, + DetachStaticIpRequestRequestTypeDef, + DisableAddOnRequestRequestTypeDef, + DiskInfoTypeDef, + DiskSnapshotInfoTypeDef, + DistributionBundleTypeDef, + DnsRecordCreationStateTypeDef, + ResourceRecordTypeDef, + TimePeriodTypeDef, + ExportSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetActiveNamesRequestRequestTypeDef, + GetAlarmsRequestRequestTypeDef, + GetAutoSnapshotsRequestRequestTypeDef, + GetBlueprintsRequestRequestTypeDef, + GetBucketAccessKeysRequestRequestTypeDef, + GetBucketBundlesRequestRequestTypeDef, + GetBucketMetricDataRequestRequestTypeDef, + MetricDatapointTypeDef, + GetBucketsRequestRequestTypeDef, + GetBundlesRequestRequestTypeDef, + GetCertificatesRequestRequestTypeDef, + GetCloudFormationStackRecordsRequestRequestTypeDef, + GetContactMethodsRequestRequestTypeDef, + GetContainerImagesRequestRequestTypeDef, + GetContainerLogRequestRequestTypeDef, + GetContainerServiceDeploymentsRequestRequestTypeDef, + GetContainerServiceMetricDataRequestRequestTypeDef, + GetContainerServicesRequestRequestTypeDef, + GetCostEstimateRequestRequestTypeDef, + GetDiskRequestRequestTypeDef, + GetDiskSnapshotRequestRequestTypeDef, + GetDiskSnapshotsRequestRequestTypeDef, + GetDisksRequestRequestTypeDef, + GetDistributionLatestCacheResetRequestRequestTypeDef, + GetDistributionMetricDataRequestRequestTypeDef, + GetDistributionsRequestRequestTypeDef, + GetDomainRequestRequestTypeDef, + GetDomainsRequestRequestTypeDef, + GetExportSnapshotRecordsRequestRequestTypeDef, + GetInstanceAccessDetailsRequestRequestTypeDef, + GetInstanceMetricDataRequestRequestTypeDef, + GetInstancePortStatesRequestRequestTypeDef, + InstancePortStateTypeDef, + GetInstanceRequestRequestTypeDef, + GetInstanceSnapshotRequestRequestTypeDef, + GetInstanceSnapshotsRequestRequestTypeDef, + GetInstanceStateRequestRequestTypeDef, + InstanceStateTypeDef, + GetInstancesRequestRequestTypeDef, + GetKeyPairRequestRequestTypeDef, + GetKeyPairsRequestRequestTypeDef, + GetLoadBalancerMetricDataRequestRequestTypeDef, + GetLoadBalancerRequestRequestTypeDef, + GetLoadBalancerTlsCertificatesRequestRequestTypeDef, + GetLoadBalancerTlsPoliciesRequestRequestTypeDef, + LoadBalancerTlsPolicyTypeDef, + GetLoadBalancersRequestRequestTypeDef, + GetOperationRequestRequestTypeDef, + GetOperationsForResourceRequestRequestTypeDef, + GetOperationsRequestRequestTypeDef, + GetRegionsRequestRequestTypeDef, + GetRelationalDatabaseBlueprintsRequestRequestTypeDef, + RelationalDatabaseBlueprintTypeDef, + GetRelationalDatabaseBundlesRequestRequestTypeDef, + RelationalDatabaseBundleTypeDef, + GetRelationalDatabaseEventsRequestRequestTypeDef, + RelationalDatabaseEventTypeDef, + GetRelationalDatabaseLogEventsRequestRequestTypeDef, + LogEventTypeDef, + GetRelationalDatabaseLogStreamsRequestRequestTypeDef, + GetRelationalDatabaseMasterUserPasswordRequestRequestTypeDef, + GetRelationalDatabaseMetricDataRequestRequestTypeDef, + GetRelationalDatabaseParametersRequestRequestTypeDef, + RelationalDatabaseParameterTypeDef, + GetRelationalDatabaseRequestRequestTypeDef, + GetRelationalDatabaseSnapshotRequestRequestTypeDef, + GetRelationalDatabaseSnapshotsRequestRequestTypeDef, + GetRelationalDatabasesRequestRequestTypeDef, + GetStaticIpRequestRequestTypeDef, + GetStaticIpsRequestRequestTypeDef, + HostKeyAttributesTypeDef, + ImportKeyPairRequestRequestTypeDef, + PasswordDataTypeDef, + InstanceHealthSummaryTypeDef, + InstanceMetadataOptionsTypeDef, + InstancePortInfoTypeDef, + MonthlyTransferTypeDef, + OriginTypeDef, + LoadBalancerTlsCertificateDnsRecordCreationStateTypeDef, + LoadBalancerTlsCertificateDomainValidationOptionTypeDef, + LoadBalancerTlsCertificateSummaryTypeDef, + NameServersUpdateStateTypeDef, + PendingMaintenanceActionTypeDef, + PendingModifiedRelationalDatabaseValuesTypeDef, + PutAlarmRequestRequestTypeDef, + R53HostedZoneDeletionStateTypeDef, + RebootInstanceRequestRequestTypeDef, + RebootRelationalDatabaseRequestRequestTypeDef, + RegisterContainerImageRequestRequestTypeDef, + RelationalDatabaseEndpointTypeDef, + RelationalDatabaseHardwareTypeDef, + ReleaseStaticIpRequestRequestTypeDef, + ResetDistributionCacheRequestRequestTypeDef, + SendContactMethodVerificationRequestRequestTypeDef, + SetIpAddressTypeRequestRequestTypeDef, + SetResourceAccessForBucketRequestRequestTypeDef, + StartGUISessionRequestRequestTypeDef, + StartInstanceRequestRequestTypeDef, + StartRelationalDatabaseRequestRequestTypeDef, + StopGUISessionRequestRequestTypeDef, + StopInstanceRequestRequestTypeDef, + StopRelationalDatabaseRequestRequestTypeDef, + TestAlarmRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateBucketBundleRequestRequestTypeDef, + UpdateDistributionBundleRequestRequestTypeDef, + UpdateInstanceMetadataOptionsRequestRequestTypeDef, + UpdateLoadBalancerAttributeRequestRequestTypeDef, + UpdateRelationalDatabaseRequestRequestTypeDef, + AccessKeyTypeDef, + AddOnRequestTypeDef, + AlarmTypeDef, + ContactMethodTypeDef, + OperationTypeDef, + StaticIpTypeDef, + DownloadDefaultKeyPairResultTypeDef, + GetActiveNamesResultTypeDef, + GetContainerAPIMetadataResultTypeDef, + GetDistributionLatestCacheResetResultTypeDef, + GetRelationalDatabaseLogStreamsResultTypeDef, + GetRelationalDatabaseMasterUserPasswordResultTypeDef, + IsVpcPeeredResultTypeDef, + AutoSnapshotDetailsTypeDef, + RegionTypeDef, + GetBlueprintsResultTypeDef, + UpdateBucketRequestRequestTypeDef, + GetBucketBundlesResultTypeDef, + BucketTypeDef, + CreateBucketRequestRequestTypeDef, + CreateCertificateRequestRequestTypeDef, + CreateDiskSnapshotRequestRequestTypeDef, + CreateDomainRequestRequestTypeDef, + CreateInstanceSnapshotRequestRequestTypeDef, + CreateKeyPairRequestRequestTypeDef, + CreateLoadBalancerRequestRequestTypeDef, + CreateLoadBalancerTlsCertificateRequestRequestTypeDef, + CreateRelationalDatabaseFromSnapshotRequestRequestTypeDef, + CreateRelationalDatabaseRequestRequestTypeDef, + CreateRelationalDatabaseSnapshotRequestRequestTypeDef, + DiskSnapshotTypeDef, + DiskTypeDef, + KeyPairTypeDef, + RelationalDatabaseSnapshotTypeDef, + TagResourceRequestRequestTypeDef, + GetBundlesResultTypeDef, + CacheSettingsTypeDef, + CloseInstancePublicPortsRequestRequestTypeDef, + OpenInstancePublicPortsRequestRequestTypeDef, + PutInstancePublicPortsRequestRequestTypeDef, + CloudFormationStackRecordTypeDef, + GetContainerImagesResultTypeDef, + RegisterContainerImageResultTypeDef, + PrivateRegistryAccessRequestTypeDef, + PrivateRegistryAccessTypeDef, + ContainerServiceEndpointTypeDef, + EndpointRequestTypeDef, + GetContainerLogResultTypeDef, + GetContainerServicePowersResultTypeDef, + CreateContainerServiceRegistryLoginResultTypeDef, + CreateCloudFormationStackRequestRequestTypeDef, + CreateDomainEntryRequestRequestTypeDef, + DeleteDomainEntryRequestRequestTypeDef, + UpdateDomainEntryRequestRequestTypeDef, + CreateGUISessionAccessDetailsResultTypeDef, + InstanceSnapshotInfoTypeDef, + GetDistributionBundlesResultTypeDef, + DomainValidationRecordTypeDef, + EstimateByTimeTypeDef, + GetActiveNamesRequestGetActiveNamesPaginateTypeDef, + GetBlueprintsRequestGetBlueprintsPaginateTypeDef, + GetBundlesRequestGetBundlesPaginateTypeDef, + GetCloudFormationStackRecordsRequestGetCloudFormationStackRecordsPaginateTypeDef, + GetDiskSnapshotsRequestGetDiskSnapshotsPaginateTypeDef, + GetDisksRequestGetDisksPaginateTypeDef, + GetDomainsRequestGetDomainsPaginateTypeDef, + GetExportSnapshotRecordsRequestGetExportSnapshotRecordsPaginateTypeDef, + GetInstanceSnapshotsRequestGetInstanceSnapshotsPaginateTypeDef, + GetInstancesRequestGetInstancesPaginateTypeDef, + GetKeyPairsRequestGetKeyPairsPaginateTypeDef, + GetLoadBalancersRequestGetLoadBalancersPaginateTypeDef, + GetOperationsRequestGetOperationsPaginateTypeDef, + GetRelationalDatabaseBlueprintsRequestGetRelationalDatabaseBlueprintsPaginateTypeDef, + GetRelationalDatabaseBundlesRequestGetRelationalDatabaseBundlesPaginateTypeDef, + GetRelationalDatabaseEventsRequestGetRelationalDatabaseEventsPaginateTypeDef, + GetRelationalDatabaseParametersRequestGetRelationalDatabaseParametersPaginateTypeDef, + GetRelationalDatabaseSnapshotsRequestGetRelationalDatabaseSnapshotsPaginateTypeDef, + GetRelationalDatabasesRequestGetRelationalDatabasesPaginateTypeDef, + GetStaticIpsRequestGetStaticIpsPaginateTypeDef, + GetBucketMetricDataResultTypeDef, + GetContainerServiceMetricDataResultTypeDef, + GetDistributionMetricDataResultTypeDef, + GetInstanceMetricDataResultTypeDef, + GetLoadBalancerMetricDataResultTypeDef, + GetRelationalDatabaseMetricDataResultTypeDef, + GetInstancePortStatesResultTypeDef, + GetInstanceStateResultTypeDef, + GetLoadBalancerTlsPoliciesResultTypeDef, + GetRelationalDatabaseBlueprintsResultTypeDef, + GetRelationalDatabaseBundlesResultTypeDef, + GetRelationalDatabaseEventsResultTypeDef, + GetRelationalDatabaseLogEventsResultTypeDef, + GetRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseParametersRequestRequestTypeDef, + InstanceAccessDetailsTypeDef, + InstanceNetworkingTypeDef, + LoadBalancerTlsCertificateDomainValidationRecordTypeDef, + LoadBalancerTlsCertificateRenewalSummaryTypeDef, + LoadBalancerTypeDef, + RegisteredDomainDelegationInfoTypeDef, + RelationalDatabaseTypeDef, + GetBucketAccessKeysResultTypeDef, + CreateDiskFromSnapshotRequestRequestTypeDef, + CreateDiskRequestRequestTypeDef, + CreateInstancesFromSnapshotRequestRequestTypeDef, + CreateInstancesRequestRequestTypeDef, + EnableAddOnRequestRequestTypeDef, + GetAlarmsResultTypeDef, + GetContactMethodsResultTypeDef, + AllocateStaticIpResultTypeDef, + AttachCertificateToDistributionResultTypeDef, + AttachDiskResultTypeDef, + AttachInstancesToLoadBalancerResultTypeDef, + AttachLoadBalancerTlsCertificateResultTypeDef, + AttachStaticIpResultTypeDef, + CloseInstancePublicPortsResultTypeDef, + CopySnapshotResultTypeDef, + CreateBucketAccessKeyResultTypeDef, + CreateCloudFormationStackResultTypeDef, + CreateContactMethodResultTypeDef, + CreateDiskFromSnapshotResultTypeDef, + CreateDiskResultTypeDef, + CreateDiskSnapshotResultTypeDef, + CreateDomainEntryResultTypeDef, + CreateDomainResultTypeDef, + CreateInstanceSnapshotResultTypeDef, + CreateInstancesFromSnapshotResultTypeDef, + CreateInstancesResultTypeDef, + CreateLoadBalancerResultTypeDef, + CreateLoadBalancerTlsCertificateResultTypeDef, + CreateRelationalDatabaseFromSnapshotResultTypeDef, + CreateRelationalDatabaseResultTypeDef, + CreateRelationalDatabaseSnapshotResultTypeDef, + DeleteAlarmResultTypeDef, + DeleteAutoSnapshotResultTypeDef, + DeleteBucketAccessKeyResultTypeDef, + DeleteBucketResultTypeDef, + DeleteCertificateResultTypeDef, + DeleteContactMethodResultTypeDef, + DeleteDiskResultTypeDef, + DeleteDiskSnapshotResultTypeDef, + DeleteDistributionResultTypeDef, + DeleteDomainEntryResultTypeDef, + DeleteDomainResultTypeDef, + DeleteInstanceResultTypeDef, + DeleteInstanceSnapshotResultTypeDef, + DeleteKeyPairResultTypeDef, + DeleteKnownHostKeysResultTypeDef, + DeleteLoadBalancerResultTypeDef, + DeleteLoadBalancerTlsCertificateResultTypeDef, + DeleteRelationalDatabaseResultTypeDef, + DeleteRelationalDatabaseSnapshotResultTypeDef, + DetachCertificateFromDistributionResultTypeDef, + DetachDiskResultTypeDef, + DetachInstancesFromLoadBalancerResultTypeDef, + DetachStaticIpResultTypeDef, + DisableAddOnResultTypeDef, + EnableAddOnResultTypeDef, + ExportSnapshotResultTypeDef, + GetOperationResultTypeDef, + GetOperationsForResourceResultTypeDef, + GetOperationsResultTypeDef, + ImportKeyPairResultTypeDef, + OpenInstancePublicPortsResultTypeDef, + PeerVpcResultTypeDef, + PutAlarmResultTypeDef, + PutInstancePublicPortsResultTypeDef, + RebootInstanceResultTypeDef, + RebootRelationalDatabaseResultTypeDef, + ReleaseStaticIpResultTypeDef, + ResetDistributionCacheResultTypeDef, + SendContactMethodVerificationResultTypeDef, + SetIpAddressTypeResultTypeDef, + SetResourceAccessForBucketResultTypeDef, + StartGUISessionResultTypeDef, + StartInstanceResultTypeDef, + StartRelationalDatabaseResultTypeDef, + StopGUISessionResultTypeDef, + StopInstanceResultTypeDef, + StopRelationalDatabaseResultTypeDef, + TagResourceResultTypeDef, + TestAlarmResultTypeDef, + UnpeerVpcResultTypeDef, + UntagResourceResultTypeDef, + UpdateBucketBundleResultTypeDef, + UpdateDistributionBundleResultTypeDef, + UpdateDistributionResultTypeDef, + UpdateDomainEntryResultTypeDef, + UpdateInstanceMetadataOptionsResultTypeDef, + UpdateLoadBalancerAttributeResultTypeDef, + UpdateRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseResultTypeDef, + GetStaticIpResultTypeDef, + GetStaticIpsResultTypeDef, + GetAutoSnapshotsResultTypeDef, + GetRegionsResultTypeDef, + CreateBucketResultTypeDef, + GetBucketsResultTypeDef, + UpdateBucketResultTypeDef, + GetDiskSnapshotResultTypeDef, + GetDiskSnapshotsResultTypeDef, + GetDiskResultTypeDef, + GetDisksResultTypeDef, + InstanceHardwareTypeDef, + InstanceSnapshotTypeDef, + CreateKeyPairResultTypeDef, + GetKeyPairResultTypeDef, + GetKeyPairsResultTypeDef, + GetRelationalDatabaseSnapshotResultTypeDef, + GetRelationalDatabaseSnapshotsResultTypeDef, + CreateDistributionRequestRequestTypeDef, + LightsailDistributionTypeDef, + UpdateDistributionRequestRequestTypeDef, + GetCloudFormationStackRecordsResultTypeDef, + UpdateContainerServiceRequestRequestTypeDef, + ContainerServiceDeploymentTypeDef, + ContainerServiceDeploymentRequestTypeDef, + CreateContainerServiceDeploymentRequestRequestTypeDef, + ExportSnapshotRecordSourceInfoTypeDef, + RenewalSummaryTypeDef, + CostEstimateTypeDef, + GetInstanceAccessDetailsResultTypeDef, + LoadBalancerTlsCertificateTypeDef, + GetLoadBalancerResultTypeDef, + GetLoadBalancersResultTypeDef, + DomainTypeDef, + GetRelationalDatabaseResultTypeDef, + GetRelationalDatabasesResultTypeDef, + InstanceTypeDef, + GetInstanceSnapshotResultTypeDef, + GetInstanceSnapshotsResultTypeDef, + CreateDistributionResultTypeDef, + GetDistributionsResultTypeDef, + ContainerServiceTypeDef, + GetContainerServiceDeploymentsResultTypeDef, + CreateContainerServiceRequestRequestTypeDef, + ExportSnapshotRecordTypeDef, + CertificateTypeDef, + ResourceBudgetEstimateTypeDef, + GetLoadBalancerTlsCertificatesResultTypeDef, + GetDomainResultTypeDef, + GetDomainsResultTypeDef, + GetInstanceResultTypeDef, + GetInstancesResultTypeDef, + ContainerServicesListResultTypeDef, + CreateContainerServiceDeploymentResultTypeDef, + CreateContainerServiceResultTypeDef, + UpdateContainerServiceResultTypeDef, + GetExportSnapshotRecordsResultTypeDef, + CertificateSummaryTypeDef, + GetCostEstimateResultTypeDef, + CreateCertificateResultTypeDef, + GetCertificatesResultTypeDef, +) + + +def get_structure() -> AccessKeyLastUsedTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-lightsail` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-lightsail +Provides: python3-mypy-boto3-lightsail-doc +%description help +<a id="mypy-boto3-lightsail"></a> + +# mypy-boto3-lightsail + +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://pypi.org/project/mypy-boto3-lightsail) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-lightsail) + + + +Type annotations for +[boto3.Lightsail 1.26.81](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lightsail.html#Lightsail) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.12.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-lightsail docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lightsail](#mypy-boto3-lightsail) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Lightsail`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lightsail` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lightsail]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[lightsail]' + + +# standalone installation +python -m pip install mypy-boto3-lightsail +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-lightsail +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lightsail]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[lightsail]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[lightsail]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lightsail]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`LightsailClient` provides annotations for `boto3.client("lightsail")`. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient + +client: LightsailClient = Session().client("lightsail") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lightsail.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lightsail import LightsailClient +from mypy_boto3_lightsail.paginator import ( + GetActiveNamesPaginator, + GetBlueprintsPaginator, + GetBundlesPaginator, + GetCloudFormationStackRecordsPaginator, + GetDiskSnapshotsPaginator, + GetDisksPaginator, + GetDomainsPaginator, + GetExportSnapshotRecordsPaginator, + GetInstanceSnapshotsPaginator, + GetInstancesPaginator, + GetKeyPairsPaginator, + GetLoadBalancersPaginator, + GetOperationsPaginator, + GetRelationalDatabaseBlueprintsPaginator, + GetRelationalDatabaseBundlesPaginator, + GetRelationalDatabaseEventsPaginator, + GetRelationalDatabaseParametersPaginator, + GetRelationalDatabaseSnapshotsPaginator, + GetRelationalDatabasesPaginator, + GetStaticIpsPaginator, +) + +client: LightsailClient = Session().client("lightsail") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_active_names_paginator: GetActiveNamesPaginator = client.get_paginator("get_active_names") +get_blueprints_paginator: GetBlueprintsPaginator = client.get_paginator("get_blueprints") +get_bundles_paginator: GetBundlesPaginator = client.get_paginator("get_bundles") +get_cloud_formation_stack_records_paginator: GetCloudFormationStackRecordsPaginator = ( + client.get_paginator("get_cloud_formation_stack_records") +) +get_disk_snapshots_paginator: GetDiskSnapshotsPaginator = client.get_paginator("get_disk_snapshots") +get_disks_paginator: GetDisksPaginator = client.get_paginator("get_disks") +get_domains_paginator: GetDomainsPaginator = client.get_paginator("get_domains") +get_export_snapshot_records_paginator: GetExportSnapshotRecordsPaginator = client.get_paginator( + "get_export_snapshot_records" +) +get_instance_snapshots_paginator: GetInstanceSnapshotsPaginator = client.get_paginator( + "get_instance_snapshots" +) +get_instances_paginator: GetInstancesPaginator = client.get_paginator("get_instances") +get_key_pairs_paginator: GetKeyPairsPaginator = client.get_paginator("get_key_pairs") +get_load_balancers_paginator: GetLoadBalancersPaginator = client.get_paginator("get_load_balancers") +get_operations_paginator: GetOperationsPaginator = client.get_paginator("get_operations") +get_relational_database_blueprints_paginator: GetRelationalDatabaseBlueprintsPaginator = ( + client.get_paginator("get_relational_database_blueprints") +) +get_relational_database_bundles_paginator: GetRelationalDatabaseBundlesPaginator = ( + client.get_paginator("get_relational_database_bundles") +) +get_relational_database_events_paginator: GetRelationalDatabaseEventsPaginator = ( + client.get_paginator("get_relational_database_events") +) +get_relational_database_parameters_paginator: GetRelationalDatabaseParametersPaginator = ( + client.get_paginator("get_relational_database_parameters") +) +get_relational_database_snapshots_paginator: GetRelationalDatabaseSnapshotsPaginator = ( + client.get_paginator("get_relational_database_snapshots") +) +get_relational_databases_paginator: GetRelationalDatabasesPaginator = client.get_paginator( + "get_relational_databases" +) +get_static_ips_paginator: GetStaticIpsPaginator = client.get_paginator("get_static_ips") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_lightsail.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_lightsail.literals import ( + AccessDirectionType, + AccessTypeType, + AccountLevelBpaSyncStatusType, + AddOnTypeType, + AlarmStateType, + AppCategoryType, + AutoMountStatusType, + AutoSnapshotStatusType, + BPAStatusMessageType, + BehaviorEnumType, + BlueprintTypeType, + BucketMetricNameType, + CertificateDomainValidationStatusType, + CertificateStatusType, + CloudFormationStackRecordSourceTypeType, + ComparisonOperatorType, + ContactMethodStatusType, + ContactMethodVerificationProtocolType, + ContactProtocolType, + ContainerServiceDeploymentStateType, + ContainerServiceMetricNameType, + ContainerServicePowerNameType, + ContainerServiceProtocolType, + ContainerServiceStateDetailCodeType, + ContainerServiceStateType, + CurrencyType, + DiskSnapshotStateType, + DiskStateType, + DistributionMetricNameType, + DnsRecordCreationStateCodeType, + ExportSnapshotRecordSourceTypeType, + ForwardValuesType, + GetActiveNamesPaginatorName, + GetBlueprintsPaginatorName, + GetBundlesPaginatorName, + GetCloudFormationStackRecordsPaginatorName, + GetDiskSnapshotsPaginatorName, + GetDisksPaginatorName, + GetDomainsPaginatorName, + GetExportSnapshotRecordsPaginatorName, + GetInstanceSnapshotsPaginatorName, + GetInstancesPaginatorName, + GetKeyPairsPaginatorName, + GetLoadBalancersPaginatorName, + GetOperationsPaginatorName, + GetRelationalDatabaseBlueprintsPaginatorName, + GetRelationalDatabaseBundlesPaginatorName, + GetRelationalDatabaseEventsPaginatorName, + GetRelationalDatabaseParametersPaginatorName, + GetRelationalDatabaseSnapshotsPaginatorName, + GetRelationalDatabasesPaginatorName, + GetStaticIpsPaginatorName, + HeaderEnumType, + HttpEndpointType, + HttpProtocolIpv6Type, + HttpTokensType, + InstanceAccessProtocolType, + InstanceHealthReasonType, + InstanceHealthStateType, + InstanceMetadataStateType, + InstanceMetricNameType, + InstancePlatformType, + InstanceSnapshotStateType, + IpAddressTypeType, + LoadBalancerAttributeNameType, + LoadBalancerMetricNameType, + LoadBalancerProtocolType, + LoadBalancerStateType, + LoadBalancerTlsCertificateDnsRecordCreationStateCodeType, + LoadBalancerTlsCertificateDomainStatusType, + LoadBalancerTlsCertificateFailureReasonType, + LoadBalancerTlsCertificateRenewalStatusType, + LoadBalancerTlsCertificateRevocationReasonType, + LoadBalancerTlsCertificateStatusType, + MetricNameType, + MetricStatisticType, + MetricUnitType, + NameServersUpdateStateCodeType, + NetworkProtocolType, + OperationStatusType, + OperationTypeType, + OriginProtocolPolicyEnumType, + PortAccessTypeType, + PortInfoSourceTypeType, + PortStateType, + PricingUnitType, + R53HostedZoneDeletionStateCodeType, + RecordStateType, + RegionNameType, + RelationalDatabaseEngineType, + RelationalDatabaseMetricNameType, + RelationalDatabasePasswordVersionType, + RenewalStatusType, + ResourceBucketAccessType, + ResourceTypeType, + StatusType, + StatusTypeType, + TreatMissingDataType, + LightsailServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccessDirectionType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lightsail.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lightsail.type_defs import ( + AccessKeyLastUsedTypeDef, + AccessRulesTypeDef, + AccountLevelBpaSyncTypeDef, + AutoSnapshotAddOnRequestTypeDef, + StopInstanceOnIdleRequestTypeDef, + AddOnTypeDef, + MonitoredResourceInfoTypeDef, + ResourceLocationTypeDef, + AllocateStaticIpRequestRequestTypeDef, + ResponseMetadataTypeDef, + AttachCertificateToDistributionRequestRequestTypeDef, + AttachDiskRequestRequestTypeDef, + AttachInstancesToLoadBalancerRequestRequestTypeDef, + AttachLoadBalancerTlsCertificateRequestRequestTypeDef, + AttachStaticIpRequestRequestTypeDef, + AttachedDiskTypeDef, + AvailabilityZoneTypeDef, + BlueprintTypeDef, + BucketAccessLogConfigTypeDef, + BucketBundleTypeDef, + BucketStateTypeDef, + ResourceReceivingAccessTypeDef, + TagTypeDef, + BundleTypeDef, + CacheBehaviorPerPathTypeDef, + CacheBehaviorTypeDef, + CookieObjectTypeDef, + HeaderObjectTypeDef, + QueryStringObjectTypeDef, + PortInfoTypeDef, + CloudFormationStackRecordSourceInfoTypeDef, + DestinationInfoTypeDef, + ContainerImageTypeDef, + ContainerTypeDef, + ContainerServiceECRImagePullerRoleRequestTypeDef, + ContainerServiceECRImagePullerRoleTypeDef, + ContainerServiceHealthCheckConfigTypeDef, + ContainerServiceLogEventTypeDef, + ContainerServicePowerTypeDef, + ContainerServiceRegistryLoginTypeDef, + ContainerServiceStateDetailTypeDef, + CopySnapshotRequestRequestTypeDef, + CreateBucketAccessKeyRequestRequestTypeDef, + InstanceEntryTypeDef, + CreateContactMethodRequestRequestTypeDef, + InputOriginTypeDef, + DomainEntryTypeDef, + CreateGUISessionAccessDetailsRequestRequestTypeDef, + SessionTypeDef, + DiskMapTypeDef, + DeleteAlarmRequestRequestTypeDef, + DeleteAutoSnapshotRequestRequestTypeDef, + DeleteBucketAccessKeyRequestRequestTypeDef, + DeleteBucketRequestRequestTypeDef, + DeleteCertificateRequestRequestTypeDef, + DeleteContactMethodRequestRequestTypeDef, + DeleteContainerImageRequestRequestTypeDef, + DeleteContainerServiceRequestRequestTypeDef, + DeleteDiskRequestRequestTypeDef, + DeleteDiskSnapshotRequestRequestTypeDef, + DeleteDistributionRequestRequestTypeDef, + DeleteDomainRequestRequestTypeDef, + DeleteInstanceRequestRequestTypeDef, + DeleteInstanceSnapshotRequestRequestTypeDef, + DeleteKeyPairRequestRequestTypeDef, + DeleteKnownHostKeysRequestRequestTypeDef, + DeleteLoadBalancerRequestRequestTypeDef, + DeleteLoadBalancerTlsCertificateRequestRequestTypeDef, + DeleteRelationalDatabaseRequestRequestTypeDef, + DeleteRelationalDatabaseSnapshotRequestRequestTypeDef, + DetachCertificateFromDistributionRequestRequestTypeDef, + DetachDiskRequestRequestTypeDef, + DetachInstancesFromLoadBalancerRequestRequestTypeDef, + DetachStaticIpRequestRequestTypeDef, + DisableAddOnRequestRequestTypeDef, + DiskInfoTypeDef, + DiskSnapshotInfoTypeDef, + DistributionBundleTypeDef, + DnsRecordCreationStateTypeDef, + ResourceRecordTypeDef, + TimePeriodTypeDef, + ExportSnapshotRequestRequestTypeDef, + PaginatorConfigTypeDef, + GetActiveNamesRequestRequestTypeDef, + GetAlarmsRequestRequestTypeDef, + GetAutoSnapshotsRequestRequestTypeDef, + GetBlueprintsRequestRequestTypeDef, + GetBucketAccessKeysRequestRequestTypeDef, + GetBucketBundlesRequestRequestTypeDef, + GetBucketMetricDataRequestRequestTypeDef, + MetricDatapointTypeDef, + GetBucketsRequestRequestTypeDef, + GetBundlesRequestRequestTypeDef, + GetCertificatesRequestRequestTypeDef, + GetCloudFormationStackRecordsRequestRequestTypeDef, + GetContactMethodsRequestRequestTypeDef, + GetContainerImagesRequestRequestTypeDef, + GetContainerLogRequestRequestTypeDef, + GetContainerServiceDeploymentsRequestRequestTypeDef, + GetContainerServiceMetricDataRequestRequestTypeDef, + GetContainerServicesRequestRequestTypeDef, + GetCostEstimateRequestRequestTypeDef, + GetDiskRequestRequestTypeDef, + GetDiskSnapshotRequestRequestTypeDef, + GetDiskSnapshotsRequestRequestTypeDef, + GetDisksRequestRequestTypeDef, + GetDistributionLatestCacheResetRequestRequestTypeDef, + GetDistributionMetricDataRequestRequestTypeDef, + GetDistributionsRequestRequestTypeDef, + GetDomainRequestRequestTypeDef, + GetDomainsRequestRequestTypeDef, + GetExportSnapshotRecordsRequestRequestTypeDef, + GetInstanceAccessDetailsRequestRequestTypeDef, + GetInstanceMetricDataRequestRequestTypeDef, + GetInstancePortStatesRequestRequestTypeDef, + InstancePortStateTypeDef, + GetInstanceRequestRequestTypeDef, + GetInstanceSnapshotRequestRequestTypeDef, + GetInstanceSnapshotsRequestRequestTypeDef, + GetInstanceStateRequestRequestTypeDef, + InstanceStateTypeDef, + GetInstancesRequestRequestTypeDef, + GetKeyPairRequestRequestTypeDef, + GetKeyPairsRequestRequestTypeDef, + GetLoadBalancerMetricDataRequestRequestTypeDef, + GetLoadBalancerRequestRequestTypeDef, + GetLoadBalancerTlsCertificatesRequestRequestTypeDef, + GetLoadBalancerTlsPoliciesRequestRequestTypeDef, + LoadBalancerTlsPolicyTypeDef, + GetLoadBalancersRequestRequestTypeDef, + GetOperationRequestRequestTypeDef, + GetOperationsForResourceRequestRequestTypeDef, + GetOperationsRequestRequestTypeDef, + GetRegionsRequestRequestTypeDef, + GetRelationalDatabaseBlueprintsRequestRequestTypeDef, + RelationalDatabaseBlueprintTypeDef, + GetRelationalDatabaseBundlesRequestRequestTypeDef, + RelationalDatabaseBundleTypeDef, + GetRelationalDatabaseEventsRequestRequestTypeDef, + RelationalDatabaseEventTypeDef, + GetRelationalDatabaseLogEventsRequestRequestTypeDef, + LogEventTypeDef, + GetRelationalDatabaseLogStreamsRequestRequestTypeDef, + GetRelationalDatabaseMasterUserPasswordRequestRequestTypeDef, + GetRelationalDatabaseMetricDataRequestRequestTypeDef, + GetRelationalDatabaseParametersRequestRequestTypeDef, + RelationalDatabaseParameterTypeDef, + GetRelationalDatabaseRequestRequestTypeDef, + GetRelationalDatabaseSnapshotRequestRequestTypeDef, + GetRelationalDatabaseSnapshotsRequestRequestTypeDef, + GetRelationalDatabasesRequestRequestTypeDef, + GetStaticIpRequestRequestTypeDef, + GetStaticIpsRequestRequestTypeDef, + HostKeyAttributesTypeDef, + ImportKeyPairRequestRequestTypeDef, + PasswordDataTypeDef, + InstanceHealthSummaryTypeDef, + InstanceMetadataOptionsTypeDef, + InstancePortInfoTypeDef, + MonthlyTransferTypeDef, + OriginTypeDef, + LoadBalancerTlsCertificateDnsRecordCreationStateTypeDef, + LoadBalancerTlsCertificateDomainValidationOptionTypeDef, + LoadBalancerTlsCertificateSummaryTypeDef, + NameServersUpdateStateTypeDef, + PendingMaintenanceActionTypeDef, + PendingModifiedRelationalDatabaseValuesTypeDef, + PutAlarmRequestRequestTypeDef, + R53HostedZoneDeletionStateTypeDef, + RebootInstanceRequestRequestTypeDef, + RebootRelationalDatabaseRequestRequestTypeDef, + RegisterContainerImageRequestRequestTypeDef, + RelationalDatabaseEndpointTypeDef, + RelationalDatabaseHardwareTypeDef, + ReleaseStaticIpRequestRequestTypeDef, + ResetDistributionCacheRequestRequestTypeDef, + SendContactMethodVerificationRequestRequestTypeDef, + SetIpAddressTypeRequestRequestTypeDef, + SetResourceAccessForBucketRequestRequestTypeDef, + StartGUISessionRequestRequestTypeDef, + StartInstanceRequestRequestTypeDef, + StartRelationalDatabaseRequestRequestTypeDef, + StopGUISessionRequestRequestTypeDef, + StopInstanceRequestRequestTypeDef, + StopRelationalDatabaseRequestRequestTypeDef, + TestAlarmRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateBucketBundleRequestRequestTypeDef, + UpdateDistributionBundleRequestRequestTypeDef, + UpdateInstanceMetadataOptionsRequestRequestTypeDef, + UpdateLoadBalancerAttributeRequestRequestTypeDef, + UpdateRelationalDatabaseRequestRequestTypeDef, + AccessKeyTypeDef, + AddOnRequestTypeDef, + AlarmTypeDef, + ContactMethodTypeDef, + OperationTypeDef, + StaticIpTypeDef, + DownloadDefaultKeyPairResultTypeDef, + GetActiveNamesResultTypeDef, + GetContainerAPIMetadataResultTypeDef, + GetDistributionLatestCacheResetResultTypeDef, + GetRelationalDatabaseLogStreamsResultTypeDef, + GetRelationalDatabaseMasterUserPasswordResultTypeDef, + IsVpcPeeredResultTypeDef, + AutoSnapshotDetailsTypeDef, + RegionTypeDef, + GetBlueprintsResultTypeDef, + UpdateBucketRequestRequestTypeDef, + GetBucketBundlesResultTypeDef, + BucketTypeDef, + CreateBucketRequestRequestTypeDef, + CreateCertificateRequestRequestTypeDef, + CreateDiskSnapshotRequestRequestTypeDef, + CreateDomainRequestRequestTypeDef, + CreateInstanceSnapshotRequestRequestTypeDef, + CreateKeyPairRequestRequestTypeDef, + CreateLoadBalancerRequestRequestTypeDef, + CreateLoadBalancerTlsCertificateRequestRequestTypeDef, + CreateRelationalDatabaseFromSnapshotRequestRequestTypeDef, + CreateRelationalDatabaseRequestRequestTypeDef, + CreateRelationalDatabaseSnapshotRequestRequestTypeDef, + DiskSnapshotTypeDef, + DiskTypeDef, + KeyPairTypeDef, + RelationalDatabaseSnapshotTypeDef, + TagResourceRequestRequestTypeDef, + GetBundlesResultTypeDef, + CacheSettingsTypeDef, + CloseInstancePublicPortsRequestRequestTypeDef, + OpenInstancePublicPortsRequestRequestTypeDef, + PutInstancePublicPortsRequestRequestTypeDef, + CloudFormationStackRecordTypeDef, + GetContainerImagesResultTypeDef, + RegisterContainerImageResultTypeDef, + PrivateRegistryAccessRequestTypeDef, + PrivateRegistryAccessTypeDef, + ContainerServiceEndpointTypeDef, + EndpointRequestTypeDef, + GetContainerLogResultTypeDef, + GetContainerServicePowersResultTypeDef, + CreateContainerServiceRegistryLoginResultTypeDef, + CreateCloudFormationStackRequestRequestTypeDef, + CreateDomainEntryRequestRequestTypeDef, + DeleteDomainEntryRequestRequestTypeDef, + UpdateDomainEntryRequestRequestTypeDef, + CreateGUISessionAccessDetailsResultTypeDef, + InstanceSnapshotInfoTypeDef, + GetDistributionBundlesResultTypeDef, + DomainValidationRecordTypeDef, + EstimateByTimeTypeDef, + GetActiveNamesRequestGetActiveNamesPaginateTypeDef, + GetBlueprintsRequestGetBlueprintsPaginateTypeDef, + GetBundlesRequestGetBundlesPaginateTypeDef, + GetCloudFormationStackRecordsRequestGetCloudFormationStackRecordsPaginateTypeDef, + GetDiskSnapshotsRequestGetDiskSnapshotsPaginateTypeDef, + GetDisksRequestGetDisksPaginateTypeDef, + GetDomainsRequestGetDomainsPaginateTypeDef, + GetExportSnapshotRecordsRequestGetExportSnapshotRecordsPaginateTypeDef, + GetInstanceSnapshotsRequestGetInstanceSnapshotsPaginateTypeDef, + GetInstancesRequestGetInstancesPaginateTypeDef, + GetKeyPairsRequestGetKeyPairsPaginateTypeDef, + GetLoadBalancersRequestGetLoadBalancersPaginateTypeDef, + GetOperationsRequestGetOperationsPaginateTypeDef, + GetRelationalDatabaseBlueprintsRequestGetRelationalDatabaseBlueprintsPaginateTypeDef, + GetRelationalDatabaseBundlesRequestGetRelationalDatabaseBundlesPaginateTypeDef, + GetRelationalDatabaseEventsRequestGetRelationalDatabaseEventsPaginateTypeDef, + GetRelationalDatabaseParametersRequestGetRelationalDatabaseParametersPaginateTypeDef, + GetRelationalDatabaseSnapshotsRequestGetRelationalDatabaseSnapshotsPaginateTypeDef, + GetRelationalDatabasesRequestGetRelationalDatabasesPaginateTypeDef, + GetStaticIpsRequestGetStaticIpsPaginateTypeDef, + GetBucketMetricDataResultTypeDef, + GetContainerServiceMetricDataResultTypeDef, + GetDistributionMetricDataResultTypeDef, + GetInstanceMetricDataResultTypeDef, + GetLoadBalancerMetricDataResultTypeDef, + GetRelationalDatabaseMetricDataResultTypeDef, + GetInstancePortStatesResultTypeDef, + GetInstanceStateResultTypeDef, + GetLoadBalancerTlsPoliciesResultTypeDef, + GetRelationalDatabaseBlueprintsResultTypeDef, + GetRelationalDatabaseBundlesResultTypeDef, + GetRelationalDatabaseEventsResultTypeDef, + GetRelationalDatabaseLogEventsResultTypeDef, + GetRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseParametersRequestRequestTypeDef, + InstanceAccessDetailsTypeDef, + InstanceNetworkingTypeDef, + LoadBalancerTlsCertificateDomainValidationRecordTypeDef, + LoadBalancerTlsCertificateRenewalSummaryTypeDef, + LoadBalancerTypeDef, + RegisteredDomainDelegationInfoTypeDef, + RelationalDatabaseTypeDef, + GetBucketAccessKeysResultTypeDef, + CreateDiskFromSnapshotRequestRequestTypeDef, + CreateDiskRequestRequestTypeDef, + CreateInstancesFromSnapshotRequestRequestTypeDef, + CreateInstancesRequestRequestTypeDef, + EnableAddOnRequestRequestTypeDef, + GetAlarmsResultTypeDef, + GetContactMethodsResultTypeDef, + AllocateStaticIpResultTypeDef, + AttachCertificateToDistributionResultTypeDef, + AttachDiskResultTypeDef, + AttachInstancesToLoadBalancerResultTypeDef, + AttachLoadBalancerTlsCertificateResultTypeDef, + AttachStaticIpResultTypeDef, + CloseInstancePublicPortsResultTypeDef, + CopySnapshotResultTypeDef, + CreateBucketAccessKeyResultTypeDef, + CreateCloudFormationStackResultTypeDef, + CreateContactMethodResultTypeDef, + CreateDiskFromSnapshotResultTypeDef, + CreateDiskResultTypeDef, + CreateDiskSnapshotResultTypeDef, + CreateDomainEntryResultTypeDef, + CreateDomainResultTypeDef, + CreateInstanceSnapshotResultTypeDef, + CreateInstancesFromSnapshotResultTypeDef, + CreateInstancesResultTypeDef, + CreateLoadBalancerResultTypeDef, + CreateLoadBalancerTlsCertificateResultTypeDef, + CreateRelationalDatabaseFromSnapshotResultTypeDef, + CreateRelationalDatabaseResultTypeDef, + CreateRelationalDatabaseSnapshotResultTypeDef, + DeleteAlarmResultTypeDef, + DeleteAutoSnapshotResultTypeDef, + DeleteBucketAccessKeyResultTypeDef, + DeleteBucketResultTypeDef, + DeleteCertificateResultTypeDef, + DeleteContactMethodResultTypeDef, + DeleteDiskResultTypeDef, + DeleteDiskSnapshotResultTypeDef, + DeleteDistributionResultTypeDef, + DeleteDomainEntryResultTypeDef, + DeleteDomainResultTypeDef, + DeleteInstanceResultTypeDef, + DeleteInstanceSnapshotResultTypeDef, + DeleteKeyPairResultTypeDef, + DeleteKnownHostKeysResultTypeDef, + DeleteLoadBalancerResultTypeDef, + DeleteLoadBalancerTlsCertificateResultTypeDef, + DeleteRelationalDatabaseResultTypeDef, + DeleteRelationalDatabaseSnapshotResultTypeDef, + DetachCertificateFromDistributionResultTypeDef, + DetachDiskResultTypeDef, + DetachInstancesFromLoadBalancerResultTypeDef, + DetachStaticIpResultTypeDef, + DisableAddOnResultTypeDef, + EnableAddOnResultTypeDef, + ExportSnapshotResultTypeDef, + GetOperationResultTypeDef, + GetOperationsForResourceResultTypeDef, + GetOperationsResultTypeDef, + ImportKeyPairResultTypeDef, + OpenInstancePublicPortsResultTypeDef, + PeerVpcResultTypeDef, + PutAlarmResultTypeDef, + PutInstancePublicPortsResultTypeDef, + RebootInstanceResultTypeDef, + RebootRelationalDatabaseResultTypeDef, + ReleaseStaticIpResultTypeDef, + ResetDistributionCacheResultTypeDef, + SendContactMethodVerificationResultTypeDef, + SetIpAddressTypeResultTypeDef, + SetResourceAccessForBucketResultTypeDef, + StartGUISessionResultTypeDef, + StartInstanceResultTypeDef, + StartRelationalDatabaseResultTypeDef, + StopGUISessionResultTypeDef, + StopInstanceResultTypeDef, + StopRelationalDatabaseResultTypeDef, + TagResourceResultTypeDef, + TestAlarmResultTypeDef, + UnpeerVpcResultTypeDef, + UntagResourceResultTypeDef, + UpdateBucketBundleResultTypeDef, + UpdateDistributionBundleResultTypeDef, + UpdateDistributionResultTypeDef, + UpdateDomainEntryResultTypeDef, + UpdateInstanceMetadataOptionsResultTypeDef, + UpdateLoadBalancerAttributeResultTypeDef, + UpdateRelationalDatabaseParametersResultTypeDef, + UpdateRelationalDatabaseResultTypeDef, + GetStaticIpResultTypeDef, + GetStaticIpsResultTypeDef, + GetAutoSnapshotsResultTypeDef, + GetRegionsResultTypeDef, + CreateBucketResultTypeDef, + GetBucketsResultTypeDef, + UpdateBucketResultTypeDef, + GetDiskSnapshotResultTypeDef, + GetDiskSnapshotsResultTypeDef, + GetDiskResultTypeDef, + GetDisksResultTypeDef, + InstanceHardwareTypeDef, + InstanceSnapshotTypeDef, + CreateKeyPairResultTypeDef, + GetKeyPairResultTypeDef, + GetKeyPairsResultTypeDef, + GetRelationalDatabaseSnapshotResultTypeDef, + GetRelationalDatabaseSnapshotsResultTypeDef, + CreateDistributionRequestRequestTypeDef, + LightsailDistributionTypeDef, + UpdateDistributionRequestRequestTypeDef, + GetCloudFormationStackRecordsResultTypeDef, + UpdateContainerServiceRequestRequestTypeDef, + ContainerServiceDeploymentTypeDef, + ContainerServiceDeploymentRequestTypeDef, + CreateContainerServiceDeploymentRequestRequestTypeDef, + ExportSnapshotRecordSourceInfoTypeDef, + RenewalSummaryTypeDef, + CostEstimateTypeDef, + GetInstanceAccessDetailsResultTypeDef, + LoadBalancerTlsCertificateTypeDef, + GetLoadBalancerResultTypeDef, + GetLoadBalancersResultTypeDef, + DomainTypeDef, + GetRelationalDatabaseResultTypeDef, + GetRelationalDatabasesResultTypeDef, + InstanceTypeDef, + GetInstanceSnapshotResultTypeDef, + GetInstanceSnapshotsResultTypeDef, + CreateDistributionResultTypeDef, + GetDistributionsResultTypeDef, + ContainerServiceTypeDef, + GetContainerServiceDeploymentsResultTypeDef, + CreateContainerServiceRequestRequestTypeDef, + ExportSnapshotRecordTypeDef, + CertificateTypeDef, + ResourceBudgetEstimateTypeDef, + GetLoadBalancerTlsCertificatesResultTypeDef, + GetDomainResultTypeDef, + GetDomainsResultTypeDef, + GetInstanceResultTypeDef, + GetInstancesResultTypeDef, + ContainerServicesListResultTypeDef, + CreateContainerServiceDeploymentResultTypeDef, + CreateContainerServiceResultTypeDef, + UpdateContainerServiceResultTypeDef, + GetExportSnapshotRecordsResultTypeDef, + CertificateSummaryTypeDef, + GetCostEstimateResultTypeDef, + CreateCertificateResultTypeDef, + GetCertificatesResultTypeDef, +) + + +def get_structure() -> AccessKeyLastUsedTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-lightsail` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lightsail/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-lightsail-1.26.81 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-lightsail -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.81-1 +- Package Spec generated |