%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-dms
Version: 1.26.94
Release: 1
Summary: Type annotations for boto3.DatabaseMigrationService 1.26.94 service generated with mypy-boto3-builder 7.13.0
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/82/44/0da1d6aaac42e3f9f2ea2559157481ff65ae9448ea05b286117c27e51905/mypy-boto3-dms-1.26.94.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-dms
[](https://pypi.org/project/mypy-boto3-dms)
[](https://pypi.org/project/mypy-boto3-dms)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-dms)
Type annotations for
[boto3.DatabaseMigrationService 1.26.94](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dms.html#DatabaseMigrationService)
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.13.0](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-dms docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-dms](#mypy-boto3-dms)
- [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)
- [Waiters annotations](#waiters-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)
## How to install
### 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 `DatabaseMigrationService`.
### From PyPI with pip
Install `boto3-stubs` for `DatabaseMigrationService` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[dms]'
# 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[dms]'
# standalone installation
python -m pip install mypy-boto3-dms
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-dms
```
## Usage
### 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[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[dms]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Sublime Text
- Install `boto3-stubs[dms]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
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.
## Explicit type annotations
### Client annotations
`DatabaseMigrationServiceClient` provides annotations for
`boto3.client("dms")`.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
client: DatabaseMigrationServiceClient = Session().client("dms")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_dms.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.paginator import (
DescribeCertificatesPaginator,
DescribeConnectionsPaginator,
DescribeEndpointTypesPaginator,
DescribeEndpointsPaginator,
DescribeEventSubscriptionsPaginator,
DescribeEventsPaginator,
DescribeOrderableReplicationInstancesPaginator,
DescribeReplicationInstancesPaginator,
DescribeReplicationSubnetGroupsPaginator,
DescribeReplicationTaskAssessmentResultsPaginator,
DescribeReplicationTasksPaginator,
DescribeSchemasPaginator,
DescribeTableStatisticsPaginator,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator(
"describe_certificates"
)
describe_connections_paginator: DescribeConnectionsPaginator = client.get_paginator(
"describe_connections"
)
describe_endpoint_types_paginator: DescribeEndpointTypesPaginator = client.get_paginator(
"describe_endpoint_types"
)
describe_endpoints_paginator: DescribeEndpointsPaginator = client.get_paginator(
"describe_endpoints"
)
describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator(
"describe_event_subscriptions"
)
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_replication_instances_paginator: DescribeOrderableReplicationInstancesPaginator = client.get_paginator(
"describe_orderable_replication_instances"
)
describe_replication_instances_paginator: DescribeReplicationInstancesPaginator = (
client.get_paginator("describe_replication_instances")
)
describe_replication_subnet_groups_paginator: DescribeReplicationSubnetGroupsPaginator = (
client.get_paginator("describe_replication_subnet_groups")
)
describe_replication_task_assessment_results_paginator: DescribeReplicationTaskAssessmentResultsPaginator = client.get_paginator(
"describe_replication_task_assessment_results"
)
describe_replication_tasks_paginator: DescribeReplicationTasksPaginator = client.get_paginator(
"describe_replication_tasks"
)
describe_schemas_paginator: DescribeSchemasPaginator = client.get_paginator("describe_schemas")
describe_table_statistics_paginator: DescribeTableStatisticsPaginator = client.get_paginator(
"describe_table_statistics"
)
```
### Waiters annotations
`mypy_boto3_dms.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.waiter import (
EndpointDeletedWaiter,
ReplicationInstanceAvailableWaiter,
ReplicationInstanceDeletedWaiter,
ReplicationTaskDeletedWaiter,
ReplicationTaskReadyWaiter,
ReplicationTaskRunningWaiter,
ReplicationTaskStoppedWaiter,
TestConnectionSucceedsWaiter,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
replication_instance_available_waiter: ReplicationInstanceAvailableWaiter = client.get_waiter(
"replication_instance_available"
)
replication_instance_deleted_waiter: ReplicationInstanceDeletedWaiter = client.get_waiter(
"replication_instance_deleted"
)
replication_task_deleted_waiter: ReplicationTaskDeletedWaiter = client.get_waiter(
"replication_task_deleted"
)
replication_task_ready_waiter: ReplicationTaskReadyWaiter = client.get_waiter(
"replication_task_ready"
)
replication_task_running_waiter: ReplicationTaskRunningWaiter = client.get_waiter(
"replication_task_running"
)
replication_task_stopped_waiter: ReplicationTaskStoppedWaiter = client.get_waiter(
"replication_task_stopped"
)
test_connection_succeeds_waiter: TestConnectionSucceedsWaiter = client.get_waiter(
"test_connection_succeeds"
)
```
### Literals
`mypy_boto3_dms.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_dms.literals import (
AuthMechanismValueType,
AuthTypeValueType,
CannedAclForObjectsValueType,
CharLengthSemanticsType,
CollectorStatusType,
CompressionTypeValueType,
DataFormatValueType,
DatePartitionDelimiterValueType,
DatePartitionSequenceValueType,
DescribeCertificatesPaginatorName,
DescribeConnectionsPaginatorName,
DescribeEndpointTypesPaginatorName,
DescribeEndpointsPaginatorName,
DescribeEventSubscriptionsPaginatorName,
DescribeEventsPaginatorName,
DescribeOrderableReplicationInstancesPaginatorName,
DescribeReplicationInstancesPaginatorName,
DescribeReplicationSubnetGroupsPaginatorName,
DescribeReplicationTaskAssessmentResultsPaginatorName,
DescribeReplicationTasksPaginatorName,
DescribeSchemasPaginatorName,
DescribeTableStatisticsPaginatorName,
DmsSslModeValueType,
EncodingTypeValueType,
EncryptionModeValueType,
EndpointDeletedWaiterName,
EndpointSettingTypeValueType,
KafkaSaslMechanismType,
KafkaSecurityProtocolType,
MessageFormatValueType,
MigrationTypeValueType,
NestingLevelValueType,
ParquetVersionValueType,
PluginNameValueType,
RedisAuthTypeValueType,
RefreshSchemasStatusTypeValueType,
ReleaseStatusValuesType,
ReloadOptionValueType,
ReplicationEndpointTypeValueType,
ReplicationInstanceAvailableWaiterName,
ReplicationInstanceDeletedWaiterName,
ReplicationTaskDeletedWaiterName,
ReplicationTaskReadyWaiterName,
ReplicationTaskRunningWaiterName,
ReplicationTaskStoppedWaiterName,
SafeguardPolicyType,
SourceTypeType,
SslSecurityProtocolValueType,
StartReplicationTaskTypeValueType,
TargetDbTypeType,
TestConnectionSucceedsWaiterName,
TlogAccessModeType,
VersionStatusType,
DatabaseMigrationServiceServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AuthMechanismValueType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_dms.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_dms.type_defs import (
AccountQuotaTypeDef,
TagTypeDef,
ApplyPendingMaintenanceActionMessageRequestTypeDef,
ResponseMetadataTypeDef,
AvailabilityZoneTypeDef,
BatchStartRecommendationsErrorEntryTypeDef,
CancelReplicationTaskAssessmentRunMessageRequestTypeDef,
CertificateTypeDef,
CollectorHealthCheckTypeDef,
InventoryDataTypeDef,
CollectorShortInfoResponseTypeDef,
ConnectionTypeDef,
DmsTransferSettingsTypeDef,
DocDbSettingsTypeDef,
DynamoDbSettingsTypeDef,
ElasticsearchSettingsTypeDef,
GcpMySQLSettingsTypeDef,
IBMDb2SettingsTypeDef,
KafkaSettingsTypeDef,
KinesisSettingsTypeDef,
MicrosoftSQLServerSettingsTypeDef,
MongoDbSettingsTypeDef,
MySQLSettingsTypeDef,
NeptuneSettingsTypeDef,
OracleSettingsTypeDef,
PostgreSQLSettingsTypeDef,
RedisSettingsTypeDef,
RedshiftSettingsTypeDef,
S3SettingsTypeDef,
SybaseSettingsTypeDef,
EventSubscriptionTypeDef,
CreateFleetAdvisorCollectorRequestRequestTypeDef,
DatabaseInstanceSoftwareDetailsResponseTypeDef,
ServerShortInfoResponseTypeDef,
DatabaseShortInfoResponseTypeDef,
DeleteCertificateMessageRequestTypeDef,
DeleteCollectorRequestRequestTypeDef,
DeleteConnectionMessageRequestTypeDef,
DeleteEndpointMessageRequestTypeDef,
DeleteEventSubscriptionMessageRequestTypeDef,
DeleteFleetAdvisorDatabasesRequestRequestTypeDef,
DeleteReplicationInstanceMessageRequestTypeDef,
DeleteReplicationSubnetGroupMessageRequestTypeDef,
DeleteReplicationTaskAssessmentRunMessageRequestTypeDef,
DeleteReplicationTaskMessageRequestTypeDef,
DescribeApplicableIndividualAssessmentsMessageRequestTypeDef,
FilterTypeDef,
PaginatorConfigTypeDef,
WaiterConfigTypeDef,
DescribeEndpointSettingsMessageRequestTypeDef,
EndpointSettingTypeDef,
SupportedEndpointTypeTypeDef,
EventCategoryGroupTypeDef,
EventTypeDef,
DescribeFleetAdvisorLsaAnalysisRequestRequestTypeDef,
FleetAdvisorLsaAnalysisResponseTypeDef,
FleetAdvisorSchemaObjectResponseTypeDef,
DescribeOrderableReplicationInstancesMessageRequestTypeDef,
OrderableReplicationInstanceTypeDef,
LimitationTypeDef,
DescribeRefreshSchemasStatusMessageRequestTypeDef,
RefreshSchemasStatusTypeDef,
DescribeReplicationInstanceTaskLogsMessageRequestTypeDef,
ReplicationInstanceTaskLogTypeDef,
DescribeReplicationTaskAssessmentResultsMessageRequestTypeDef,
ReplicationTaskAssessmentResultTypeDef,
ReplicationTaskIndividualAssessmentTypeDef,
DescribeSchemasMessageRequestTypeDef,
TableStatisticsTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ModifyEventSubscriptionMessageRequestTypeDef,
ModifyReplicationInstanceMessageRequestTypeDef,
ModifyReplicationSubnetGroupMessageRequestTypeDef,
ModifyReplicationTaskMessageRequestTypeDef,
MoveReplicationTaskMessageRequestTypeDef,
PendingMaintenanceActionTypeDef,
RdsConfigurationTypeDef,
RdsRequirementsTypeDef,
RebootReplicationInstanceMessageRequestTypeDef,
RecommendationSettingsTypeDef,
RefreshSchemasMessageRequestTypeDef,
TableToReloadTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
ReplicationPendingModifiedValuesTypeDef,
VpcSecurityGroupMembershipTypeDef,
ReplicationTaskAssessmentRunProgressTypeDef,
ReplicationTaskStatsTypeDef,
SchemaShortInfoResponseTypeDef,
StartReplicationTaskAssessmentMessageRequestTypeDef,
StartReplicationTaskAssessmentRunMessageRequestTypeDef,
StartReplicationTaskMessageRequestTypeDef,
StopReplicationTaskMessageRequestTypeDef,
TestConnectionMessageRequestTypeDef,
UpdateSubscriptionsToEventBridgeMessageRequestTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CreateEventSubscriptionMessageRequestTypeDef,
CreateReplicationInstanceMessageRequestTypeDef,
CreateReplicationSubnetGroupMessageRequestTypeDef,
CreateReplicationTaskMessageRequestTypeDef,
ImportCertificateMessageRequestTypeDef,
CreateFleetAdvisorCollectorResponseTypeDef,
DeleteFleetAdvisorDatabasesResponseTypeDef,
DescribeAccountAttributesResponseTypeDef,
DescribeApplicableIndividualAssessmentsResponseTypeDef,
DescribeSchemasResponseTypeDef,
EmptyResponseMetadataTypeDef,
ListTagsForResourceResponseTypeDef,
ReloadTablesResponseTypeDef,
RunFleetAdvisorLsaAnalysisResponseTypeDef,
UpdateSubscriptionsToEventBridgeResponseTypeDef,
SubnetTypeDef,
BatchStartRecommendationsResponseTypeDef,
DeleteCertificateResponseTypeDef,
DescribeCertificatesResponseTypeDef,
ImportCertificateResponseTypeDef,
CollectorResponseTypeDef,
DeleteConnectionResponseTypeDef,
DescribeConnectionsResponseTypeDef,
TestConnectionResponseTypeDef,
CreateEndpointMessageRequestTypeDef,
EndpointTypeDef,
ModifyEndpointMessageRequestTypeDef,
CreateEventSubscriptionResponseTypeDef,
DeleteEventSubscriptionResponseTypeDef,
DescribeEventSubscriptionsResponseTypeDef,
ModifyEventSubscriptionResponseTypeDef,
DatabaseResponseTypeDef,
DescribeCertificatesMessageRequestTypeDef,
DescribeConnectionsMessageRequestTypeDef,
DescribeEndpointTypesMessageRequestTypeDef,
DescribeEndpointsMessageRequestTypeDef,
DescribeEventCategoriesMessageRequestTypeDef,
DescribeEventSubscriptionsMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeFleetAdvisorCollectorsRequestRequestTypeDef,
DescribeFleetAdvisorDatabasesRequestRequestTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryRequestRequestTypeDef,
DescribeFleetAdvisorSchemasRequestRequestTypeDef,
DescribePendingMaintenanceActionsMessageRequestTypeDef,
DescribeRecommendationLimitationsRequestRequestTypeDef,
DescribeRecommendationsRequestRequestTypeDef,
DescribeReplicationInstancesMessageRequestTypeDef,
DescribeReplicationSubnetGroupsMessageRequestTypeDef,
DescribeReplicationTaskAssessmentRunsMessageRequestTypeDef,
DescribeReplicationTaskIndividualAssessmentsMessageRequestTypeDef,
DescribeReplicationTasksMessageRequestTypeDef,
DescribeTableStatisticsMessageRequestTypeDef,
DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef,
DescribeConnectionsMessageDescribeConnectionsPaginateTypeDef,
DescribeEndpointTypesMessageDescribeEndpointTypesPaginateTypeDef,
DescribeEndpointsMessageDescribeEndpointsPaginateTypeDef,
DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeOrderableReplicationInstancesMessageDescribeOrderableReplicationInstancesPaginateTypeDef,
DescribeReplicationInstancesMessageDescribeReplicationInstancesPaginateTypeDef,
DescribeReplicationSubnetGroupsMessageDescribeReplicationSubnetGroupsPaginateTypeDef,
DescribeReplicationTaskAssessmentResultsMessageDescribeReplicationTaskAssessmentResultsPaginateTypeDef,
DescribeReplicationTasksMessageDescribeReplicationTasksPaginateTypeDef,
DescribeSchemasMessageDescribeSchemasPaginateTypeDef,
DescribeTableStatisticsMessageDescribeTableStatisticsPaginateTypeDef,
DescribeConnectionsMessageTestConnectionSucceedsWaitTypeDef,
DescribeEndpointsMessageEndpointDeletedWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceAvailableWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskReadyWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskRunningWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskStoppedWaitTypeDef,
DescribeEndpointSettingsResponseTypeDef,
DescribeEndpointTypesResponseTypeDef,
DescribeEventCategoriesResponseTypeDef,
DescribeEventsResponseTypeDef,
DescribeFleetAdvisorLsaAnalysisResponseTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryResponseTypeDef,
DescribeOrderableReplicationInstancesResponseTypeDef,
DescribeRecommendationLimitationsResponseTypeDef,
DescribeRefreshSchemasStatusResponseTypeDef,
RefreshSchemasResponseTypeDef,
DescribeReplicationInstanceTaskLogsResponseTypeDef,
DescribeReplicationTaskAssessmentResultsResponseTypeDef,
DescribeReplicationTaskIndividualAssessmentsResponseTypeDef,
DescribeTableStatisticsResponseTypeDef,
ResourcePendingMaintenanceActionsTypeDef,
RdsRecommendationTypeDef,
StartRecommendationsRequestEntryTypeDef,
StartRecommendationsRequestRequestTypeDef,
ReloadTablesMessageRequestTypeDef,
ReplicationTaskAssessmentRunTypeDef,
ReplicationTaskTypeDef,
SchemaResponseTypeDef,
ReplicationSubnetGroupTypeDef,
DescribeFleetAdvisorCollectorsResponseTypeDef,
CreateEndpointResponseTypeDef,
DeleteEndpointResponseTypeDef,
DescribeEndpointsResponseTypeDef,
ModifyEndpointResponseTypeDef,
DescribeFleetAdvisorDatabasesResponseTypeDef,
ApplyPendingMaintenanceActionResponseTypeDef,
DescribePendingMaintenanceActionsResponseTypeDef,
RecommendationDataTypeDef,
BatchStartRecommendationsRequestRequestTypeDef,
CancelReplicationTaskAssessmentRunResponseTypeDef,
DeleteReplicationTaskAssessmentRunResponseTypeDef,
DescribeReplicationTaskAssessmentRunsResponseTypeDef,
StartReplicationTaskAssessmentRunResponseTypeDef,
CreateReplicationTaskResponseTypeDef,
DeleteReplicationTaskResponseTypeDef,
DescribeReplicationTasksResponseTypeDef,
ModifyReplicationTaskResponseTypeDef,
MoveReplicationTaskResponseTypeDef,
StartReplicationTaskAssessmentResponseTypeDef,
StartReplicationTaskResponseTypeDef,
StopReplicationTaskResponseTypeDef,
DescribeFleetAdvisorSchemasResponseTypeDef,
CreateReplicationSubnetGroupResponseTypeDef,
DescribeReplicationSubnetGroupsResponseTypeDef,
ModifyReplicationSubnetGroupResponseTypeDef,
ReplicationInstanceTypeDef,
RecommendationTypeDef,
CreateReplicationInstanceResponseTypeDef,
DeleteReplicationInstanceResponseTypeDef,
DescribeReplicationInstancesResponseTypeDef,
ModifyReplicationInstanceResponseTypeDef,
RebootReplicationInstanceResponseTypeDef,
DescribeRecommendationsResponseTypeDef,
)
def get_structure() -> AccountQuotaTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-dms` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/)
## 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-dms
Summary: Type annotations for boto3.DatabaseMigrationService 1.26.94 service generated with mypy-boto3-builder 7.13.0
Provides: python-mypy-boto3-dms
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-dms
# mypy-boto3-dms
[](https://pypi.org/project/mypy-boto3-dms)
[](https://pypi.org/project/mypy-boto3-dms)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-dms)
Type annotations for
[boto3.DatabaseMigrationService 1.26.94](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dms.html#DatabaseMigrationService)
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.13.0](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-dms docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-dms](#mypy-boto3-dms)
- [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)
- [Waiters annotations](#waiters-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)
## How to install
### 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 `DatabaseMigrationService`.
### From PyPI with pip
Install `boto3-stubs` for `DatabaseMigrationService` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[dms]'
# 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[dms]'
# standalone installation
python -m pip install mypy-boto3-dms
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-dms
```
## Usage
### 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[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[dms]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Sublime Text
- Install `boto3-stubs[dms]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
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.
## Explicit type annotations
### Client annotations
`DatabaseMigrationServiceClient` provides annotations for
`boto3.client("dms")`.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
client: DatabaseMigrationServiceClient = Session().client("dms")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_dms.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.paginator import (
DescribeCertificatesPaginator,
DescribeConnectionsPaginator,
DescribeEndpointTypesPaginator,
DescribeEndpointsPaginator,
DescribeEventSubscriptionsPaginator,
DescribeEventsPaginator,
DescribeOrderableReplicationInstancesPaginator,
DescribeReplicationInstancesPaginator,
DescribeReplicationSubnetGroupsPaginator,
DescribeReplicationTaskAssessmentResultsPaginator,
DescribeReplicationTasksPaginator,
DescribeSchemasPaginator,
DescribeTableStatisticsPaginator,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator(
"describe_certificates"
)
describe_connections_paginator: DescribeConnectionsPaginator = client.get_paginator(
"describe_connections"
)
describe_endpoint_types_paginator: DescribeEndpointTypesPaginator = client.get_paginator(
"describe_endpoint_types"
)
describe_endpoints_paginator: DescribeEndpointsPaginator = client.get_paginator(
"describe_endpoints"
)
describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator(
"describe_event_subscriptions"
)
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_replication_instances_paginator: DescribeOrderableReplicationInstancesPaginator = client.get_paginator(
"describe_orderable_replication_instances"
)
describe_replication_instances_paginator: DescribeReplicationInstancesPaginator = (
client.get_paginator("describe_replication_instances")
)
describe_replication_subnet_groups_paginator: DescribeReplicationSubnetGroupsPaginator = (
client.get_paginator("describe_replication_subnet_groups")
)
describe_replication_task_assessment_results_paginator: DescribeReplicationTaskAssessmentResultsPaginator = client.get_paginator(
"describe_replication_task_assessment_results"
)
describe_replication_tasks_paginator: DescribeReplicationTasksPaginator = client.get_paginator(
"describe_replication_tasks"
)
describe_schemas_paginator: DescribeSchemasPaginator = client.get_paginator("describe_schemas")
describe_table_statistics_paginator: DescribeTableStatisticsPaginator = client.get_paginator(
"describe_table_statistics"
)
```
### Waiters annotations
`mypy_boto3_dms.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.waiter import (
EndpointDeletedWaiter,
ReplicationInstanceAvailableWaiter,
ReplicationInstanceDeletedWaiter,
ReplicationTaskDeletedWaiter,
ReplicationTaskReadyWaiter,
ReplicationTaskRunningWaiter,
ReplicationTaskStoppedWaiter,
TestConnectionSucceedsWaiter,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
replication_instance_available_waiter: ReplicationInstanceAvailableWaiter = client.get_waiter(
"replication_instance_available"
)
replication_instance_deleted_waiter: ReplicationInstanceDeletedWaiter = client.get_waiter(
"replication_instance_deleted"
)
replication_task_deleted_waiter: ReplicationTaskDeletedWaiter = client.get_waiter(
"replication_task_deleted"
)
replication_task_ready_waiter: ReplicationTaskReadyWaiter = client.get_waiter(
"replication_task_ready"
)
replication_task_running_waiter: ReplicationTaskRunningWaiter = client.get_waiter(
"replication_task_running"
)
replication_task_stopped_waiter: ReplicationTaskStoppedWaiter = client.get_waiter(
"replication_task_stopped"
)
test_connection_succeeds_waiter: TestConnectionSucceedsWaiter = client.get_waiter(
"test_connection_succeeds"
)
```
### Literals
`mypy_boto3_dms.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_dms.literals import (
AuthMechanismValueType,
AuthTypeValueType,
CannedAclForObjectsValueType,
CharLengthSemanticsType,
CollectorStatusType,
CompressionTypeValueType,
DataFormatValueType,
DatePartitionDelimiterValueType,
DatePartitionSequenceValueType,
DescribeCertificatesPaginatorName,
DescribeConnectionsPaginatorName,
DescribeEndpointTypesPaginatorName,
DescribeEndpointsPaginatorName,
DescribeEventSubscriptionsPaginatorName,
DescribeEventsPaginatorName,
DescribeOrderableReplicationInstancesPaginatorName,
DescribeReplicationInstancesPaginatorName,
DescribeReplicationSubnetGroupsPaginatorName,
DescribeReplicationTaskAssessmentResultsPaginatorName,
DescribeReplicationTasksPaginatorName,
DescribeSchemasPaginatorName,
DescribeTableStatisticsPaginatorName,
DmsSslModeValueType,
EncodingTypeValueType,
EncryptionModeValueType,
EndpointDeletedWaiterName,
EndpointSettingTypeValueType,
KafkaSaslMechanismType,
KafkaSecurityProtocolType,
MessageFormatValueType,
MigrationTypeValueType,
NestingLevelValueType,
ParquetVersionValueType,
PluginNameValueType,
RedisAuthTypeValueType,
RefreshSchemasStatusTypeValueType,
ReleaseStatusValuesType,
ReloadOptionValueType,
ReplicationEndpointTypeValueType,
ReplicationInstanceAvailableWaiterName,
ReplicationInstanceDeletedWaiterName,
ReplicationTaskDeletedWaiterName,
ReplicationTaskReadyWaiterName,
ReplicationTaskRunningWaiterName,
ReplicationTaskStoppedWaiterName,
SafeguardPolicyType,
SourceTypeType,
SslSecurityProtocolValueType,
StartReplicationTaskTypeValueType,
TargetDbTypeType,
TestConnectionSucceedsWaiterName,
TlogAccessModeType,
VersionStatusType,
DatabaseMigrationServiceServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AuthMechanismValueType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_dms.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_dms.type_defs import (
AccountQuotaTypeDef,
TagTypeDef,
ApplyPendingMaintenanceActionMessageRequestTypeDef,
ResponseMetadataTypeDef,
AvailabilityZoneTypeDef,
BatchStartRecommendationsErrorEntryTypeDef,
CancelReplicationTaskAssessmentRunMessageRequestTypeDef,
CertificateTypeDef,
CollectorHealthCheckTypeDef,
InventoryDataTypeDef,
CollectorShortInfoResponseTypeDef,
ConnectionTypeDef,
DmsTransferSettingsTypeDef,
DocDbSettingsTypeDef,
DynamoDbSettingsTypeDef,
ElasticsearchSettingsTypeDef,
GcpMySQLSettingsTypeDef,
IBMDb2SettingsTypeDef,
KafkaSettingsTypeDef,
KinesisSettingsTypeDef,
MicrosoftSQLServerSettingsTypeDef,
MongoDbSettingsTypeDef,
MySQLSettingsTypeDef,
NeptuneSettingsTypeDef,
OracleSettingsTypeDef,
PostgreSQLSettingsTypeDef,
RedisSettingsTypeDef,
RedshiftSettingsTypeDef,
S3SettingsTypeDef,
SybaseSettingsTypeDef,
EventSubscriptionTypeDef,
CreateFleetAdvisorCollectorRequestRequestTypeDef,
DatabaseInstanceSoftwareDetailsResponseTypeDef,
ServerShortInfoResponseTypeDef,
DatabaseShortInfoResponseTypeDef,
DeleteCertificateMessageRequestTypeDef,
DeleteCollectorRequestRequestTypeDef,
DeleteConnectionMessageRequestTypeDef,
DeleteEndpointMessageRequestTypeDef,
DeleteEventSubscriptionMessageRequestTypeDef,
DeleteFleetAdvisorDatabasesRequestRequestTypeDef,
DeleteReplicationInstanceMessageRequestTypeDef,
DeleteReplicationSubnetGroupMessageRequestTypeDef,
DeleteReplicationTaskAssessmentRunMessageRequestTypeDef,
DeleteReplicationTaskMessageRequestTypeDef,
DescribeApplicableIndividualAssessmentsMessageRequestTypeDef,
FilterTypeDef,
PaginatorConfigTypeDef,
WaiterConfigTypeDef,
DescribeEndpointSettingsMessageRequestTypeDef,
EndpointSettingTypeDef,
SupportedEndpointTypeTypeDef,
EventCategoryGroupTypeDef,
EventTypeDef,
DescribeFleetAdvisorLsaAnalysisRequestRequestTypeDef,
FleetAdvisorLsaAnalysisResponseTypeDef,
FleetAdvisorSchemaObjectResponseTypeDef,
DescribeOrderableReplicationInstancesMessageRequestTypeDef,
OrderableReplicationInstanceTypeDef,
LimitationTypeDef,
DescribeRefreshSchemasStatusMessageRequestTypeDef,
RefreshSchemasStatusTypeDef,
DescribeReplicationInstanceTaskLogsMessageRequestTypeDef,
ReplicationInstanceTaskLogTypeDef,
DescribeReplicationTaskAssessmentResultsMessageRequestTypeDef,
ReplicationTaskAssessmentResultTypeDef,
ReplicationTaskIndividualAssessmentTypeDef,
DescribeSchemasMessageRequestTypeDef,
TableStatisticsTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ModifyEventSubscriptionMessageRequestTypeDef,
ModifyReplicationInstanceMessageRequestTypeDef,
ModifyReplicationSubnetGroupMessageRequestTypeDef,
ModifyReplicationTaskMessageRequestTypeDef,
MoveReplicationTaskMessageRequestTypeDef,
PendingMaintenanceActionTypeDef,
RdsConfigurationTypeDef,
RdsRequirementsTypeDef,
RebootReplicationInstanceMessageRequestTypeDef,
RecommendationSettingsTypeDef,
RefreshSchemasMessageRequestTypeDef,
TableToReloadTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
ReplicationPendingModifiedValuesTypeDef,
VpcSecurityGroupMembershipTypeDef,
ReplicationTaskAssessmentRunProgressTypeDef,
ReplicationTaskStatsTypeDef,
SchemaShortInfoResponseTypeDef,
StartReplicationTaskAssessmentMessageRequestTypeDef,
StartReplicationTaskAssessmentRunMessageRequestTypeDef,
StartReplicationTaskMessageRequestTypeDef,
StopReplicationTaskMessageRequestTypeDef,
TestConnectionMessageRequestTypeDef,
UpdateSubscriptionsToEventBridgeMessageRequestTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CreateEventSubscriptionMessageRequestTypeDef,
CreateReplicationInstanceMessageRequestTypeDef,
CreateReplicationSubnetGroupMessageRequestTypeDef,
CreateReplicationTaskMessageRequestTypeDef,
ImportCertificateMessageRequestTypeDef,
CreateFleetAdvisorCollectorResponseTypeDef,
DeleteFleetAdvisorDatabasesResponseTypeDef,
DescribeAccountAttributesResponseTypeDef,
DescribeApplicableIndividualAssessmentsResponseTypeDef,
DescribeSchemasResponseTypeDef,
EmptyResponseMetadataTypeDef,
ListTagsForResourceResponseTypeDef,
ReloadTablesResponseTypeDef,
RunFleetAdvisorLsaAnalysisResponseTypeDef,
UpdateSubscriptionsToEventBridgeResponseTypeDef,
SubnetTypeDef,
BatchStartRecommendationsResponseTypeDef,
DeleteCertificateResponseTypeDef,
DescribeCertificatesResponseTypeDef,
ImportCertificateResponseTypeDef,
CollectorResponseTypeDef,
DeleteConnectionResponseTypeDef,
DescribeConnectionsResponseTypeDef,
TestConnectionResponseTypeDef,
CreateEndpointMessageRequestTypeDef,
EndpointTypeDef,
ModifyEndpointMessageRequestTypeDef,
CreateEventSubscriptionResponseTypeDef,
DeleteEventSubscriptionResponseTypeDef,
DescribeEventSubscriptionsResponseTypeDef,
ModifyEventSubscriptionResponseTypeDef,
DatabaseResponseTypeDef,
DescribeCertificatesMessageRequestTypeDef,
DescribeConnectionsMessageRequestTypeDef,
DescribeEndpointTypesMessageRequestTypeDef,
DescribeEndpointsMessageRequestTypeDef,
DescribeEventCategoriesMessageRequestTypeDef,
DescribeEventSubscriptionsMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeFleetAdvisorCollectorsRequestRequestTypeDef,
DescribeFleetAdvisorDatabasesRequestRequestTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryRequestRequestTypeDef,
DescribeFleetAdvisorSchemasRequestRequestTypeDef,
DescribePendingMaintenanceActionsMessageRequestTypeDef,
DescribeRecommendationLimitationsRequestRequestTypeDef,
DescribeRecommendationsRequestRequestTypeDef,
DescribeReplicationInstancesMessageRequestTypeDef,
DescribeReplicationSubnetGroupsMessageRequestTypeDef,
DescribeReplicationTaskAssessmentRunsMessageRequestTypeDef,
DescribeReplicationTaskIndividualAssessmentsMessageRequestTypeDef,
DescribeReplicationTasksMessageRequestTypeDef,
DescribeTableStatisticsMessageRequestTypeDef,
DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef,
DescribeConnectionsMessageDescribeConnectionsPaginateTypeDef,
DescribeEndpointTypesMessageDescribeEndpointTypesPaginateTypeDef,
DescribeEndpointsMessageDescribeEndpointsPaginateTypeDef,
DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeOrderableReplicationInstancesMessageDescribeOrderableReplicationInstancesPaginateTypeDef,
DescribeReplicationInstancesMessageDescribeReplicationInstancesPaginateTypeDef,
DescribeReplicationSubnetGroupsMessageDescribeReplicationSubnetGroupsPaginateTypeDef,
DescribeReplicationTaskAssessmentResultsMessageDescribeReplicationTaskAssessmentResultsPaginateTypeDef,
DescribeReplicationTasksMessageDescribeReplicationTasksPaginateTypeDef,
DescribeSchemasMessageDescribeSchemasPaginateTypeDef,
DescribeTableStatisticsMessageDescribeTableStatisticsPaginateTypeDef,
DescribeConnectionsMessageTestConnectionSucceedsWaitTypeDef,
DescribeEndpointsMessageEndpointDeletedWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceAvailableWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskReadyWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskRunningWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskStoppedWaitTypeDef,
DescribeEndpointSettingsResponseTypeDef,
DescribeEndpointTypesResponseTypeDef,
DescribeEventCategoriesResponseTypeDef,
DescribeEventsResponseTypeDef,
DescribeFleetAdvisorLsaAnalysisResponseTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryResponseTypeDef,
DescribeOrderableReplicationInstancesResponseTypeDef,
DescribeRecommendationLimitationsResponseTypeDef,
DescribeRefreshSchemasStatusResponseTypeDef,
RefreshSchemasResponseTypeDef,
DescribeReplicationInstanceTaskLogsResponseTypeDef,
DescribeReplicationTaskAssessmentResultsResponseTypeDef,
DescribeReplicationTaskIndividualAssessmentsResponseTypeDef,
DescribeTableStatisticsResponseTypeDef,
ResourcePendingMaintenanceActionsTypeDef,
RdsRecommendationTypeDef,
StartRecommendationsRequestEntryTypeDef,
StartRecommendationsRequestRequestTypeDef,
ReloadTablesMessageRequestTypeDef,
ReplicationTaskAssessmentRunTypeDef,
ReplicationTaskTypeDef,
SchemaResponseTypeDef,
ReplicationSubnetGroupTypeDef,
DescribeFleetAdvisorCollectorsResponseTypeDef,
CreateEndpointResponseTypeDef,
DeleteEndpointResponseTypeDef,
DescribeEndpointsResponseTypeDef,
ModifyEndpointResponseTypeDef,
DescribeFleetAdvisorDatabasesResponseTypeDef,
ApplyPendingMaintenanceActionResponseTypeDef,
DescribePendingMaintenanceActionsResponseTypeDef,
RecommendationDataTypeDef,
BatchStartRecommendationsRequestRequestTypeDef,
CancelReplicationTaskAssessmentRunResponseTypeDef,
DeleteReplicationTaskAssessmentRunResponseTypeDef,
DescribeReplicationTaskAssessmentRunsResponseTypeDef,
StartReplicationTaskAssessmentRunResponseTypeDef,
CreateReplicationTaskResponseTypeDef,
DeleteReplicationTaskResponseTypeDef,
DescribeReplicationTasksResponseTypeDef,
ModifyReplicationTaskResponseTypeDef,
MoveReplicationTaskResponseTypeDef,
StartReplicationTaskAssessmentResponseTypeDef,
StartReplicationTaskResponseTypeDef,
StopReplicationTaskResponseTypeDef,
DescribeFleetAdvisorSchemasResponseTypeDef,
CreateReplicationSubnetGroupResponseTypeDef,
DescribeReplicationSubnetGroupsResponseTypeDef,
ModifyReplicationSubnetGroupResponseTypeDef,
ReplicationInstanceTypeDef,
RecommendationTypeDef,
CreateReplicationInstanceResponseTypeDef,
DeleteReplicationInstanceResponseTypeDef,
DescribeReplicationInstancesResponseTypeDef,
ModifyReplicationInstanceResponseTypeDef,
RebootReplicationInstanceResponseTypeDef,
DescribeRecommendationsResponseTypeDef,
)
def get_structure() -> AccountQuotaTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-dms` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/)
## 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-dms
Provides: python3-mypy-boto3-dms-doc
%description help
# mypy-boto3-dms
[](https://pypi.org/project/mypy-boto3-dms)
[](https://pypi.org/project/mypy-boto3-dms)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-dms)
Type annotations for
[boto3.DatabaseMigrationService 1.26.94](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dms.html#DatabaseMigrationService)
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.13.0](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-dms docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-dms](#mypy-boto3-dms)
- [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)
- [Waiters annotations](#waiters-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)
## How to install
### 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 `DatabaseMigrationService`.
### From PyPI with pip
Install `boto3-stubs` for `DatabaseMigrationService` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[dms]'
# 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[dms]'
# standalone installation
python -m pip install mypy-boto3-dms
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-dms
```
## Usage
### 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[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[dms]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Sublime Text
- Install `boto3-stubs[dms]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
- 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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[dms]` in your environment:
```bash
python -m pip install 'boto3-stubs[dms]'
```
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.
## Explicit type annotations
### Client annotations
`DatabaseMigrationServiceClient` provides annotations for
`boto3.client("dms")`.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
client: DatabaseMigrationServiceClient = Session().client("dms")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_dms.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.paginator import (
DescribeCertificatesPaginator,
DescribeConnectionsPaginator,
DescribeEndpointTypesPaginator,
DescribeEndpointsPaginator,
DescribeEventSubscriptionsPaginator,
DescribeEventsPaginator,
DescribeOrderableReplicationInstancesPaginator,
DescribeReplicationInstancesPaginator,
DescribeReplicationSubnetGroupsPaginator,
DescribeReplicationTaskAssessmentResultsPaginator,
DescribeReplicationTasksPaginator,
DescribeSchemasPaginator,
DescribeTableStatisticsPaginator,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator(
"describe_certificates"
)
describe_connections_paginator: DescribeConnectionsPaginator = client.get_paginator(
"describe_connections"
)
describe_endpoint_types_paginator: DescribeEndpointTypesPaginator = client.get_paginator(
"describe_endpoint_types"
)
describe_endpoints_paginator: DescribeEndpointsPaginator = client.get_paginator(
"describe_endpoints"
)
describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator(
"describe_event_subscriptions"
)
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_replication_instances_paginator: DescribeOrderableReplicationInstancesPaginator = client.get_paginator(
"describe_orderable_replication_instances"
)
describe_replication_instances_paginator: DescribeReplicationInstancesPaginator = (
client.get_paginator("describe_replication_instances")
)
describe_replication_subnet_groups_paginator: DescribeReplicationSubnetGroupsPaginator = (
client.get_paginator("describe_replication_subnet_groups")
)
describe_replication_task_assessment_results_paginator: DescribeReplicationTaskAssessmentResultsPaginator = client.get_paginator(
"describe_replication_task_assessment_results"
)
describe_replication_tasks_paginator: DescribeReplicationTasksPaginator = client.get_paginator(
"describe_replication_tasks"
)
describe_schemas_paginator: DescribeSchemasPaginator = client.get_paginator("describe_schemas")
describe_table_statistics_paginator: DescribeTableStatisticsPaginator = client.get_paginator(
"describe_table_statistics"
)
```
### Waiters annotations
`mypy_boto3_dms.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_dms import DatabaseMigrationServiceClient
from mypy_boto3_dms.waiter import (
EndpointDeletedWaiter,
ReplicationInstanceAvailableWaiter,
ReplicationInstanceDeletedWaiter,
ReplicationTaskDeletedWaiter,
ReplicationTaskReadyWaiter,
ReplicationTaskRunningWaiter,
ReplicationTaskStoppedWaiter,
TestConnectionSucceedsWaiter,
)
client: DatabaseMigrationServiceClient = Session().client("dms")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
replication_instance_available_waiter: ReplicationInstanceAvailableWaiter = client.get_waiter(
"replication_instance_available"
)
replication_instance_deleted_waiter: ReplicationInstanceDeletedWaiter = client.get_waiter(
"replication_instance_deleted"
)
replication_task_deleted_waiter: ReplicationTaskDeletedWaiter = client.get_waiter(
"replication_task_deleted"
)
replication_task_ready_waiter: ReplicationTaskReadyWaiter = client.get_waiter(
"replication_task_ready"
)
replication_task_running_waiter: ReplicationTaskRunningWaiter = client.get_waiter(
"replication_task_running"
)
replication_task_stopped_waiter: ReplicationTaskStoppedWaiter = client.get_waiter(
"replication_task_stopped"
)
test_connection_succeeds_waiter: TestConnectionSucceedsWaiter = client.get_waiter(
"test_connection_succeeds"
)
```
### Literals
`mypy_boto3_dms.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_dms.literals import (
AuthMechanismValueType,
AuthTypeValueType,
CannedAclForObjectsValueType,
CharLengthSemanticsType,
CollectorStatusType,
CompressionTypeValueType,
DataFormatValueType,
DatePartitionDelimiterValueType,
DatePartitionSequenceValueType,
DescribeCertificatesPaginatorName,
DescribeConnectionsPaginatorName,
DescribeEndpointTypesPaginatorName,
DescribeEndpointsPaginatorName,
DescribeEventSubscriptionsPaginatorName,
DescribeEventsPaginatorName,
DescribeOrderableReplicationInstancesPaginatorName,
DescribeReplicationInstancesPaginatorName,
DescribeReplicationSubnetGroupsPaginatorName,
DescribeReplicationTaskAssessmentResultsPaginatorName,
DescribeReplicationTasksPaginatorName,
DescribeSchemasPaginatorName,
DescribeTableStatisticsPaginatorName,
DmsSslModeValueType,
EncodingTypeValueType,
EncryptionModeValueType,
EndpointDeletedWaiterName,
EndpointSettingTypeValueType,
KafkaSaslMechanismType,
KafkaSecurityProtocolType,
MessageFormatValueType,
MigrationTypeValueType,
NestingLevelValueType,
ParquetVersionValueType,
PluginNameValueType,
RedisAuthTypeValueType,
RefreshSchemasStatusTypeValueType,
ReleaseStatusValuesType,
ReloadOptionValueType,
ReplicationEndpointTypeValueType,
ReplicationInstanceAvailableWaiterName,
ReplicationInstanceDeletedWaiterName,
ReplicationTaskDeletedWaiterName,
ReplicationTaskReadyWaiterName,
ReplicationTaskRunningWaiterName,
ReplicationTaskStoppedWaiterName,
SafeguardPolicyType,
SourceTypeType,
SslSecurityProtocolValueType,
StartReplicationTaskTypeValueType,
TargetDbTypeType,
TestConnectionSucceedsWaiterName,
TlogAccessModeType,
VersionStatusType,
DatabaseMigrationServiceServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AuthMechanismValueType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_dms.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_dms.type_defs import (
AccountQuotaTypeDef,
TagTypeDef,
ApplyPendingMaintenanceActionMessageRequestTypeDef,
ResponseMetadataTypeDef,
AvailabilityZoneTypeDef,
BatchStartRecommendationsErrorEntryTypeDef,
CancelReplicationTaskAssessmentRunMessageRequestTypeDef,
CertificateTypeDef,
CollectorHealthCheckTypeDef,
InventoryDataTypeDef,
CollectorShortInfoResponseTypeDef,
ConnectionTypeDef,
DmsTransferSettingsTypeDef,
DocDbSettingsTypeDef,
DynamoDbSettingsTypeDef,
ElasticsearchSettingsTypeDef,
GcpMySQLSettingsTypeDef,
IBMDb2SettingsTypeDef,
KafkaSettingsTypeDef,
KinesisSettingsTypeDef,
MicrosoftSQLServerSettingsTypeDef,
MongoDbSettingsTypeDef,
MySQLSettingsTypeDef,
NeptuneSettingsTypeDef,
OracleSettingsTypeDef,
PostgreSQLSettingsTypeDef,
RedisSettingsTypeDef,
RedshiftSettingsTypeDef,
S3SettingsTypeDef,
SybaseSettingsTypeDef,
EventSubscriptionTypeDef,
CreateFleetAdvisorCollectorRequestRequestTypeDef,
DatabaseInstanceSoftwareDetailsResponseTypeDef,
ServerShortInfoResponseTypeDef,
DatabaseShortInfoResponseTypeDef,
DeleteCertificateMessageRequestTypeDef,
DeleteCollectorRequestRequestTypeDef,
DeleteConnectionMessageRequestTypeDef,
DeleteEndpointMessageRequestTypeDef,
DeleteEventSubscriptionMessageRequestTypeDef,
DeleteFleetAdvisorDatabasesRequestRequestTypeDef,
DeleteReplicationInstanceMessageRequestTypeDef,
DeleteReplicationSubnetGroupMessageRequestTypeDef,
DeleteReplicationTaskAssessmentRunMessageRequestTypeDef,
DeleteReplicationTaskMessageRequestTypeDef,
DescribeApplicableIndividualAssessmentsMessageRequestTypeDef,
FilterTypeDef,
PaginatorConfigTypeDef,
WaiterConfigTypeDef,
DescribeEndpointSettingsMessageRequestTypeDef,
EndpointSettingTypeDef,
SupportedEndpointTypeTypeDef,
EventCategoryGroupTypeDef,
EventTypeDef,
DescribeFleetAdvisorLsaAnalysisRequestRequestTypeDef,
FleetAdvisorLsaAnalysisResponseTypeDef,
FleetAdvisorSchemaObjectResponseTypeDef,
DescribeOrderableReplicationInstancesMessageRequestTypeDef,
OrderableReplicationInstanceTypeDef,
LimitationTypeDef,
DescribeRefreshSchemasStatusMessageRequestTypeDef,
RefreshSchemasStatusTypeDef,
DescribeReplicationInstanceTaskLogsMessageRequestTypeDef,
ReplicationInstanceTaskLogTypeDef,
DescribeReplicationTaskAssessmentResultsMessageRequestTypeDef,
ReplicationTaskAssessmentResultTypeDef,
ReplicationTaskIndividualAssessmentTypeDef,
DescribeSchemasMessageRequestTypeDef,
TableStatisticsTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ModifyEventSubscriptionMessageRequestTypeDef,
ModifyReplicationInstanceMessageRequestTypeDef,
ModifyReplicationSubnetGroupMessageRequestTypeDef,
ModifyReplicationTaskMessageRequestTypeDef,
MoveReplicationTaskMessageRequestTypeDef,
PendingMaintenanceActionTypeDef,
RdsConfigurationTypeDef,
RdsRequirementsTypeDef,
RebootReplicationInstanceMessageRequestTypeDef,
RecommendationSettingsTypeDef,
RefreshSchemasMessageRequestTypeDef,
TableToReloadTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
ReplicationPendingModifiedValuesTypeDef,
VpcSecurityGroupMembershipTypeDef,
ReplicationTaskAssessmentRunProgressTypeDef,
ReplicationTaskStatsTypeDef,
SchemaShortInfoResponseTypeDef,
StartReplicationTaskAssessmentMessageRequestTypeDef,
StartReplicationTaskAssessmentRunMessageRequestTypeDef,
StartReplicationTaskMessageRequestTypeDef,
StopReplicationTaskMessageRequestTypeDef,
TestConnectionMessageRequestTypeDef,
UpdateSubscriptionsToEventBridgeMessageRequestTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CreateEventSubscriptionMessageRequestTypeDef,
CreateReplicationInstanceMessageRequestTypeDef,
CreateReplicationSubnetGroupMessageRequestTypeDef,
CreateReplicationTaskMessageRequestTypeDef,
ImportCertificateMessageRequestTypeDef,
CreateFleetAdvisorCollectorResponseTypeDef,
DeleteFleetAdvisorDatabasesResponseTypeDef,
DescribeAccountAttributesResponseTypeDef,
DescribeApplicableIndividualAssessmentsResponseTypeDef,
DescribeSchemasResponseTypeDef,
EmptyResponseMetadataTypeDef,
ListTagsForResourceResponseTypeDef,
ReloadTablesResponseTypeDef,
RunFleetAdvisorLsaAnalysisResponseTypeDef,
UpdateSubscriptionsToEventBridgeResponseTypeDef,
SubnetTypeDef,
BatchStartRecommendationsResponseTypeDef,
DeleteCertificateResponseTypeDef,
DescribeCertificatesResponseTypeDef,
ImportCertificateResponseTypeDef,
CollectorResponseTypeDef,
DeleteConnectionResponseTypeDef,
DescribeConnectionsResponseTypeDef,
TestConnectionResponseTypeDef,
CreateEndpointMessageRequestTypeDef,
EndpointTypeDef,
ModifyEndpointMessageRequestTypeDef,
CreateEventSubscriptionResponseTypeDef,
DeleteEventSubscriptionResponseTypeDef,
DescribeEventSubscriptionsResponseTypeDef,
ModifyEventSubscriptionResponseTypeDef,
DatabaseResponseTypeDef,
DescribeCertificatesMessageRequestTypeDef,
DescribeConnectionsMessageRequestTypeDef,
DescribeEndpointTypesMessageRequestTypeDef,
DescribeEndpointsMessageRequestTypeDef,
DescribeEventCategoriesMessageRequestTypeDef,
DescribeEventSubscriptionsMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeFleetAdvisorCollectorsRequestRequestTypeDef,
DescribeFleetAdvisorDatabasesRequestRequestTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryRequestRequestTypeDef,
DescribeFleetAdvisorSchemasRequestRequestTypeDef,
DescribePendingMaintenanceActionsMessageRequestTypeDef,
DescribeRecommendationLimitationsRequestRequestTypeDef,
DescribeRecommendationsRequestRequestTypeDef,
DescribeReplicationInstancesMessageRequestTypeDef,
DescribeReplicationSubnetGroupsMessageRequestTypeDef,
DescribeReplicationTaskAssessmentRunsMessageRequestTypeDef,
DescribeReplicationTaskIndividualAssessmentsMessageRequestTypeDef,
DescribeReplicationTasksMessageRequestTypeDef,
DescribeTableStatisticsMessageRequestTypeDef,
DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef,
DescribeConnectionsMessageDescribeConnectionsPaginateTypeDef,
DescribeEndpointTypesMessageDescribeEndpointTypesPaginateTypeDef,
DescribeEndpointsMessageDescribeEndpointsPaginateTypeDef,
DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeOrderableReplicationInstancesMessageDescribeOrderableReplicationInstancesPaginateTypeDef,
DescribeReplicationInstancesMessageDescribeReplicationInstancesPaginateTypeDef,
DescribeReplicationSubnetGroupsMessageDescribeReplicationSubnetGroupsPaginateTypeDef,
DescribeReplicationTaskAssessmentResultsMessageDescribeReplicationTaskAssessmentResultsPaginateTypeDef,
DescribeReplicationTasksMessageDescribeReplicationTasksPaginateTypeDef,
DescribeSchemasMessageDescribeSchemasPaginateTypeDef,
DescribeTableStatisticsMessageDescribeTableStatisticsPaginateTypeDef,
DescribeConnectionsMessageTestConnectionSucceedsWaitTypeDef,
DescribeEndpointsMessageEndpointDeletedWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceAvailableWaitTypeDef,
DescribeReplicationInstancesMessageReplicationInstanceDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskDeletedWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskReadyWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskRunningWaitTypeDef,
DescribeReplicationTasksMessageReplicationTaskStoppedWaitTypeDef,
DescribeEndpointSettingsResponseTypeDef,
DescribeEndpointTypesResponseTypeDef,
DescribeEventCategoriesResponseTypeDef,
DescribeEventsResponseTypeDef,
DescribeFleetAdvisorLsaAnalysisResponseTypeDef,
DescribeFleetAdvisorSchemaObjectSummaryResponseTypeDef,
DescribeOrderableReplicationInstancesResponseTypeDef,
DescribeRecommendationLimitationsResponseTypeDef,
DescribeRefreshSchemasStatusResponseTypeDef,
RefreshSchemasResponseTypeDef,
DescribeReplicationInstanceTaskLogsResponseTypeDef,
DescribeReplicationTaskAssessmentResultsResponseTypeDef,
DescribeReplicationTaskIndividualAssessmentsResponseTypeDef,
DescribeTableStatisticsResponseTypeDef,
ResourcePendingMaintenanceActionsTypeDef,
RdsRecommendationTypeDef,
StartRecommendationsRequestEntryTypeDef,
StartRecommendationsRequestRequestTypeDef,
ReloadTablesMessageRequestTypeDef,
ReplicationTaskAssessmentRunTypeDef,
ReplicationTaskTypeDef,
SchemaResponseTypeDef,
ReplicationSubnetGroupTypeDef,
DescribeFleetAdvisorCollectorsResponseTypeDef,
CreateEndpointResponseTypeDef,
DeleteEndpointResponseTypeDef,
DescribeEndpointsResponseTypeDef,
ModifyEndpointResponseTypeDef,
DescribeFleetAdvisorDatabasesResponseTypeDef,
ApplyPendingMaintenanceActionResponseTypeDef,
DescribePendingMaintenanceActionsResponseTypeDef,
RecommendationDataTypeDef,
BatchStartRecommendationsRequestRequestTypeDef,
CancelReplicationTaskAssessmentRunResponseTypeDef,
DeleteReplicationTaskAssessmentRunResponseTypeDef,
DescribeReplicationTaskAssessmentRunsResponseTypeDef,
StartReplicationTaskAssessmentRunResponseTypeDef,
CreateReplicationTaskResponseTypeDef,
DeleteReplicationTaskResponseTypeDef,
DescribeReplicationTasksResponseTypeDef,
ModifyReplicationTaskResponseTypeDef,
MoveReplicationTaskResponseTypeDef,
StartReplicationTaskAssessmentResponseTypeDef,
StartReplicationTaskResponseTypeDef,
StopReplicationTaskResponseTypeDef,
DescribeFleetAdvisorSchemasResponseTypeDef,
CreateReplicationSubnetGroupResponseTypeDef,
DescribeReplicationSubnetGroupsResponseTypeDef,
ModifyReplicationSubnetGroupResponseTypeDef,
ReplicationInstanceTypeDef,
RecommendationTypeDef,
CreateReplicationInstanceResponseTypeDef,
DeleteReplicationInstanceResponseTypeDef,
DescribeReplicationInstancesResponseTypeDef,
ModifyReplicationInstanceResponseTypeDef,
RebootReplicationInstanceResponseTypeDef,
DescribeRecommendationsResponseTypeDef,
)
def get_structure() -> AccountQuotaTypeDef:
return {...}
```
## 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.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-dms` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dms/)
## 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-dms-1.26.94
%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-dms -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.94-1
- Package Spec generated