%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-ssm
Version: 1.26.97
Release: 1
Summary: Type annotations for boto3.SSM 1.26.97 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/8c/65/708434f94cb04cc9b2c5133238f6177853e281f537663daf9146e8ad80a2/mypy-boto3-ssm-1.26.97.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-ssm
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-ssm)
Type annotations for
[boto3.SSM 1.26.97](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM)
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-ssm docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-ssm](#mypy-boto3-ssm)
- [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 `SSM`.
### From PyPI with pip
Install `boto3-stubs` for `SSM` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm]'
# 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[ssm]'
# standalone installation
python -m pip install mypy-boto3-ssm
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ssm
```
## 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[ssm]'`
```
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[ssm]'
```
- 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[ssm]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
- 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'`
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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
`SSMClient` provides annotations for `boto3.client("ssm")`.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
client: SSMClient = Session().client("ssm")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_ssm.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.paginator import (
DescribeActivationsPaginator,
DescribeAssociationExecutionTargetsPaginator,
DescribeAssociationExecutionsPaginator,
DescribeAutomationExecutionsPaginator,
DescribeAutomationStepExecutionsPaginator,
DescribeAvailablePatchesPaginator,
DescribeEffectiveInstanceAssociationsPaginator,
DescribeEffectivePatchesForPatchBaselinePaginator,
DescribeInstanceAssociationsStatusPaginator,
DescribeInstanceInformationPaginator,
DescribeInstancePatchStatesPaginator,
DescribeInstancePatchStatesForPatchGroupPaginator,
DescribeInstancePatchesPaginator,
DescribeInventoryDeletionsPaginator,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,
DescribeMaintenanceWindowExecutionTasksPaginator,
DescribeMaintenanceWindowExecutionsPaginator,
DescribeMaintenanceWindowSchedulePaginator,
DescribeMaintenanceWindowTargetsPaginator,
DescribeMaintenanceWindowTasksPaginator,
DescribeMaintenanceWindowsPaginator,
DescribeMaintenanceWindowsForTargetPaginator,
DescribeOpsItemsPaginator,
DescribeParametersPaginator,
DescribePatchBaselinesPaginator,
DescribePatchGroupsPaginator,
DescribePatchPropertiesPaginator,
DescribeSessionsPaginator,
GetInventoryPaginator,
GetInventorySchemaPaginator,
GetOpsSummaryPaginator,
GetParameterHistoryPaginator,
GetParametersByPathPaginator,
GetResourcePoliciesPaginator,
ListAssociationVersionsPaginator,
ListAssociationsPaginator,
ListCommandInvocationsPaginator,
ListCommandsPaginator,
ListComplianceItemsPaginator,
ListComplianceSummariesPaginator,
ListDocumentVersionsPaginator,
ListDocumentsPaginator,
ListOpsItemEventsPaginator,
ListOpsItemRelatedItemsPaginator,
ListOpsMetadataPaginator,
ListResourceComplianceSummariesPaginator,
ListResourceDataSyncPaginator,
)
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_activations_paginator: DescribeActivationsPaginator = client.get_paginator(
"describe_activations"
)
describe_association_execution_targets_paginator: DescribeAssociationExecutionTargetsPaginator = (
client.get_paginator("describe_association_execution_targets")
)
describe_association_executions_paginator: DescribeAssociationExecutionsPaginator = (
client.get_paginator("describe_association_executions")
)
describe_automation_executions_paginator: DescribeAutomationExecutionsPaginator = (
client.get_paginator("describe_automation_executions")
)
describe_automation_step_executions_paginator: DescribeAutomationStepExecutionsPaginator = (
client.get_paginator("describe_automation_step_executions")
)
describe_available_patches_paginator: DescribeAvailablePatchesPaginator = client.get_paginator(
"describe_available_patches"
)
describe_effective_instance_associations_paginator: DescribeEffectiveInstanceAssociationsPaginator = client.get_paginator(
"describe_effective_instance_associations"
)
describe_effective_patches_for_patch_baseline_paginator: DescribeEffectivePatchesForPatchBaselinePaginator = client.get_paginator(
"describe_effective_patches_for_patch_baseline"
)
describe_instance_associations_status_paginator: DescribeInstanceAssociationsStatusPaginator = (
client.get_paginator("describe_instance_associations_status")
)
describe_instance_information_paginator: DescribeInstanceInformationPaginator = (
client.get_paginator("describe_instance_information")
)
describe_instance_patch_states_paginator: DescribeInstancePatchStatesPaginator = (
client.get_paginator("describe_instance_patch_states")
)
describe_instance_patch_states_for_patch_group_paginator: DescribeInstancePatchStatesForPatchGroupPaginator = client.get_paginator(
"describe_instance_patch_states_for_patch_group"
)
describe_instance_patches_paginator: DescribeInstancePatchesPaginator = client.get_paginator(
"describe_instance_patches"
)
describe_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = client.get_paginator(
"describe_inventory_deletions"
)
describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowExecutionTaskInvocationsPaginator = client.get_paginator(
"describe_maintenance_window_execution_task_invocations"
)
describe_maintenance_window_execution_tasks_paginator: DescribeMaintenanceWindowExecutionTasksPaginator = client.get_paginator(
"describe_maintenance_window_execution_tasks"
)
describe_maintenance_window_executions_paginator: DescribeMaintenanceWindowExecutionsPaginator = (
client.get_paginator("describe_maintenance_window_executions")
)
describe_maintenance_window_schedule_paginator: DescribeMaintenanceWindowSchedulePaginator = (
client.get_paginator("describe_maintenance_window_schedule")
)
describe_maintenance_window_targets_paginator: DescribeMaintenanceWindowTargetsPaginator = (
client.get_paginator("describe_maintenance_window_targets")
)
describe_maintenance_window_tasks_paginator: DescribeMaintenanceWindowTasksPaginator = (
client.get_paginator("describe_maintenance_window_tasks")
)
describe_maintenance_windows_paginator: DescribeMaintenanceWindowsPaginator = client.get_paginator(
"describe_maintenance_windows"
)
describe_maintenance_windows_for_target_paginator: DescribeMaintenanceWindowsForTargetPaginator = (
client.get_paginator("describe_maintenance_windows_for_target")
)
describe_ops_items_paginator: DescribeOpsItemsPaginator = client.get_paginator("describe_ops_items")
describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator(
"describe_parameters"
)
describe_patch_baselines_paginator: DescribePatchBaselinesPaginator = client.get_paginator(
"describe_patch_baselines"
)
describe_patch_groups_paginator: DescribePatchGroupsPaginator = client.get_paginator(
"describe_patch_groups"
)
describe_patch_properties_paginator: DescribePatchPropertiesPaginator = client.get_paginator(
"describe_patch_properties"
)
describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator("describe_sessions")
get_inventory_paginator: GetInventoryPaginator = client.get_paginator("get_inventory")
get_inventory_schema_paginator: GetInventorySchemaPaginator = client.get_paginator(
"get_inventory_schema"
)
get_ops_summary_paginator: GetOpsSummaryPaginator = client.get_paginator("get_ops_summary")
get_parameter_history_paginator: GetParameterHistoryPaginator = client.get_paginator(
"get_parameter_history"
)
get_parameters_by_path_paginator: GetParametersByPathPaginator = client.get_paginator(
"get_parameters_by_path"
)
get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
"get_resource_policies"
)
list_association_versions_paginator: ListAssociationVersionsPaginator = client.get_paginator(
"list_association_versions"
)
list_associations_paginator: ListAssociationsPaginator = client.get_paginator("list_associations")
list_command_invocations_paginator: ListCommandInvocationsPaginator = client.get_paginator(
"list_command_invocations"
)
list_commands_paginator: ListCommandsPaginator = client.get_paginator("list_commands")
list_compliance_items_paginator: ListComplianceItemsPaginator = client.get_paginator(
"list_compliance_items"
)
list_compliance_summaries_paginator: ListComplianceSummariesPaginator = client.get_paginator(
"list_compliance_summaries"
)
list_document_versions_paginator: ListDocumentVersionsPaginator = client.get_paginator(
"list_document_versions"
)
list_documents_paginator: ListDocumentsPaginator = client.get_paginator("list_documents")
list_ops_item_events_paginator: ListOpsItemEventsPaginator = client.get_paginator(
"list_ops_item_events"
)
list_ops_item_related_items_paginator: ListOpsItemRelatedItemsPaginator = client.get_paginator(
"list_ops_item_related_items"
)
list_ops_metadata_paginator: ListOpsMetadataPaginator = client.get_paginator("list_ops_metadata")
list_resource_compliance_summaries_paginator: ListResourceComplianceSummariesPaginator = (
client.get_paginator("list_resource_compliance_summaries")
)
list_resource_data_sync_paginator: ListResourceDataSyncPaginator = client.get_paginator(
"list_resource_data_sync"
)
```
### Waiters annotations
`mypy_boto3_ssm.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.waiter import CommandExecutedWaiter
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
command_executed_waiter: CommandExecutedWaiter = client.get_waiter("command_executed")
```
### Literals
`mypy_boto3_ssm.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_ssm.literals import (
AssociationComplianceSeverityType,
AssociationExecutionFilterKeyType,
AssociationExecutionTargetsFilterKeyType,
AssociationFilterKeyType,
AssociationFilterOperatorTypeType,
AssociationStatusNameType,
AssociationSyncComplianceType,
AttachmentHashTypeType,
AttachmentsSourceKeyType,
AutomationExecutionFilterKeyType,
AutomationExecutionStatusType,
AutomationSubtypeType,
AutomationTypeType,
CalendarStateType,
CommandExecutedWaiterName,
CommandFilterKeyType,
CommandInvocationStatusType,
CommandPluginStatusType,
CommandStatusType,
ComplianceQueryOperatorTypeType,
ComplianceSeverityType,
ComplianceStatusType,
ComplianceUploadTypeType,
ConnectionStatusType,
DescribeActivationsFilterKeysType,
DescribeActivationsPaginatorName,
DescribeAssociationExecutionTargetsPaginatorName,
DescribeAssociationExecutionsPaginatorName,
DescribeAutomationExecutionsPaginatorName,
DescribeAutomationStepExecutionsPaginatorName,
DescribeAvailablePatchesPaginatorName,
DescribeEffectiveInstanceAssociationsPaginatorName,
DescribeEffectivePatchesForPatchBaselinePaginatorName,
DescribeInstanceAssociationsStatusPaginatorName,
DescribeInstanceInformationPaginatorName,
DescribeInstancePatchStatesForPatchGroupPaginatorName,
DescribeInstancePatchStatesPaginatorName,
DescribeInstancePatchesPaginatorName,
DescribeInventoryDeletionsPaginatorName,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorName,
DescribeMaintenanceWindowExecutionTasksPaginatorName,
DescribeMaintenanceWindowExecutionsPaginatorName,
DescribeMaintenanceWindowSchedulePaginatorName,
DescribeMaintenanceWindowTargetsPaginatorName,
DescribeMaintenanceWindowTasksPaginatorName,
DescribeMaintenanceWindowsForTargetPaginatorName,
DescribeMaintenanceWindowsPaginatorName,
DescribeOpsItemsPaginatorName,
DescribeParametersPaginatorName,
DescribePatchBaselinesPaginatorName,
DescribePatchGroupsPaginatorName,
DescribePatchPropertiesPaginatorName,
DescribeSessionsPaginatorName,
DocumentFilterKeyType,
DocumentFormatType,
DocumentHashTypeType,
DocumentMetadataEnumType,
DocumentParameterTypeType,
DocumentPermissionTypeType,
DocumentReviewActionType,
DocumentReviewCommentTypeType,
DocumentStatusType,
DocumentTypeType,
ExecutionModeType,
ExternalAlarmStateType,
FaultType,
GetInventoryPaginatorName,
GetInventorySchemaPaginatorName,
GetOpsSummaryPaginatorName,
GetParameterHistoryPaginatorName,
GetParametersByPathPaginatorName,
GetResourcePoliciesPaginatorName,
InstanceInformationFilterKeyType,
InstancePatchStateOperatorTypeType,
InventoryAttributeDataTypeType,
InventoryDeletionStatusType,
InventoryQueryOperatorTypeType,
InventorySchemaDeleteOptionType,
LastResourceDataSyncStatusType,
ListAssociationVersionsPaginatorName,
ListAssociationsPaginatorName,
ListCommandInvocationsPaginatorName,
ListCommandsPaginatorName,
ListComplianceItemsPaginatorName,
ListComplianceSummariesPaginatorName,
ListDocumentVersionsPaginatorName,
ListDocumentsPaginatorName,
ListOpsItemEventsPaginatorName,
ListOpsItemRelatedItemsPaginatorName,
ListOpsMetadataPaginatorName,
ListResourceComplianceSummariesPaginatorName,
ListResourceDataSyncPaginatorName,
MaintenanceWindowExecutionStatusType,
MaintenanceWindowResourceTypeType,
MaintenanceWindowTaskCutoffBehaviorType,
MaintenanceWindowTaskTypeType,
NotificationEventType,
NotificationTypeType,
OperatingSystemType,
OpsFilterOperatorTypeType,
OpsItemDataTypeType,
OpsItemEventFilterKeyType,
OpsItemEventFilterOperatorType,
OpsItemFilterKeyType,
OpsItemFilterOperatorType,
OpsItemRelatedItemsFilterKeyType,
OpsItemRelatedItemsFilterOperatorType,
OpsItemStatusType,
ParameterTierType,
ParameterTypeType,
ParametersFilterKeyType,
PatchActionType,
PatchComplianceDataStateType,
PatchComplianceLevelType,
PatchDeploymentStatusType,
PatchFilterKeyType,
PatchOperationTypeType,
PatchPropertyType,
PatchSetType,
PingStatusType,
PlatformTypeType,
RebootOptionType,
ResourceDataSyncS3FormatType,
ResourceTypeForTaggingType,
ResourceTypeType,
ReviewStatusType,
SessionFilterKeyType,
SessionStateType,
SessionStatusType,
SignalTypeType,
SourceTypeType,
StepExecutionFilterKeyType,
StopTypeType,
SSMServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AssociationComplianceSeverityType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_ssm.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_ssm.type_defs import (
AccountSharingInfoTypeDef,
TagTypeDef,
AlarmTypeDef,
AlarmStateInformationTypeDef,
AssociateOpsItemRelatedItemRequestRequestTypeDef,
ResponseMetadataTypeDef,
AssociationOverviewTypeDef,
AssociationStatusTypeDef,
TargetTypeDef,
AssociationExecutionFilterTypeDef,
OutputSourceTypeDef,
AssociationExecutionTargetsFilterTypeDef,
AssociationFilterTypeDef,
AttachmentContentTypeDef,
AttachmentInformationTypeDef,
AttachmentsSourceTypeDef,
AutomationExecutionFilterTypeDef,
ResolvedTargetsTypeDef,
ProgressCountersTypeDef,
PatchSourceTypeDef,
CancelCommandRequestRequestTypeDef,
CancelMaintenanceWindowExecutionRequestRequestTypeDef,
CloudWatchOutputConfigTypeDef,
CommandFilterTypeDef,
CommandPluginTypeDef,
NotificationConfigTypeDef,
ComplianceExecutionSummaryTypeDef,
ComplianceItemEntryTypeDef,
ComplianceStringFilterTypeDef,
SeveritySummaryTypeDef,
RegistrationMetadataItemTypeDef,
DocumentRequiresTypeDef,
OpsItemDataValueTypeDef,
OpsItemNotificationTypeDef,
RelatedOpsItemTypeDef,
MetadataValueTypeDef,
DeleteActivationRequestRequestTypeDef,
DeleteAssociationRequestRequestTypeDef,
DeleteDocumentRequestRequestTypeDef,
DeleteInventoryRequestRequestTypeDef,
DeleteMaintenanceWindowRequestRequestTypeDef,
DeleteOpsMetadataRequestRequestTypeDef,
DeleteParameterRequestRequestTypeDef,
DeleteParametersRequestRequestTypeDef,
DeletePatchBaselineRequestRequestTypeDef,
DeleteResourceDataSyncRequestRequestTypeDef,
DeleteResourcePolicyRequestRequestTypeDef,
DeregisterManagedInstanceRequestRequestTypeDef,
DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef,
DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef,
DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef,
DescribeActivationsFilterTypeDef,
PaginatorConfigTypeDef,
DescribeAssociationRequestRequestTypeDef,
StepExecutionFilterTypeDef,
PatchOrchestratorFilterTypeDef,
PatchTypeDef,
DescribeDocumentPermissionRequestRequestTypeDef,
DescribeDocumentRequestRequestTypeDef,
DescribeEffectiveInstanceAssociationsRequestRequestTypeDef,
InstanceAssociationTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef,
DescribeInstanceAssociationsStatusRequestRequestTypeDef,
InstanceInformationFilterTypeDef,
InstanceInformationStringFilterTypeDef,
InstancePatchStateFilterTypeDef,
InstancePatchStateTypeDef,
DescribeInstancePatchStatesRequestRequestTypeDef,
PatchComplianceDataTypeDef,
DescribeInventoryDeletionsRequestRequestTypeDef,
MaintenanceWindowFilterTypeDef,
MaintenanceWindowExecutionTaskInvocationIdentityTypeDef,
MaintenanceWindowExecutionTypeDef,
ScheduledWindowExecutionTypeDef,
MaintenanceWindowIdentityForTargetTypeDef,
MaintenanceWindowIdentityTypeDef,
OpsItemFilterTypeDef,
ParameterStringFilterTypeDef,
ParametersFilterTypeDef,
PatchBaselineIdentityTypeDef,
DescribePatchGroupStateRequestRequestTypeDef,
DescribePatchPropertiesRequestRequestTypeDef,
SessionFilterTypeDef,
DisassociateOpsItemRelatedItemRequestRequestTypeDef,
DocumentDefaultVersionDescriptionTypeDef,
DocumentParameterTypeDef,
ReviewInformationTypeDef,
DocumentFilterTypeDef,
DocumentKeyValuesFilterTypeDef,
DocumentReviewCommentSourceTypeDef,
DocumentVersionInfoTypeDef,
PatchStatusTypeDef,
FailureDetailsTypeDef,
GetAutomationExecutionRequestRequestTypeDef,
GetCalendarStateRequestRequestTypeDef,
WaiterConfigTypeDef,
GetCommandInvocationRequestRequestTypeDef,
GetConnectionStatusRequestRequestTypeDef,
GetDefaultPatchBaselineRequestRequestTypeDef,
GetDocumentRequestRequestTypeDef,
InventoryFilterTypeDef,
ResultAttributeTypeDef,
GetInventorySchemaRequestRequestTypeDef,
GetMaintenanceWindowExecutionRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskRequestRequestTypeDef,
MaintenanceWindowTaskParameterValueExpressionTypeDef,
GetMaintenanceWindowRequestRequestTypeDef,
GetMaintenanceWindowTaskRequestRequestTypeDef,
LoggingInfoTypeDef,
GetOpsItemRequestRequestTypeDef,
GetOpsMetadataRequestRequestTypeDef,
OpsFilterTypeDef,
OpsResultAttributeTypeDef,
GetParameterHistoryRequestRequestTypeDef,
GetParameterRequestRequestTypeDef,
ParameterTypeDef,
GetParametersRequestRequestTypeDef,
GetPatchBaselineForPatchGroupRequestRequestTypeDef,
GetPatchBaselineRequestRequestTypeDef,
GetResourcePoliciesRequestRequestTypeDef,
GetResourcePoliciesResponseEntryTypeDef,
GetServiceSettingRequestRequestTypeDef,
ServiceSettingTypeDef,
InstanceAggregatedAssociationOverviewTypeDef,
S3OutputLocationTypeDef,
S3OutputUrlTypeDef,
InventoryDeletionSummaryItemTypeDef,
InventoryItemAttributeTypeDef,
InventoryItemTypeDef,
InventoryResultItemTypeDef,
LabelParameterVersionRequestRequestTypeDef,
ListAssociationVersionsRequestRequestTypeDef,
ListDocumentMetadataHistoryRequestRequestTypeDef,
ListDocumentVersionsRequestRequestTypeDef,
OpsItemEventFilterTypeDef,
OpsItemRelatedItemsFilterTypeDef,
OpsMetadataFilterTypeDef,
OpsMetadataTypeDef,
ListResourceDataSyncRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
MaintenanceWindowAutomationParametersTypeDef,
MaintenanceWindowLambdaParametersTypeDef,
MaintenanceWindowStepFunctionsParametersTypeDef,
ModifyDocumentPermissionRequestRequestTypeDef,
OpsEntityItemTypeDef,
OpsItemIdentityTypeDef,
ParameterInlinePolicyTypeDef,
PatchFilterTypeDef,
PutResourcePolicyRequestRequestTypeDef,
RegisterDefaultPatchBaselineRequestRequestTypeDef,
RegisterPatchBaselineForPatchGroupRequestRequestTypeDef,
RemoveTagsFromResourceRequestRequestTypeDef,
ResetServiceSettingRequestRequestTypeDef,
ResourceDataSyncOrganizationalUnitTypeDef,
ResourceDataSyncDestinationDataSharingTypeDef,
ResumeSessionRequestRequestTypeDef,
SendAutomationSignalRequestRequestTypeDef,
SessionManagerOutputUrlTypeDef,
StartAssociationsOnceRequestRequestTypeDef,
StartSessionRequestRequestTypeDef,
StopAutomationExecutionRequestRequestTypeDef,
TerminateSessionRequestRequestTypeDef,
UnlabelParameterVersionRequestRequestTypeDef,
UpdateDocumentDefaultVersionRequestRequestTypeDef,
UpdateMaintenanceWindowRequestRequestTypeDef,
UpdateManagedInstanceRoleRequestRequestTypeDef,
UpdateServiceSettingRequestRequestTypeDef,
ActivationTypeDef,
AddTagsToResourceRequestRequestTypeDef,
CreateMaintenanceWindowRequestRequestTypeDef,
PutParameterRequestRequestTypeDef,
AlarmConfigurationTypeDef,
AssociateOpsItemRelatedItemResponseTypeDef,
CancelMaintenanceWindowExecutionResultTypeDef,
CreateActivationResultTypeDef,
CreateMaintenanceWindowResultTypeDef,
CreateOpsItemResponseTypeDef,
CreateOpsMetadataResultTypeDef,
CreatePatchBaselineResultTypeDef,
DeleteMaintenanceWindowResultTypeDef,
DeleteParametersResultTypeDef,
DeletePatchBaselineResultTypeDef,
DeregisterPatchBaselineForPatchGroupResultTypeDef,
DeregisterTargetFromMaintenanceWindowResultTypeDef,
DeregisterTaskFromMaintenanceWindowResultTypeDef,
DescribeDocumentPermissionResponseTypeDef,
DescribePatchGroupStateResultTypeDef,
DescribePatchPropertiesResultTypeDef,
GetCalendarStateResponseTypeDef,
GetConnectionStatusResponseTypeDef,
GetDefaultPatchBaselineResultTypeDef,
GetDeployablePatchSnapshotForInstanceResultTypeDef,
GetMaintenanceWindowExecutionResultTypeDef,
GetMaintenanceWindowExecutionTaskInvocationResultTypeDef,
GetMaintenanceWindowResultTypeDef,
GetPatchBaselineForPatchGroupResultTypeDef,
LabelParameterVersionResultTypeDef,
ListInventoryEntriesResultTypeDef,
ListTagsForResourceResultTypeDef,
PutInventoryResultTypeDef,
PutParameterResultTypeDef,
PutResourcePolicyResponseTypeDef,
RegisterDefaultPatchBaselineResultTypeDef,
RegisterPatchBaselineForPatchGroupResultTypeDef,
RegisterTargetWithMaintenanceWindowResultTypeDef,
RegisterTaskWithMaintenanceWindowResultTypeDef,
ResumeSessionResponseTypeDef,
StartAutomationExecutionResultTypeDef,
StartChangeRequestExecutionResultTypeDef,
StartSessionResponseTypeDef,
TerminateSessionResponseTypeDef,
UnlabelParameterVersionResultTypeDef,
UpdateMaintenanceWindowResultTypeDef,
UpdateOpsMetadataResultTypeDef,
UpdateAssociationStatusRequestRequestTypeDef,
AssociationTypeDef,
DescribeMaintenanceWindowsForTargetRequestRequestTypeDef,
MaintenanceWindowTargetTypeDef,
RegisterTargetWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTargetRequestRequestTypeDef,
UpdateMaintenanceWindowTargetResultTypeDef,
DescribeAssociationExecutionsRequestRequestTypeDef,
AssociationExecutionTargetTypeDef,
DescribeAssociationExecutionTargetsRequestRequestTypeDef,
ListAssociationsRequestRequestTypeDef,
UpdateDocumentRequestRequestTypeDef,
DescribeAutomationExecutionsRequestRequestTypeDef,
GetCommandInvocationResultTypeDef,
ListCommandInvocationsRequestRequestTypeDef,
ListCommandsRequestRequestTypeDef,
CommandInvocationTypeDef,
MaintenanceWindowRunCommandParametersTypeDef,
ComplianceItemTypeDef,
PutComplianceItemsRequestRequestTypeDef,
ListComplianceItemsRequestRequestTypeDef,
ListComplianceSummariesRequestRequestTypeDef,
ListResourceComplianceSummariesRequestRequestTypeDef,
CompliantSummaryTypeDef,
NonCompliantSummaryTypeDef,
CreateActivationRequestRequestTypeDef,
CreateDocumentRequestRequestTypeDef,
DocumentIdentifierTypeDef,
GetDocumentResultTypeDef,
OpsItemSummaryTypeDef,
CreateOpsItemRequestRequestTypeDef,
OpsItemTypeDef,
UpdateOpsItemRequestRequestTypeDef,
CreateOpsMetadataRequestRequestTypeDef,
GetOpsMetadataResultTypeDef,
UpdateOpsMetadataRequestRequestTypeDef,
DescribeActivationsRequestRequestTypeDef,
DescribeActivationsRequestDescribeActivationsPaginateTypeDef,
DescribeAssociationExecutionTargetsRequestDescribeAssociationExecutionTargetsPaginateTypeDef,
DescribeAssociationExecutionsRequestDescribeAssociationExecutionsPaginateTypeDef,
DescribeAutomationExecutionsRequestDescribeAutomationExecutionsPaginateTypeDef,
DescribeEffectiveInstanceAssociationsRequestDescribeEffectiveInstanceAssociationsPaginateTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestDescribeEffectivePatchesForPatchBaselinePaginateTypeDef,
DescribeInstanceAssociationsStatusRequestDescribeInstanceAssociationsStatusPaginateTypeDef,
DescribeInstancePatchStatesRequestDescribeInstancePatchStatesPaginateTypeDef,
DescribeInventoryDeletionsRequestDescribeInventoryDeletionsPaginateTypeDef,
DescribeMaintenanceWindowsForTargetRequestDescribeMaintenanceWindowsForTargetPaginateTypeDef,
DescribePatchPropertiesRequestDescribePatchPropertiesPaginateTypeDef,
GetInventorySchemaRequestGetInventorySchemaPaginateTypeDef,
GetParameterHistoryRequestGetParameterHistoryPaginateTypeDef,
GetResourcePoliciesRequestGetResourcePoliciesPaginateTypeDef,
ListAssociationVersionsRequestListAssociationVersionsPaginateTypeDef,
ListAssociationsRequestListAssociationsPaginateTypeDef,
ListCommandInvocationsRequestListCommandInvocationsPaginateTypeDef,
ListCommandsRequestListCommandsPaginateTypeDef,
ListComplianceItemsRequestListComplianceItemsPaginateTypeDef,
ListComplianceSummariesRequestListComplianceSummariesPaginateTypeDef,
ListDocumentVersionsRequestListDocumentVersionsPaginateTypeDef,
ListResourceComplianceSummariesRequestListResourceComplianceSummariesPaginateTypeDef,
ListResourceDataSyncRequestListResourceDataSyncPaginateTypeDef,
DescribeAutomationStepExecutionsRequestDescribeAutomationStepExecutionsPaginateTypeDef,
DescribeAutomationStepExecutionsRequestRequestTypeDef,
DescribeAvailablePatchesRequestDescribeAvailablePatchesPaginateTypeDef,
DescribeAvailablePatchesRequestRequestTypeDef,
DescribeInstancePatchesRequestDescribeInstancePatchesPaginateTypeDef,
DescribeInstancePatchesRequestRequestTypeDef,
DescribeMaintenanceWindowScheduleRequestDescribeMaintenanceWindowSchedulePaginateTypeDef,
DescribeMaintenanceWindowScheduleRequestRequestTypeDef,
DescribePatchBaselinesRequestDescribePatchBaselinesPaginateTypeDef,
DescribePatchBaselinesRequestRequestTypeDef,
DescribePatchGroupsRequestDescribePatchGroupsPaginateTypeDef,
DescribePatchGroupsRequestRequestTypeDef,
DescribeAvailablePatchesResultTypeDef,
DescribeEffectiveInstanceAssociationsResultTypeDef,
DescribeInstanceInformationRequestDescribeInstanceInformationPaginateTypeDef,
DescribeInstanceInformationRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestDescribeInstancePatchStatesForPatchGroupPaginateTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupResultTypeDef,
DescribeInstancePatchStatesResultTypeDef,
DescribeInstancePatchesResultTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestDescribeMaintenanceWindowExecutionTaskInvocationsPaginateTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestDescribeMaintenanceWindowExecutionTasksPaginateTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionsRequestDescribeMaintenanceWindowExecutionsPaginateTypeDef,
DescribeMaintenanceWindowExecutionsRequestRequestTypeDef,
DescribeMaintenanceWindowTargetsRequestDescribeMaintenanceWindowTargetsPaginateTypeDef,
DescribeMaintenanceWindowTargetsRequestRequestTypeDef,
DescribeMaintenanceWindowTasksRequestDescribeMaintenanceWindowTasksPaginateTypeDef,
DescribeMaintenanceWindowTasksRequestRequestTypeDef,
DescribeMaintenanceWindowsRequestDescribeMaintenanceWindowsPaginateTypeDef,
DescribeMaintenanceWindowsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef,
DescribeMaintenanceWindowExecutionsResultTypeDef,
DescribeMaintenanceWindowScheduleResultTypeDef,
DescribeMaintenanceWindowsForTargetResultTypeDef,
DescribeMaintenanceWindowsResultTypeDef,
DescribeOpsItemsRequestDescribeOpsItemsPaginateTypeDef,
DescribeOpsItemsRequestRequestTypeDef,
GetParametersByPathRequestGetParametersByPathPaginateTypeDef,
GetParametersByPathRequestRequestTypeDef,
DescribeParametersRequestDescribeParametersPaginateTypeDef,
DescribeParametersRequestRequestTypeDef,
DescribePatchBaselinesResultTypeDef,
PatchGroupPatchBaselineMappingTypeDef,
DescribeSessionsRequestDescribeSessionsPaginateTypeDef,
DescribeSessionsRequestRequestTypeDef,
UpdateDocumentDefaultVersionResultTypeDef,
DocumentDescriptionTypeDef,
ListDocumentsRequestListDocumentsPaginateTypeDef,
ListDocumentsRequestRequestTypeDef,
DocumentReviewerResponseSourceTypeDef,
DocumentReviewsTypeDef,
ListDocumentVersionsResultTypeDef,
EffectivePatchTypeDef,
GetCommandInvocationRequestCommandExecutedWaitTypeDef,
InventoryGroupTypeDef,
ListInventoryEntriesRequestRequestTypeDef,
GetInventoryRequestGetInventoryPaginateTypeDef,
GetInventoryRequestRequestTypeDef,
OpsAggregatorTypeDef,
GetOpsSummaryRequestGetOpsSummaryPaginateTypeDef,
GetOpsSummaryRequestRequestTypeDef,
GetParameterResultTypeDef,
GetParametersByPathResultTypeDef,
GetParametersResultTypeDef,
GetResourcePoliciesResponseTypeDef,
GetServiceSettingResultTypeDef,
ResetServiceSettingResultTypeDef,
InstanceInformationTypeDef,
InstanceAssociationOutputLocationTypeDef,
InstanceAssociationOutputUrlTypeDef,
InventoryDeletionSummaryTypeDef,
InventoryItemSchemaTypeDef,
PutInventoryRequestRequestTypeDef,
InventoryResultEntityTypeDef,
ListOpsItemEventsRequestListOpsItemEventsPaginateTypeDef,
ListOpsItemEventsRequestRequestTypeDef,
ListOpsItemRelatedItemsRequestListOpsItemRelatedItemsPaginateTypeDef,
ListOpsItemRelatedItemsRequestRequestTypeDef,
ListOpsMetadataRequestListOpsMetadataPaginateTypeDef,
ListOpsMetadataRequestRequestTypeDef,
ListOpsMetadataResultTypeDef,
OpsEntityTypeDef,
OpsItemEventSummaryTypeDef,
OpsItemRelatedItemSummaryTypeDef,
ParameterHistoryTypeDef,
ParameterMetadataTypeDef,
PatchFilterGroupTypeDef,
ResourceDataSyncAwsOrganizationsSourceTypeDef,
ResourceDataSyncS3DestinationTypeDef,
SessionTypeDef,
DescribeActivationsResultTypeDef,
AssociationExecutionTypeDef,
CommandTypeDef,
GetMaintenanceWindowExecutionTaskResultTypeDef,
MaintenanceWindowExecutionTaskIdentityTypeDef,
MaintenanceWindowTaskTypeDef,
SendCommandRequestRequestTypeDef,
TargetLocationTypeDef,
ListAssociationsResultTypeDef,
DescribeMaintenanceWindowTargetsResultTypeDef,
DescribeAssociationExecutionTargetsResultTypeDef,
ListCommandInvocationsResultTypeDef,
MaintenanceWindowTaskInvocationParametersTypeDef,
ListComplianceItemsResultTypeDef,
ComplianceSummaryItemTypeDef,
ResourceComplianceSummaryItemTypeDef,
ListDocumentsResultTypeDef,
DescribeOpsItemsResponseTypeDef,
GetOpsItemResponseTypeDef,
DescribePatchGroupsResultTypeDef,
CreateDocumentResultTypeDef,
DescribeDocumentResultTypeDef,
UpdateDocumentResultTypeDef,
DocumentMetadataResponseInfoTypeDef,
UpdateDocumentMetadataRequestRequestTypeDef,
DescribeEffectivePatchesForPatchBaselineResultTypeDef,
InventoryAggregatorTypeDef,
DescribeInstanceInformationResultTypeDef,
InstanceAssociationStatusInfoTypeDef,
DeleteInventoryResultTypeDef,
InventoryDeletionStatusItemTypeDef,
GetInventorySchemaResultTypeDef,
GetInventoryResultTypeDef,
GetOpsSummaryResultTypeDef,
ListOpsItemEventsResponseTypeDef,
ListOpsItemRelatedItemsResponseTypeDef,
GetParameterHistoryResultTypeDef,
DescribeParametersResultTypeDef,
PatchRuleTypeDef,
ResourceDataSyncSourceTypeDef,
ResourceDataSyncSourceWithStateTypeDef,
DescribeSessionsResponseTypeDef,
DescribeAssociationExecutionsResultTypeDef,
ListCommandsResultTypeDef,
SendCommandResultTypeDef,
DescribeMaintenanceWindowExecutionTasksResultTypeDef,
DescribeMaintenanceWindowTasksResultTypeDef,
AssociationDescriptionTypeDef,
AssociationVersionInfoTypeDef,
CreateAssociationBatchRequestEntryTypeDef,
CreateAssociationRequestRequestTypeDef,
RunbookTypeDef,
StartAutomationExecutionRequestRequestTypeDef,
StepExecutionTypeDef,
UpdateAssociationRequestRequestTypeDef,
GetMaintenanceWindowTaskResultTypeDef,
RegisterTaskWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTaskRequestRequestTypeDef,
UpdateMaintenanceWindowTaskResultTypeDef,
ListComplianceSummariesResultTypeDef,
ListResourceComplianceSummariesResultTypeDef,
ListDocumentMetadataHistoryResponseTypeDef,
DescribeInstanceAssociationsStatusResultTypeDef,
DescribeInventoryDeletionsResultTypeDef,
PatchRuleGroupTypeDef,
CreateResourceDataSyncRequestRequestTypeDef,
UpdateResourceDataSyncRequestRequestTypeDef,
ResourceDataSyncItemTypeDef,
CreateAssociationResultTypeDef,
DescribeAssociationResultTypeDef,
UpdateAssociationResultTypeDef,
UpdateAssociationStatusResultTypeDef,
ListAssociationVersionsResultTypeDef,
CreateAssociationBatchRequestRequestTypeDef,
FailedCreateAssociationTypeDef,
AutomationExecutionMetadataTypeDef,
StartChangeRequestExecutionRequestRequestTypeDef,
AutomationExecutionTypeDef,
DescribeAutomationStepExecutionsResultTypeDef,
BaselineOverrideTypeDef,
CreatePatchBaselineRequestRequestTypeDef,
GetPatchBaselineResultTypeDef,
UpdatePatchBaselineRequestRequestTypeDef,
UpdatePatchBaselineResultTypeDef,
ListResourceDataSyncResultTypeDef,
CreateAssociationBatchResultTypeDef,
DescribeAutomationExecutionsResultTypeDef,
GetAutomationExecutionResultTypeDef,
GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef,
)
def get_structure() -> AccountSharingInfoTypeDef:
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-ssm` 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_ssm/)
## 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-ssm
Summary: Type annotations for boto3.SSM 1.26.97 service generated with mypy-boto3-builder 7.13.0
Provides: python-mypy-boto3-ssm
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-ssm
# mypy-boto3-ssm
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-ssm)
Type annotations for
[boto3.SSM 1.26.97](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM)
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-ssm docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-ssm](#mypy-boto3-ssm)
- [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 `SSM`.
### From PyPI with pip
Install `boto3-stubs` for `SSM` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm]'
# 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[ssm]'
# standalone installation
python -m pip install mypy-boto3-ssm
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ssm
```
## 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[ssm]'`
```
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[ssm]'
```
- 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[ssm]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
- 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'`
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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
`SSMClient` provides annotations for `boto3.client("ssm")`.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
client: SSMClient = Session().client("ssm")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_ssm.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.paginator import (
DescribeActivationsPaginator,
DescribeAssociationExecutionTargetsPaginator,
DescribeAssociationExecutionsPaginator,
DescribeAutomationExecutionsPaginator,
DescribeAutomationStepExecutionsPaginator,
DescribeAvailablePatchesPaginator,
DescribeEffectiveInstanceAssociationsPaginator,
DescribeEffectivePatchesForPatchBaselinePaginator,
DescribeInstanceAssociationsStatusPaginator,
DescribeInstanceInformationPaginator,
DescribeInstancePatchStatesPaginator,
DescribeInstancePatchStatesForPatchGroupPaginator,
DescribeInstancePatchesPaginator,
DescribeInventoryDeletionsPaginator,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,
DescribeMaintenanceWindowExecutionTasksPaginator,
DescribeMaintenanceWindowExecutionsPaginator,
DescribeMaintenanceWindowSchedulePaginator,
DescribeMaintenanceWindowTargetsPaginator,
DescribeMaintenanceWindowTasksPaginator,
DescribeMaintenanceWindowsPaginator,
DescribeMaintenanceWindowsForTargetPaginator,
DescribeOpsItemsPaginator,
DescribeParametersPaginator,
DescribePatchBaselinesPaginator,
DescribePatchGroupsPaginator,
DescribePatchPropertiesPaginator,
DescribeSessionsPaginator,
GetInventoryPaginator,
GetInventorySchemaPaginator,
GetOpsSummaryPaginator,
GetParameterHistoryPaginator,
GetParametersByPathPaginator,
GetResourcePoliciesPaginator,
ListAssociationVersionsPaginator,
ListAssociationsPaginator,
ListCommandInvocationsPaginator,
ListCommandsPaginator,
ListComplianceItemsPaginator,
ListComplianceSummariesPaginator,
ListDocumentVersionsPaginator,
ListDocumentsPaginator,
ListOpsItemEventsPaginator,
ListOpsItemRelatedItemsPaginator,
ListOpsMetadataPaginator,
ListResourceComplianceSummariesPaginator,
ListResourceDataSyncPaginator,
)
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_activations_paginator: DescribeActivationsPaginator = client.get_paginator(
"describe_activations"
)
describe_association_execution_targets_paginator: DescribeAssociationExecutionTargetsPaginator = (
client.get_paginator("describe_association_execution_targets")
)
describe_association_executions_paginator: DescribeAssociationExecutionsPaginator = (
client.get_paginator("describe_association_executions")
)
describe_automation_executions_paginator: DescribeAutomationExecutionsPaginator = (
client.get_paginator("describe_automation_executions")
)
describe_automation_step_executions_paginator: DescribeAutomationStepExecutionsPaginator = (
client.get_paginator("describe_automation_step_executions")
)
describe_available_patches_paginator: DescribeAvailablePatchesPaginator = client.get_paginator(
"describe_available_patches"
)
describe_effective_instance_associations_paginator: DescribeEffectiveInstanceAssociationsPaginator = client.get_paginator(
"describe_effective_instance_associations"
)
describe_effective_patches_for_patch_baseline_paginator: DescribeEffectivePatchesForPatchBaselinePaginator = client.get_paginator(
"describe_effective_patches_for_patch_baseline"
)
describe_instance_associations_status_paginator: DescribeInstanceAssociationsStatusPaginator = (
client.get_paginator("describe_instance_associations_status")
)
describe_instance_information_paginator: DescribeInstanceInformationPaginator = (
client.get_paginator("describe_instance_information")
)
describe_instance_patch_states_paginator: DescribeInstancePatchStatesPaginator = (
client.get_paginator("describe_instance_patch_states")
)
describe_instance_patch_states_for_patch_group_paginator: DescribeInstancePatchStatesForPatchGroupPaginator = client.get_paginator(
"describe_instance_patch_states_for_patch_group"
)
describe_instance_patches_paginator: DescribeInstancePatchesPaginator = client.get_paginator(
"describe_instance_patches"
)
describe_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = client.get_paginator(
"describe_inventory_deletions"
)
describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowExecutionTaskInvocationsPaginator = client.get_paginator(
"describe_maintenance_window_execution_task_invocations"
)
describe_maintenance_window_execution_tasks_paginator: DescribeMaintenanceWindowExecutionTasksPaginator = client.get_paginator(
"describe_maintenance_window_execution_tasks"
)
describe_maintenance_window_executions_paginator: DescribeMaintenanceWindowExecutionsPaginator = (
client.get_paginator("describe_maintenance_window_executions")
)
describe_maintenance_window_schedule_paginator: DescribeMaintenanceWindowSchedulePaginator = (
client.get_paginator("describe_maintenance_window_schedule")
)
describe_maintenance_window_targets_paginator: DescribeMaintenanceWindowTargetsPaginator = (
client.get_paginator("describe_maintenance_window_targets")
)
describe_maintenance_window_tasks_paginator: DescribeMaintenanceWindowTasksPaginator = (
client.get_paginator("describe_maintenance_window_tasks")
)
describe_maintenance_windows_paginator: DescribeMaintenanceWindowsPaginator = client.get_paginator(
"describe_maintenance_windows"
)
describe_maintenance_windows_for_target_paginator: DescribeMaintenanceWindowsForTargetPaginator = (
client.get_paginator("describe_maintenance_windows_for_target")
)
describe_ops_items_paginator: DescribeOpsItemsPaginator = client.get_paginator("describe_ops_items")
describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator(
"describe_parameters"
)
describe_patch_baselines_paginator: DescribePatchBaselinesPaginator = client.get_paginator(
"describe_patch_baselines"
)
describe_patch_groups_paginator: DescribePatchGroupsPaginator = client.get_paginator(
"describe_patch_groups"
)
describe_patch_properties_paginator: DescribePatchPropertiesPaginator = client.get_paginator(
"describe_patch_properties"
)
describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator("describe_sessions")
get_inventory_paginator: GetInventoryPaginator = client.get_paginator("get_inventory")
get_inventory_schema_paginator: GetInventorySchemaPaginator = client.get_paginator(
"get_inventory_schema"
)
get_ops_summary_paginator: GetOpsSummaryPaginator = client.get_paginator("get_ops_summary")
get_parameter_history_paginator: GetParameterHistoryPaginator = client.get_paginator(
"get_parameter_history"
)
get_parameters_by_path_paginator: GetParametersByPathPaginator = client.get_paginator(
"get_parameters_by_path"
)
get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
"get_resource_policies"
)
list_association_versions_paginator: ListAssociationVersionsPaginator = client.get_paginator(
"list_association_versions"
)
list_associations_paginator: ListAssociationsPaginator = client.get_paginator("list_associations")
list_command_invocations_paginator: ListCommandInvocationsPaginator = client.get_paginator(
"list_command_invocations"
)
list_commands_paginator: ListCommandsPaginator = client.get_paginator("list_commands")
list_compliance_items_paginator: ListComplianceItemsPaginator = client.get_paginator(
"list_compliance_items"
)
list_compliance_summaries_paginator: ListComplianceSummariesPaginator = client.get_paginator(
"list_compliance_summaries"
)
list_document_versions_paginator: ListDocumentVersionsPaginator = client.get_paginator(
"list_document_versions"
)
list_documents_paginator: ListDocumentsPaginator = client.get_paginator("list_documents")
list_ops_item_events_paginator: ListOpsItemEventsPaginator = client.get_paginator(
"list_ops_item_events"
)
list_ops_item_related_items_paginator: ListOpsItemRelatedItemsPaginator = client.get_paginator(
"list_ops_item_related_items"
)
list_ops_metadata_paginator: ListOpsMetadataPaginator = client.get_paginator("list_ops_metadata")
list_resource_compliance_summaries_paginator: ListResourceComplianceSummariesPaginator = (
client.get_paginator("list_resource_compliance_summaries")
)
list_resource_data_sync_paginator: ListResourceDataSyncPaginator = client.get_paginator(
"list_resource_data_sync"
)
```
### Waiters annotations
`mypy_boto3_ssm.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.waiter import CommandExecutedWaiter
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
command_executed_waiter: CommandExecutedWaiter = client.get_waiter("command_executed")
```
### Literals
`mypy_boto3_ssm.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_ssm.literals import (
AssociationComplianceSeverityType,
AssociationExecutionFilterKeyType,
AssociationExecutionTargetsFilterKeyType,
AssociationFilterKeyType,
AssociationFilterOperatorTypeType,
AssociationStatusNameType,
AssociationSyncComplianceType,
AttachmentHashTypeType,
AttachmentsSourceKeyType,
AutomationExecutionFilterKeyType,
AutomationExecutionStatusType,
AutomationSubtypeType,
AutomationTypeType,
CalendarStateType,
CommandExecutedWaiterName,
CommandFilterKeyType,
CommandInvocationStatusType,
CommandPluginStatusType,
CommandStatusType,
ComplianceQueryOperatorTypeType,
ComplianceSeverityType,
ComplianceStatusType,
ComplianceUploadTypeType,
ConnectionStatusType,
DescribeActivationsFilterKeysType,
DescribeActivationsPaginatorName,
DescribeAssociationExecutionTargetsPaginatorName,
DescribeAssociationExecutionsPaginatorName,
DescribeAutomationExecutionsPaginatorName,
DescribeAutomationStepExecutionsPaginatorName,
DescribeAvailablePatchesPaginatorName,
DescribeEffectiveInstanceAssociationsPaginatorName,
DescribeEffectivePatchesForPatchBaselinePaginatorName,
DescribeInstanceAssociationsStatusPaginatorName,
DescribeInstanceInformationPaginatorName,
DescribeInstancePatchStatesForPatchGroupPaginatorName,
DescribeInstancePatchStatesPaginatorName,
DescribeInstancePatchesPaginatorName,
DescribeInventoryDeletionsPaginatorName,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorName,
DescribeMaintenanceWindowExecutionTasksPaginatorName,
DescribeMaintenanceWindowExecutionsPaginatorName,
DescribeMaintenanceWindowSchedulePaginatorName,
DescribeMaintenanceWindowTargetsPaginatorName,
DescribeMaintenanceWindowTasksPaginatorName,
DescribeMaintenanceWindowsForTargetPaginatorName,
DescribeMaintenanceWindowsPaginatorName,
DescribeOpsItemsPaginatorName,
DescribeParametersPaginatorName,
DescribePatchBaselinesPaginatorName,
DescribePatchGroupsPaginatorName,
DescribePatchPropertiesPaginatorName,
DescribeSessionsPaginatorName,
DocumentFilterKeyType,
DocumentFormatType,
DocumentHashTypeType,
DocumentMetadataEnumType,
DocumentParameterTypeType,
DocumentPermissionTypeType,
DocumentReviewActionType,
DocumentReviewCommentTypeType,
DocumentStatusType,
DocumentTypeType,
ExecutionModeType,
ExternalAlarmStateType,
FaultType,
GetInventoryPaginatorName,
GetInventorySchemaPaginatorName,
GetOpsSummaryPaginatorName,
GetParameterHistoryPaginatorName,
GetParametersByPathPaginatorName,
GetResourcePoliciesPaginatorName,
InstanceInformationFilterKeyType,
InstancePatchStateOperatorTypeType,
InventoryAttributeDataTypeType,
InventoryDeletionStatusType,
InventoryQueryOperatorTypeType,
InventorySchemaDeleteOptionType,
LastResourceDataSyncStatusType,
ListAssociationVersionsPaginatorName,
ListAssociationsPaginatorName,
ListCommandInvocationsPaginatorName,
ListCommandsPaginatorName,
ListComplianceItemsPaginatorName,
ListComplianceSummariesPaginatorName,
ListDocumentVersionsPaginatorName,
ListDocumentsPaginatorName,
ListOpsItemEventsPaginatorName,
ListOpsItemRelatedItemsPaginatorName,
ListOpsMetadataPaginatorName,
ListResourceComplianceSummariesPaginatorName,
ListResourceDataSyncPaginatorName,
MaintenanceWindowExecutionStatusType,
MaintenanceWindowResourceTypeType,
MaintenanceWindowTaskCutoffBehaviorType,
MaintenanceWindowTaskTypeType,
NotificationEventType,
NotificationTypeType,
OperatingSystemType,
OpsFilterOperatorTypeType,
OpsItemDataTypeType,
OpsItemEventFilterKeyType,
OpsItemEventFilterOperatorType,
OpsItemFilterKeyType,
OpsItemFilterOperatorType,
OpsItemRelatedItemsFilterKeyType,
OpsItemRelatedItemsFilterOperatorType,
OpsItemStatusType,
ParameterTierType,
ParameterTypeType,
ParametersFilterKeyType,
PatchActionType,
PatchComplianceDataStateType,
PatchComplianceLevelType,
PatchDeploymentStatusType,
PatchFilterKeyType,
PatchOperationTypeType,
PatchPropertyType,
PatchSetType,
PingStatusType,
PlatformTypeType,
RebootOptionType,
ResourceDataSyncS3FormatType,
ResourceTypeForTaggingType,
ResourceTypeType,
ReviewStatusType,
SessionFilterKeyType,
SessionStateType,
SessionStatusType,
SignalTypeType,
SourceTypeType,
StepExecutionFilterKeyType,
StopTypeType,
SSMServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AssociationComplianceSeverityType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_ssm.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_ssm.type_defs import (
AccountSharingInfoTypeDef,
TagTypeDef,
AlarmTypeDef,
AlarmStateInformationTypeDef,
AssociateOpsItemRelatedItemRequestRequestTypeDef,
ResponseMetadataTypeDef,
AssociationOverviewTypeDef,
AssociationStatusTypeDef,
TargetTypeDef,
AssociationExecutionFilterTypeDef,
OutputSourceTypeDef,
AssociationExecutionTargetsFilterTypeDef,
AssociationFilterTypeDef,
AttachmentContentTypeDef,
AttachmentInformationTypeDef,
AttachmentsSourceTypeDef,
AutomationExecutionFilterTypeDef,
ResolvedTargetsTypeDef,
ProgressCountersTypeDef,
PatchSourceTypeDef,
CancelCommandRequestRequestTypeDef,
CancelMaintenanceWindowExecutionRequestRequestTypeDef,
CloudWatchOutputConfigTypeDef,
CommandFilterTypeDef,
CommandPluginTypeDef,
NotificationConfigTypeDef,
ComplianceExecutionSummaryTypeDef,
ComplianceItemEntryTypeDef,
ComplianceStringFilterTypeDef,
SeveritySummaryTypeDef,
RegistrationMetadataItemTypeDef,
DocumentRequiresTypeDef,
OpsItemDataValueTypeDef,
OpsItemNotificationTypeDef,
RelatedOpsItemTypeDef,
MetadataValueTypeDef,
DeleteActivationRequestRequestTypeDef,
DeleteAssociationRequestRequestTypeDef,
DeleteDocumentRequestRequestTypeDef,
DeleteInventoryRequestRequestTypeDef,
DeleteMaintenanceWindowRequestRequestTypeDef,
DeleteOpsMetadataRequestRequestTypeDef,
DeleteParameterRequestRequestTypeDef,
DeleteParametersRequestRequestTypeDef,
DeletePatchBaselineRequestRequestTypeDef,
DeleteResourceDataSyncRequestRequestTypeDef,
DeleteResourcePolicyRequestRequestTypeDef,
DeregisterManagedInstanceRequestRequestTypeDef,
DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef,
DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef,
DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef,
DescribeActivationsFilterTypeDef,
PaginatorConfigTypeDef,
DescribeAssociationRequestRequestTypeDef,
StepExecutionFilterTypeDef,
PatchOrchestratorFilterTypeDef,
PatchTypeDef,
DescribeDocumentPermissionRequestRequestTypeDef,
DescribeDocumentRequestRequestTypeDef,
DescribeEffectiveInstanceAssociationsRequestRequestTypeDef,
InstanceAssociationTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef,
DescribeInstanceAssociationsStatusRequestRequestTypeDef,
InstanceInformationFilterTypeDef,
InstanceInformationStringFilterTypeDef,
InstancePatchStateFilterTypeDef,
InstancePatchStateTypeDef,
DescribeInstancePatchStatesRequestRequestTypeDef,
PatchComplianceDataTypeDef,
DescribeInventoryDeletionsRequestRequestTypeDef,
MaintenanceWindowFilterTypeDef,
MaintenanceWindowExecutionTaskInvocationIdentityTypeDef,
MaintenanceWindowExecutionTypeDef,
ScheduledWindowExecutionTypeDef,
MaintenanceWindowIdentityForTargetTypeDef,
MaintenanceWindowIdentityTypeDef,
OpsItemFilterTypeDef,
ParameterStringFilterTypeDef,
ParametersFilterTypeDef,
PatchBaselineIdentityTypeDef,
DescribePatchGroupStateRequestRequestTypeDef,
DescribePatchPropertiesRequestRequestTypeDef,
SessionFilterTypeDef,
DisassociateOpsItemRelatedItemRequestRequestTypeDef,
DocumentDefaultVersionDescriptionTypeDef,
DocumentParameterTypeDef,
ReviewInformationTypeDef,
DocumentFilterTypeDef,
DocumentKeyValuesFilterTypeDef,
DocumentReviewCommentSourceTypeDef,
DocumentVersionInfoTypeDef,
PatchStatusTypeDef,
FailureDetailsTypeDef,
GetAutomationExecutionRequestRequestTypeDef,
GetCalendarStateRequestRequestTypeDef,
WaiterConfigTypeDef,
GetCommandInvocationRequestRequestTypeDef,
GetConnectionStatusRequestRequestTypeDef,
GetDefaultPatchBaselineRequestRequestTypeDef,
GetDocumentRequestRequestTypeDef,
InventoryFilterTypeDef,
ResultAttributeTypeDef,
GetInventorySchemaRequestRequestTypeDef,
GetMaintenanceWindowExecutionRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskRequestRequestTypeDef,
MaintenanceWindowTaskParameterValueExpressionTypeDef,
GetMaintenanceWindowRequestRequestTypeDef,
GetMaintenanceWindowTaskRequestRequestTypeDef,
LoggingInfoTypeDef,
GetOpsItemRequestRequestTypeDef,
GetOpsMetadataRequestRequestTypeDef,
OpsFilterTypeDef,
OpsResultAttributeTypeDef,
GetParameterHistoryRequestRequestTypeDef,
GetParameterRequestRequestTypeDef,
ParameterTypeDef,
GetParametersRequestRequestTypeDef,
GetPatchBaselineForPatchGroupRequestRequestTypeDef,
GetPatchBaselineRequestRequestTypeDef,
GetResourcePoliciesRequestRequestTypeDef,
GetResourcePoliciesResponseEntryTypeDef,
GetServiceSettingRequestRequestTypeDef,
ServiceSettingTypeDef,
InstanceAggregatedAssociationOverviewTypeDef,
S3OutputLocationTypeDef,
S3OutputUrlTypeDef,
InventoryDeletionSummaryItemTypeDef,
InventoryItemAttributeTypeDef,
InventoryItemTypeDef,
InventoryResultItemTypeDef,
LabelParameterVersionRequestRequestTypeDef,
ListAssociationVersionsRequestRequestTypeDef,
ListDocumentMetadataHistoryRequestRequestTypeDef,
ListDocumentVersionsRequestRequestTypeDef,
OpsItemEventFilterTypeDef,
OpsItemRelatedItemsFilterTypeDef,
OpsMetadataFilterTypeDef,
OpsMetadataTypeDef,
ListResourceDataSyncRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
MaintenanceWindowAutomationParametersTypeDef,
MaintenanceWindowLambdaParametersTypeDef,
MaintenanceWindowStepFunctionsParametersTypeDef,
ModifyDocumentPermissionRequestRequestTypeDef,
OpsEntityItemTypeDef,
OpsItemIdentityTypeDef,
ParameterInlinePolicyTypeDef,
PatchFilterTypeDef,
PutResourcePolicyRequestRequestTypeDef,
RegisterDefaultPatchBaselineRequestRequestTypeDef,
RegisterPatchBaselineForPatchGroupRequestRequestTypeDef,
RemoveTagsFromResourceRequestRequestTypeDef,
ResetServiceSettingRequestRequestTypeDef,
ResourceDataSyncOrganizationalUnitTypeDef,
ResourceDataSyncDestinationDataSharingTypeDef,
ResumeSessionRequestRequestTypeDef,
SendAutomationSignalRequestRequestTypeDef,
SessionManagerOutputUrlTypeDef,
StartAssociationsOnceRequestRequestTypeDef,
StartSessionRequestRequestTypeDef,
StopAutomationExecutionRequestRequestTypeDef,
TerminateSessionRequestRequestTypeDef,
UnlabelParameterVersionRequestRequestTypeDef,
UpdateDocumentDefaultVersionRequestRequestTypeDef,
UpdateMaintenanceWindowRequestRequestTypeDef,
UpdateManagedInstanceRoleRequestRequestTypeDef,
UpdateServiceSettingRequestRequestTypeDef,
ActivationTypeDef,
AddTagsToResourceRequestRequestTypeDef,
CreateMaintenanceWindowRequestRequestTypeDef,
PutParameterRequestRequestTypeDef,
AlarmConfigurationTypeDef,
AssociateOpsItemRelatedItemResponseTypeDef,
CancelMaintenanceWindowExecutionResultTypeDef,
CreateActivationResultTypeDef,
CreateMaintenanceWindowResultTypeDef,
CreateOpsItemResponseTypeDef,
CreateOpsMetadataResultTypeDef,
CreatePatchBaselineResultTypeDef,
DeleteMaintenanceWindowResultTypeDef,
DeleteParametersResultTypeDef,
DeletePatchBaselineResultTypeDef,
DeregisterPatchBaselineForPatchGroupResultTypeDef,
DeregisterTargetFromMaintenanceWindowResultTypeDef,
DeregisterTaskFromMaintenanceWindowResultTypeDef,
DescribeDocumentPermissionResponseTypeDef,
DescribePatchGroupStateResultTypeDef,
DescribePatchPropertiesResultTypeDef,
GetCalendarStateResponseTypeDef,
GetConnectionStatusResponseTypeDef,
GetDefaultPatchBaselineResultTypeDef,
GetDeployablePatchSnapshotForInstanceResultTypeDef,
GetMaintenanceWindowExecutionResultTypeDef,
GetMaintenanceWindowExecutionTaskInvocationResultTypeDef,
GetMaintenanceWindowResultTypeDef,
GetPatchBaselineForPatchGroupResultTypeDef,
LabelParameterVersionResultTypeDef,
ListInventoryEntriesResultTypeDef,
ListTagsForResourceResultTypeDef,
PutInventoryResultTypeDef,
PutParameterResultTypeDef,
PutResourcePolicyResponseTypeDef,
RegisterDefaultPatchBaselineResultTypeDef,
RegisterPatchBaselineForPatchGroupResultTypeDef,
RegisterTargetWithMaintenanceWindowResultTypeDef,
RegisterTaskWithMaintenanceWindowResultTypeDef,
ResumeSessionResponseTypeDef,
StartAutomationExecutionResultTypeDef,
StartChangeRequestExecutionResultTypeDef,
StartSessionResponseTypeDef,
TerminateSessionResponseTypeDef,
UnlabelParameterVersionResultTypeDef,
UpdateMaintenanceWindowResultTypeDef,
UpdateOpsMetadataResultTypeDef,
UpdateAssociationStatusRequestRequestTypeDef,
AssociationTypeDef,
DescribeMaintenanceWindowsForTargetRequestRequestTypeDef,
MaintenanceWindowTargetTypeDef,
RegisterTargetWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTargetRequestRequestTypeDef,
UpdateMaintenanceWindowTargetResultTypeDef,
DescribeAssociationExecutionsRequestRequestTypeDef,
AssociationExecutionTargetTypeDef,
DescribeAssociationExecutionTargetsRequestRequestTypeDef,
ListAssociationsRequestRequestTypeDef,
UpdateDocumentRequestRequestTypeDef,
DescribeAutomationExecutionsRequestRequestTypeDef,
GetCommandInvocationResultTypeDef,
ListCommandInvocationsRequestRequestTypeDef,
ListCommandsRequestRequestTypeDef,
CommandInvocationTypeDef,
MaintenanceWindowRunCommandParametersTypeDef,
ComplianceItemTypeDef,
PutComplianceItemsRequestRequestTypeDef,
ListComplianceItemsRequestRequestTypeDef,
ListComplianceSummariesRequestRequestTypeDef,
ListResourceComplianceSummariesRequestRequestTypeDef,
CompliantSummaryTypeDef,
NonCompliantSummaryTypeDef,
CreateActivationRequestRequestTypeDef,
CreateDocumentRequestRequestTypeDef,
DocumentIdentifierTypeDef,
GetDocumentResultTypeDef,
OpsItemSummaryTypeDef,
CreateOpsItemRequestRequestTypeDef,
OpsItemTypeDef,
UpdateOpsItemRequestRequestTypeDef,
CreateOpsMetadataRequestRequestTypeDef,
GetOpsMetadataResultTypeDef,
UpdateOpsMetadataRequestRequestTypeDef,
DescribeActivationsRequestRequestTypeDef,
DescribeActivationsRequestDescribeActivationsPaginateTypeDef,
DescribeAssociationExecutionTargetsRequestDescribeAssociationExecutionTargetsPaginateTypeDef,
DescribeAssociationExecutionsRequestDescribeAssociationExecutionsPaginateTypeDef,
DescribeAutomationExecutionsRequestDescribeAutomationExecutionsPaginateTypeDef,
DescribeEffectiveInstanceAssociationsRequestDescribeEffectiveInstanceAssociationsPaginateTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestDescribeEffectivePatchesForPatchBaselinePaginateTypeDef,
DescribeInstanceAssociationsStatusRequestDescribeInstanceAssociationsStatusPaginateTypeDef,
DescribeInstancePatchStatesRequestDescribeInstancePatchStatesPaginateTypeDef,
DescribeInventoryDeletionsRequestDescribeInventoryDeletionsPaginateTypeDef,
DescribeMaintenanceWindowsForTargetRequestDescribeMaintenanceWindowsForTargetPaginateTypeDef,
DescribePatchPropertiesRequestDescribePatchPropertiesPaginateTypeDef,
GetInventorySchemaRequestGetInventorySchemaPaginateTypeDef,
GetParameterHistoryRequestGetParameterHistoryPaginateTypeDef,
GetResourcePoliciesRequestGetResourcePoliciesPaginateTypeDef,
ListAssociationVersionsRequestListAssociationVersionsPaginateTypeDef,
ListAssociationsRequestListAssociationsPaginateTypeDef,
ListCommandInvocationsRequestListCommandInvocationsPaginateTypeDef,
ListCommandsRequestListCommandsPaginateTypeDef,
ListComplianceItemsRequestListComplianceItemsPaginateTypeDef,
ListComplianceSummariesRequestListComplianceSummariesPaginateTypeDef,
ListDocumentVersionsRequestListDocumentVersionsPaginateTypeDef,
ListResourceComplianceSummariesRequestListResourceComplianceSummariesPaginateTypeDef,
ListResourceDataSyncRequestListResourceDataSyncPaginateTypeDef,
DescribeAutomationStepExecutionsRequestDescribeAutomationStepExecutionsPaginateTypeDef,
DescribeAutomationStepExecutionsRequestRequestTypeDef,
DescribeAvailablePatchesRequestDescribeAvailablePatchesPaginateTypeDef,
DescribeAvailablePatchesRequestRequestTypeDef,
DescribeInstancePatchesRequestDescribeInstancePatchesPaginateTypeDef,
DescribeInstancePatchesRequestRequestTypeDef,
DescribeMaintenanceWindowScheduleRequestDescribeMaintenanceWindowSchedulePaginateTypeDef,
DescribeMaintenanceWindowScheduleRequestRequestTypeDef,
DescribePatchBaselinesRequestDescribePatchBaselinesPaginateTypeDef,
DescribePatchBaselinesRequestRequestTypeDef,
DescribePatchGroupsRequestDescribePatchGroupsPaginateTypeDef,
DescribePatchGroupsRequestRequestTypeDef,
DescribeAvailablePatchesResultTypeDef,
DescribeEffectiveInstanceAssociationsResultTypeDef,
DescribeInstanceInformationRequestDescribeInstanceInformationPaginateTypeDef,
DescribeInstanceInformationRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestDescribeInstancePatchStatesForPatchGroupPaginateTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupResultTypeDef,
DescribeInstancePatchStatesResultTypeDef,
DescribeInstancePatchesResultTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestDescribeMaintenanceWindowExecutionTaskInvocationsPaginateTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestDescribeMaintenanceWindowExecutionTasksPaginateTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionsRequestDescribeMaintenanceWindowExecutionsPaginateTypeDef,
DescribeMaintenanceWindowExecutionsRequestRequestTypeDef,
DescribeMaintenanceWindowTargetsRequestDescribeMaintenanceWindowTargetsPaginateTypeDef,
DescribeMaintenanceWindowTargetsRequestRequestTypeDef,
DescribeMaintenanceWindowTasksRequestDescribeMaintenanceWindowTasksPaginateTypeDef,
DescribeMaintenanceWindowTasksRequestRequestTypeDef,
DescribeMaintenanceWindowsRequestDescribeMaintenanceWindowsPaginateTypeDef,
DescribeMaintenanceWindowsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef,
DescribeMaintenanceWindowExecutionsResultTypeDef,
DescribeMaintenanceWindowScheduleResultTypeDef,
DescribeMaintenanceWindowsForTargetResultTypeDef,
DescribeMaintenanceWindowsResultTypeDef,
DescribeOpsItemsRequestDescribeOpsItemsPaginateTypeDef,
DescribeOpsItemsRequestRequestTypeDef,
GetParametersByPathRequestGetParametersByPathPaginateTypeDef,
GetParametersByPathRequestRequestTypeDef,
DescribeParametersRequestDescribeParametersPaginateTypeDef,
DescribeParametersRequestRequestTypeDef,
DescribePatchBaselinesResultTypeDef,
PatchGroupPatchBaselineMappingTypeDef,
DescribeSessionsRequestDescribeSessionsPaginateTypeDef,
DescribeSessionsRequestRequestTypeDef,
UpdateDocumentDefaultVersionResultTypeDef,
DocumentDescriptionTypeDef,
ListDocumentsRequestListDocumentsPaginateTypeDef,
ListDocumentsRequestRequestTypeDef,
DocumentReviewerResponseSourceTypeDef,
DocumentReviewsTypeDef,
ListDocumentVersionsResultTypeDef,
EffectivePatchTypeDef,
GetCommandInvocationRequestCommandExecutedWaitTypeDef,
InventoryGroupTypeDef,
ListInventoryEntriesRequestRequestTypeDef,
GetInventoryRequestGetInventoryPaginateTypeDef,
GetInventoryRequestRequestTypeDef,
OpsAggregatorTypeDef,
GetOpsSummaryRequestGetOpsSummaryPaginateTypeDef,
GetOpsSummaryRequestRequestTypeDef,
GetParameterResultTypeDef,
GetParametersByPathResultTypeDef,
GetParametersResultTypeDef,
GetResourcePoliciesResponseTypeDef,
GetServiceSettingResultTypeDef,
ResetServiceSettingResultTypeDef,
InstanceInformationTypeDef,
InstanceAssociationOutputLocationTypeDef,
InstanceAssociationOutputUrlTypeDef,
InventoryDeletionSummaryTypeDef,
InventoryItemSchemaTypeDef,
PutInventoryRequestRequestTypeDef,
InventoryResultEntityTypeDef,
ListOpsItemEventsRequestListOpsItemEventsPaginateTypeDef,
ListOpsItemEventsRequestRequestTypeDef,
ListOpsItemRelatedItemsRequestListOpsItemRelatedItemsPaginateTypeDef,
ListOpsItemRelatedItemsRequestRequestTypeDef,
ListOpsMetadataRequestListOpsMetadataPaginateTypeDef,
ListOpsMetadataRequestRequestTypeDef,
ListOpsMetadataResultTypeDef,
OpsEntityTypeDef,
OpsItemEventSummaryTypeDef,
OpsItemRelatedItemSummaryTypeDef,
ParameterHistoryTypeDef,
ParameterMetadataTypeDef,
PatchFilterGroupTypeDef,
ResourceDataSyncAwsOrganizationsSourceTypeDef,
ResourceDataSyncS3DestinationTypeDef,
SessionTypeDef,
DescribeActivationsResultTypeDef,
AssociationExecutionTypeDef,
CommandTypeDef,
GetMaintenanceWindowExecutionTaskResultTypeDef,
MaintenanceWindowExecutionTaskIdentityTypeDef,
MaintenanceWindowTaskTypeDef,
SendCommandRequestRequestTypeDef,
TargetLocationTypeDef,
ListAssociationsResultTypeDef,
DescribeMaintenanceWindowTargetsResultTypeDef,
DescribeAssociationExecutionTargetsResultTypeDef,
ListCommandInvocationsResultTypeDef,
MaintenanceWindowTaskInvocationParametersTypeDef,
ListComplianceItemsResultTypeDef,
ComplianceSummaryItemTypeDef,
ResourceComplianceSummaryItemTypeDef,
ListDocumentsResultTypeDef,
DescribeOpsItemsResponseTypeDef,
GetOpsItemResponseTypeDef,
DescribePatchGroupsResultTypeDef,
CreateDocumentResultTypeDef,
DescribeDocumentResultTypeDef,
UpdateDocumentResultTypeDef,
DocumentMetadataResponseInfoTypeDef,
UpdateDocumentMetadataRequestRequestTypeDef,
DescribeEffectivePatchesForPatchBaselineResultTypeDef,
InventoryAggregatorTypeDef,
DescribeInstanceInformationResultTypeDef,
InstanceAssociationStatusInfoTypeDef,
DeleteInventoryResultTypeDef,
InventoryDeletionStatusItemTypeDef,
GetInventorySchemaResultTypeDef,
GetInventoryResultTypeDef,
GetOpsSummaryResultTypeDef,
ListOpsItemEventsResponseTypeDef,
ListOpsItemRelatedItemsResponseTypeDef,
GetParameterHistoryResultTypeDef,
DescribeParametersResultTypeDef,
PatchRuleTypeDef,
ResourceDataSyncSourceTypeDef,
ResourceDataSyncSourceWithStateTypeDef,
DescribeSessionsResponseTypeDef,
DescribeAssociationExecutionsResultTypeDef,
ListCommandsResultTypeDef,
SendCommandResultTypeDef,
DescribeMaintenanceWindowExecutionTasksResultTypeDef,
DescribeMaintenanceWindowTasksResultTypeDef,
AssociationDescriptionTypeDef,
AssociationVersionInfoTypeDef,
CreateAssociationBatchRequestEntryTypeDef,
CreateAssociationRequestRequestTypeDef,
RunbookTypeDef,
StartAutomationExecutionRequestRequestTypeDef,
StepExecutionTypeDef,
UpdateAssociationRequestRequestTypeDef,
GetMaintenanceWindowTaskResultTypeDef,
RegisterTaskWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTaskRequestRequestTypeDef,
UpdateMaintenanceWindowTaskResultTypeDef,
ListComplianceSummariesResultTypeDef,
ListResourceComplianceSummariesResultTypeDef,
ListDocumentMetadataHistoryResponseTypeDef,
DescribeInstanceAssociationsStatusResultTypeDef,
DescribeInventoryDeletionsResultTypeDef,
PatchRuleGroupTypeDef,
CreateResourceDataSyncRequestRequestTypeDef,
UpdateResourceDataSyncRequestRequestTypeDef,
ResourceDataSyncItemTypeDef,
CreateAssociationResultTypeDef,
DescribeAssociationResultTypeDef,
UpdateAssociationResultTypeDef,
UpdateAssociationStatusResultTypeDef,
ListAssociationVersionsResultTypeDef,
CreateAssociationBatchRequestRequestTypeDef,
FailedCreateAssociationTypeDef,
AutomationExecutionMetadataTypeDef,
StartChangeRequestExecutionRequestRequestTypeDef,
AutomationExecutionTypeDef,
DescribeAutomationStepExecutionsResultTypeDef,
BaselineOverrideTypeDef,
CreatePatchBaselineRequestRequestTypeDef,
GetPatchBaselineResultTypeDef,
UpdatePatchBaselineRequestRequestTypeDef,
UpdatePatchBaselineResultTypeDef,
ListResourceDataSyncResultTypeDef,
CreateAssociationBatchResultTypeDef,
DescribeAutomationExecutionsResultTypeDef,
GetAutomationExecutionResultTypeDef,
GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef,
)
def get_structure() -> AccountSharingInfoTypeDef:
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-ssm` 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_ssm/)
## 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-ssm
Provides: python3-mypy-boto3-ssm-doc
%description help
# mypy-boto3-ssm
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://pypi.org/project/mypy-boto3-ssm)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/mypy-boto3-ssm)
Type annotations for
[boto3.SSM 1.26.97](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM)
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-ssm docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-ssm](#mypy-boto3-ssm)
- [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 `SSM`.
### From PyPI with pip
Install `boto3-stubs` for `SSM` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm]'
# 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[ssm]'
# standalone installation
python -m pip install mypy-boto3-ssm
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ssm
```
## 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[ssm]'`
```
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[ssm]'
```
- 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[ssm]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
- 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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'`
```
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[ssm]` in your environment:
```bash
python -m pip install 'boto3-stubs[ssm]'
```
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
`SSMClient` provides annotations for `boto3.client("ssm")`.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
client: SSMClient = Session().client("ssm")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_ssm.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.paginator import (
DescribeActivationsPaginator,
DescribeAssociationExecutionTargetsPaginator,
DescribeAssociationExecutionsPaginator,
DescribeAutomationExecutionsPaginator,
DescribeAutomationStepExecutionsPaginator,
DescribeAvailablePatchesPaginator,
DescribeEffectiveInstanceAssociationsPaginator,
DescribeEffectivePatchesForPatchBaselinePaginator,
DescribeInstanceAssociationsStatusPaginator,
DescribeInstanceInformationPaginator,
DescribeInstancePatchStatesPaginator,
DescribeInstancePatchStatesForPatchGroupPaginator,
DescribeInstancePatchesPaginator,
DescribeInventoryDeletionsPaginator,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator,
DescribeMaintenanceWindowExecutionTasksPaginator,
DescribeMaintenanceWindowExecutionsPaginator,
DescribeMaintenanceWindowSchedulePaginator,
DescribeMaintenanceWindowTargetsPaginator,
DescribeMaintenanceWindowTasksPaginator,
DescribeMaintenanceWindowsPaginator,
DescribeMaintenanceWindowsForTargetPaginator,
DescribeOpsItemsPaginator,
DescribeParametersPaginator,
DescribePatchBaselinesPaginator,
DescribePatchGroupsPaginator,
DescribePatchPropertiesPaginator,
DescribeSessionsPaginator,
GetInventoryPaginator,
GetInventorySchemaPaginator,
GetOpsSummaryPaginator,
GetParameterHistoryPaginator,
GetParametersByPathPaginator,
GetResourcePoliciesPaginator,
ListAssociationVersionsPaginator,
ListAssociationsPaginator,
ListCommandInvocationsPaginator,
ListCommandsPaginator,
ListComplianceItemsPaginator,
ListComplianceSummariesPaginator,
ListDocumentVersionsPaginator,
ListDocumentsPaginator,
ListOpsItemEventsPaginator,
ListOpsItemRelatedItemsPaginator,
ListOpsMetadataPaginator,
ListResourceComplianceSummariesPaginator,
ListResourceDataSyncPaginator,
)
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_activations_paginator: DescribeActivationsPaginator = client.get_paginator(
"describe_activations"
)
describe_association_execution_targets_paginator: DescribeAssociationExecutionTargetsPaginator = (
client.get_paginator("describe_association_execution_targets")
)
describe_association_executions_paginator: DescribeAssociationExecutionsPaginator = (
client.get_paginator("describe_association_executions")
)
describe_automation_executions_paginator: DescribeAutomationExecutionsPaginator = (
client.get_paginator("describe_automation_executions")
)
describe_automation_step_executions_paginator: DescribeAutomationStepExecutionsPaginator = (
client.get_paginator("describe_automation_step_executions")
)
describe_available_patches_paginator: DescribeAvailablePatchesPaginator = client.get_paginator(
"describe_available_patches"
)
describe_effective_instance_associations_paginator: DescribeEffectiveInstanceAssociationsPaginator = client.get_paginator(
"describe_effective_instance_associations"
)
describe_effective_patches_for_patch_baseline_paginator: DescribeEffectivePatchesForPatchBaselinePaginator = client.get_paginator(
"describe_effective_patches_for_patch_baseline"
)
describe_instance_associations_status_paginator: DescribeInstanceAssociationsStatusPaginator = (
client.get_paginator("describe_instance_associations_status")
)
describe_instance_information_paginator: DescribeInstanceInformationPaginator = (
client.get_paginator("describe_instance_information")
)
describe_instance_patch_states_paginator: DescribeInstancePatchStatesPaginator = (
client.get_paginator("describe_instance_patch_states")
)
describe_instance_patch_states_for_patch_group_paginator: DescribeInstancePatchStatesForPatchGroupPaginator = client.get_paginator(
"describe_instance_patch_states_for_patch_group"
)
describe_instance_patches_paginator: DescribeInstancePatchesPaginator = client.get_paginator(
"describe_instance_patches"
)
describe_inventory_deletions_paginator: DescribeInventoryDeletionsPaginator = client.get_paginator(
"describe_inventory_deletions"
)
describe_maintenance_window_execution_task_invocations_paginator: DescribeMaintenanceWindowExecutionTaskInvocationsPaginator = client.get_paginator(
"describe_maintenance_window_execution_task_invocations"
)
describe_maintenance_window_execution_tasks_paginator: DescribeMaintenanceWindowExecutionTasksPaginator = client.get_paginator(
"describe_maintenance_window_execution_tasks"
)
describe_maintenance_window_executions_paginator: DescribeMaintenanceWindowExecutionsPaginator = (
client.get_paginator("describe_maintenance_window_executions")
)
describe_maintenance_window_schedule_paginator: DescribeMaintenanceWindowSchedulePaginator = (
client.get_paginator("describe_maintenance_window_schedule")
)
describe_maintenance_window_targets_paginator: DescribeMaintenanceWindowTargetsPaginator = (
client.get_paginator("describe_maintenance_window_targets")
)
describe_maintenance_window_tasks_paginator: DescribeMaintenanceWindowTasksPaginator = (
client.get_paginator("describe_maintenance_window_tasks")
)
describe_maintenance_windows_paginator: DescribeMaintenanceWindowsPaginator = client.get_paginator(
"describe_maintenance_windows"
)
describe_maintenance_windows_for_target_paginator: DescribeMaintenanceWindowsForTargetPaginator = (
client.get_paginator("describe_maintenance_windows_for_target")
)
describe_ops_items_paginator: DescribeOpsItemsPaginator = client.get_paginator("describe_ops_items")
describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator(
"describe_parameters"
)
describe_patch_baselines_paginator: DescribePatchBaselinesPaginator = client.get_paginator(
"describe_patch_baselines"
)
describe_patch_groups_paginator: DescribePatchGroupsPaginator = client.get_paginator(
"describe_patch_groups"
)
describe_patch_properties_paginator: DescribePatchPropertiesPaginator = client.get_paginator(
"describe_patch_properties"
)
describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator("describe_sessions")
get_inventory_paginator: GetInventoryPaginator = client.get_paginator("get_inventory")
get_inventory_schema_paginator: GetInventorySchemaPaginator = client.get_paginator(
"get_inventory_schema"
)
get_ops_summary_paginator: GetOpsSummaryPaginator = client.get_paginator("get_ops_summary")
get_parameter_history_paginator: GetParameterHistoryPaginator = client.get_paginator(
"get_parameter_history"
)
get_parameters_by_path_paginator: GetParametersByPathPaginator = client.get_paginator(
"get_parameters_by_path"
)
get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
"get_resource_policies"
)
list_association_versions_paginator: ListAssociationVersionsPaginator = client.get_paginator(
"list_association_versions"
)
list_associations_paginator: ListAssociationsPaginator = client.get_paginator("list_associations")
list_command_invocations_paginator: ListCommandInvocationsPaginator = client.get_paginator(
"list_command_invocations"
)
list_commands_paginator: ListCommandsPaginator = client.get_paginator("list_commands")
list_compliance_items_paginator: ListComplianceItemsPaginator = client.get_paginator(
"list_compliance_items"
)
list_compliance_summaries_paginator: ListComplianceSummariesPaginator = client.get_paginator(
"list_compliance_summaries"
)
list_document_versions_paginator: ListDocumentVersionsPaginator = client.get_paginator(
"list_document_versions"
)
list_documents_paginator: ListDocumentsPaginator = client.get_paginator("list_documents")
list_ops_item_events_paginator: ListOpsItemEventsPaginator = client.get_paginator(
"list_ops_item_events"
)
list_ops_item_related_items_paginator: ListOpsItemRelatedItemsPaginator = client.get_paginator(
"list_ops_item_related_items"
)
list_ops_metadata_paginator: ListOpsMetadataPaginator = client.get_paginator("list_ops_metadata")
list_resource_compliance_summaries_paginator: ListResourceComplianceSummariesPaginator = (
client.get_paginator("list_resource_compliance_summaries")
)
list_resource_data_sync_paginator: ListResourceDataSyncPaginator = client.get_paginator(
"list_resource_data_sync"
)
```
### Waiters annotations
`mypy_boto3_ssm.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_ssm import SSMClient
from mypy_boto3_ssm.waiter import CommandExecutedWaiter
client: SSMClient = Session().client("ssm")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
command_executed_waiter: CommandExecutedWaiter = client.get_waiter("command_executed")
```
### Literals
`mypy_boto3_ssm.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_ssm.literals import (
AssociationComplianceSeverityType,
AssociationExecutionFilterKeyType,
AssociationExecutionTargetsFilterKeyType,
AssociationFilterKeyType,
AssociationFilterOperatorTypeType,
AssociationStatusNameType,
AssociationSyncComplianceType,
AttachmentHashTypeType,
AttachmentsSourceKeyType,
AutomationExecutionFilterKeyType,
AutomationExecutionStatusType,
AutomationSubtypeType,
AutomationTypeType,
CalendarStateType,
CommandExecutedWaiterName,
CommandFilterKeyType,
CommandInvocationStatusType,
CommandPluginStatusType,
CommandStatusType,
ComplianceQueryOperatorTypeType,
ComplianceSeverityType,
ComplianceStatusType,
ComplianceUploadTypeType,
ConnectionStatusType,
DescribeActivationsFilterKeysType,
DescribeActivationsPaginatorName,
DescribeAssociationExecutionTargetsPaginatorName,
DescribeAssociationExecutionsPaginatorName,
DescribeAutomationExecutionsPaginatorName,
DescribeAutomationStepExecutionsPaginatorName,
DescribeAvailablePatchesPaginatorName,
DescribeEffectiveInstanceAssociationsPaginatorName,
DescribeEffectivePatchesForPatchBaselinePaginatorName,
DescribeInstanceAssociationsStatusPaginatorName,
DescribeInstanceInformationPaginatorName,
DescribeInstancePatchStatesForPatchGroupPaginatorName,
DescribeInstancePatchStatesPaginatorName,
DescribeInstancePatchesPaginatorName,
DescribeInventoryDeletionsPaginatorName,
DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorName,
DescribeMaintenanceWindowExecutionTasksPaginatorName,
DescribeMaintenanceWindowExecutionsPaginatorName,
DescribeMaintenanceWindowSchedulePaginatorName,
DescribeMaintenanceWindowTargetsPaginatorName,
DescribeMaintenanceWindowTasksPaginatorName,
DescribeMaintenanceWindowsForTargetPaginatorName,
DescribeMaintenanceWindowsPaginatorName,
DescribeOpsItemsPaginatorName,
DescribeParametersPaginatorName,
DescribePatchBaselinesPaginatorName,
DescribePatchGroupsPaginatorName,
DescribePatchPropertiesPaginatorName,
DescribeSessionsPaginatorName,
DocumentFilterKeyType,
DocumentFormatType,
DocumentHashTypeType,
DocumentMetadataEnumType,
DocumentParameterTypeType,
DocumentPermissionTypeType,
DocumentReviewActionType,
DocumentReviewCommentTypeType,
DocumentStatusType,
DocumentTypeType,
ExecutionModeType,
ExternalAlarmStateType,
FaultType,
GetInventoryPaginatorName,
GetInventorySchemaPaginatorName,
GetOpsSummaryPaginatorName,
GetParameterHistoryPaginatorName,
GetParametersByPathPaginatorName,
GetResourcePoliciesPaginatorName,
InstanceInformationFilterKeyType,
InstancePatchStateOperatorTypeType,
InventoryAttributeDataTypeType,
InventoryDeletionStatusType,
InventoryQueryOperatorTypeType,
InventorySchemaDeleteOptionType,
LastResourceDataSyncStatusType,
ListAssociationVersionsPaginatorName,
ListAssociationsPaginatorName,
ListCommandInvocationsPaginatorName,
ListCommandsPaginatorName,
ListComplianceItemsPaginatorName,
ListComplianceSummariesPaginatorName,
ListDocumentVersionsPaginatorName,
ListDocumentsPaginatorName,
ListOpsItemEventsPaginatorName,
ListOpsItemRelatedItemsPaginatorName,
ListOpsMetadataPaginatorName,
ListResourceComplianceSummariesPaginatorName,
ListResourceDataSyncPaginatorName,
MaintenanceWindowExecutionStatusType,
MaintenanceWindowResourceTypeType,
MaintenanceWindowTaskCutoffBehaviorType,
MaintenanceWindowTaskTypeType,
NotificationEventType,
NotificationTypeType,
OperatingSystemType,
OpsFilterOperatorTypeType,
OpsItemDataTypeType,
OpsItemEventFilterKeyType,
OpsItemEventFilterOperatorType,
OpsItemFilterKeyType,
OpsItemFilterOperatorType,
OpsItemRelatedItemsFilterKeyType,
OpsItemRelatedItemsFilterOperatorType,
OpsItemStatusType,
ParameterTierType,
ParameterTypeType,
ParametersFilterKeyType,
PatchActionType,
PatchComplianceDataStateType,
PatchComplianceLevelType,
PatchDeploymentStatusType,
PatchFilterKeyType,
PatchOperationTypeType,
PatchPropertyType,
PatchSetType,
PingStatusType,
PlatformTypeType,
RebootOptionType,
ResourceDataSyncS3FormatType,
ResourceTypeForTaggingType,
ResourceTypeType,
ReviewStatusType,
SessionFilterKeyType,
SessionStateType,
SessionStatusType,
SignalTypeType,
SourceTypeType,
StepExecutionFilterKeyType,
StopTypeType,
SSMServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AssociationComplianceSeverityType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_ssm.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_ssm.type_defs import (
AccountSharingInfoTypeDef,
TagTypeDef,
AlarmTypeDef,
AlarmStateInformationTypeDef,
AssociateOpsItemRelatedItemRequestRequestTypeDef,
ResponseMetadataTypeDef,
AssociationOverviewTypeDef,
AssociationStatusTypeDef,
TargetTypeDef,
AssociationExecutionFilterTypeDef,
OutputSourceTypeDef,
AssociationExecutionTargetsFilterTypeDef,
AssociationFilterTypeDef,
AttachmentContentTypeDef,
AttachmentInformationTypeDef,
AttachmentsSourceTypeDef,
AutomationExecutionFilterTypeDef,
ResolvedTargetsTypeDef,
ProgressCountersTypeDef,
PatchSourceTypeDef,
CancelCommandRequestRequestTypeDef,
CancelMaintenanceWindowExecutionRequestRequestTypeDef,
CloudWatchOutputConfigTypeDef,
CommandFilterTypeDef,
CommandPluginTypeDef,
NotificationConfigTypeDef,
ComplianceExecutionSummaryTypeDef,
ComplianceItemEntryTypeDef,
ComplianceStringFilterTypeDef,
SeveritySummaryTypeDef,
RegistrationMetadataItemTypeDef,
DocumentRequiresTypeDef,
OpsItemDataValueTypeDef,
OpsItemNotificationTypeDef,
RelatedOpsItemTypeDef,
MetadataValueTypeDef,
DeleteActivationRequestRequestTypeDef,
DeleteAssociationRequestRequestTypeDef,
DeleteDocumentRequestRequestTypeDef,
DeleteInventoryRequestRequestTypeDef,
DeleteMaintenanceWindowRequestRequestTypeDef,
DeleteOpsMetadataRequestRequestTypeDef,
DeleteParameterRequestRequestTypeDef,
DeleteParametersRequestRequestTypeDef,
DeletePatchBaselineRequestRequestTypeDef,
DeleteResourceDataSyncRequestRequestTypeDef,
DeleteResourcePolicyRequestRequestTypeDef,
DeregisterManagedInstanceRequestRequestTypeDef,
DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef,
DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef,
DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef,
DescribeActivationsFilterTypeDef,
PaginatorConfigTypeDef,
DescribeAssociationRequestRequestTypeDef,
StepExecutionFilterTypeDef,
PatchOrchestratorFilterTypeDef,
PatchTypeDef,
DescribeDocumentPermissionRequestRequestTypeDef,
DescribeDocumentRequestRequestTypeDef,
DescribeEffectiveInstanceAssociationsRequestRequestTypeDef,
InstanceAssociationTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef,
DescribeInstanceAssociationsStatusRequestRequestTypeDef,
InstanceInformationFilterTypeDef,
InstanceInformationStringFilterTypeDef,
InstancePatchStateFilterTypeDef,
InstancePatchStateTypeDef,
DescribeInstancePatchStatesRequestRequestTypeDef,
PatchComplianceDataTypeDef,
DescribeInventoryDeletionsRequestRequestTypeDef,
MaintenanceWindowFilterTypeDef,
MaintenanceWindowExecutionTaskInvocationIdentityTypeDef,
MaintenanceWindowExecutionTypeDef,
ScheduledWindowExecutionTypeDef,
MaintenanceWindowIdentityForTargetTypeDef,
MaintenanceWindowIdentityTypeDef,
OpsItemFilterTypeDef,
ParameterStringFilterTypeDef,
ParametersFilterTypeDef,
PatchBaselineIdentityTypeDef,
DescribePatchGroupStateRequestRequestTypeDef,
DescribePatchPropertiesRequestRequestTypeDef,
SessionFilterTypeDef,
DisassociateOpsItemRelatedItemRequestRequestTypeDef,
DocumentDefaultVersionDescriptionTypeDef,
DocumentParameterTypeDef,
ReviewInformationTypeDef,
DocumentFilterTypeDef,
DocumentKeyValuesFilterTypeDef,
DocumentReviewCommentSourceTypeDef,
DocumentVersionInfoTypeDef,
PatchStatusTypeDef,
FailureDetailsTypeDef,
GetAutomationExecutionRequestRequestTypeDef,
GetCalendarStateRequestRequestTypeDef,
WaiterConfigTypeDef,
GetCommandInvocationRequestRequestTypeDef,
GetConnectionStatusRequestRequestTypeDef,
GetDefaultPatchBaselineRequestRequestTypeDef,
GetDocumentRequestRequestTypeDef,
InventoryFilterTypeDef,
ResultAttributeTypeDef,
GetInventorySchemaRequestRequestTypeDef,
GetMaintenanceWindowExecutionRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef,
GetMaintenanceWindowExecutionTaskRequestRequestTypeDef,
MaintenanceWindowTaskParameterValueExpressionTypeDef,
GetMaintenanceWindowRequestRequestTypeDef,
GetMaintenanceWindowTaskRequestRequestTypeDef,
LoggingInfoTypeDef,
GetOpsItemRequestRequestTypeDef,
GetOpsMetadataRequestRequestTypeDef,
OpsFilterTypeDef,
OpsResultAttributeTypeDef,
GetParameterHistoryRequestRequestTypeDef,
GetParameterRequestRequestTypeDef,
ParameterTypeDef,
GetParametersRequestRequestTypeDef,
GetPatchBaselineForPatchGroupRequestRequestTypeDef,
GetPatchBaselineRequestRequestTypeDef,
GetResourcePoliciesRequestRequestTypeDef,
GetResourcePoliciesResponseEntryTypeDef,
GetServiceSettingRequestRequestTypeDef,
ServiceSettingTypeDef,
InstanceAggregatedAssociationOverviewTypeDef,
S3OutputLocationTypeDef,
S3OutputUrlTypeDef,
InventoryDeletionSummaryItemTypeDef,
InventoryItemAttributeTypeDef,
InventoryItemTypeDef,
InventoryResultItemTypeDef,
LabelParameterVersionRequestRequestTypeDef,
ListAssociationVersionsRequestRequestTypeDef,
ListDocumentMetadataHistoryRequestRequestTypeDef,
ListDocumentVersionsRequestRequestTypeDef,
OpsItemEventFilterTypeDef,
OpsItemRelatedItemsFilterTypeDef,
OpsMetadataFilterTypeDef,
OpsMetadataTypeDef,
ListResourceDataSyncRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
MaintenanceWindowAutomationParametersTypeDef,
MaintenanceWindowLambdaParametersTypeDef,
MaintenanceWindowStepFunctionsParametersTypeDef,
ModifyDocumentPermissionRequestRequestTypeDef,
OpsEntityItemTypeDef,
OpsItemIdentityTypeDef,
ParameterInlinePolicyTypeDef,
PatchFilterTypeDef,
PutResourcePolicyRequestRequestTypeDef,
RegisterDefaultPatchBaselineRequestRequestTypeDef,
RegisterPatchBaselineForPatchGroupRequestRequestTypeDef,
RemoveTagsFromResourceRequestRequestTypeDef,
ResetServiceSettingRequestRequestTypeDef,
ResourceDataSyncOrganizationalUnitTypeDef,
ResourceDataSyncDestinationDataSharingTypeDef,
ResumeSessionRequestRequestTypeDef,
SendAutomationSignalRequestRequestTypeDef,
SessionManagerOutputUrlTypeDef,
StartAssociationsOnceRequestRequestTypeDef,
StartSessionRequestRequestTypeDef,
StopAutomationExecutionRequestRequestTypeDef,
TerminateSessionRequestRequestTypeDef,
UnlabelParameterVersionRequestRequestTypeDef,
UpdateDocumentDefaultVersionRequestRequestTypeDef,
UpdateMaintenanceWindowRequestRequestTypeDef,
UpdateManagedInstanceRoleRequestRequestTypeDef,
UpdateServiceSettingRequestRequestTypeDef,
ActivationTypeDef,
AddTagsToResourceRequestRequestTypeDef,
CreateMaintenanceWindowRequestRequestTypeDef,
PutParameterRequestRequestTypeDef,
AlarmConfigurationTypeDef,
AssociateOpsItemRelatedItemResponseTypeDef,
CancelMaintenanceWindowExecutionResultTypeDef,
CreateActivationResultTypeDef,
CreateMaintenanceWindowResultTypeDef,
CreateOpsItemResponseTypeDef,
CreateOpsMetadataResultTypeDef,
CreatePatchBaselineResultTypeDef,
DeleteMaintenanceWindowResultTypeDef,
DeleteParametersResultTypeDef,
DeletePatchBaselineResultTypeDef,
DeregisterPatchBaselineForPatchGroupResultTypeDef,
DeregisterTargetFromMaintenanceWindowResultTypeDef,
DeregisterTaskFromMaintenanceWindowResultTypeDef,
DescribeDocumentPermissionResponseTypeDef,
DescribePatchGroupStateResultTypeDef,
DescribePatchPropertiesResultTypeDef,
GetCalendarStateResponseTypeDef,
GetConnectionStatusResponseTypeDef,
GetDefaultPatchBaselineResultTypeDef,
GetDeployablePatchSnapshotForInstanceResultTypeDef,
GetMaintenanceWindowExecutionResultTypeDef,
GetMaintenanceWindowExecutionTaskInvocationResultTypeDef,
GetMaintenanceWindowResultTypeDef,
GetPatchBaselineForPatchGroupResultTypeDef,
LabelParameterVersionResultTypeDef,
ListInventoryEntriesResultTypeDef,
ListTagsForResourceResultTypeDef,
PutInventoryResultTypeDef,
PutParameterResultTypeDef,
PutResourcePolicyResponseTypeDef,
RegisterDefaultPatchBaselineResultTypeDef,
RegisterPatchBaselineForPatchGroupResultTypeDef,
RegisterTargetWithMaintenanceWindowResultTypeDef,
RegisterTaskWithMaintenanceWindowResultTypeDef,
ResumeSessionResponseTypeDef,
StartAutomationExecutionResultTypeDef,
StartChangeRequestExecutionResultTypeDef,
StartSessionResponseTypeDef,
TerminateSessionResponseTypeDef,
UnlabelParameterVersionResultTypeDef,
UpdateMaintenanceWindowResultTypeDef,
UpdateOpsMetadataResultTypeDef,
UpdateAssociationStatusRequestRequestTypeDef,
AssociationTypeDef,
DescribeMaintenanceWindowsForTargetRequestRequestTypeDef,
MaintenanceWindowTargetTypeDef,
RegisterTargetWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTargetRequestRequestTypeDef,
UpdateMaintenanceWindowTargetResultTypeDef,
DescribeAssociationExecutionsRequestRequestTypeDef,
AssociationExecutionTargetTypeDef,
DescribeAssociationExecutionTargetsRequestRequestTypeDef,
ListAssociationsRequestRequestTypeDef,
UpdateDocumentRequestRequestTypeDef,
DescribeAutomationExecutionsRequestRequestTypeDef,
GetCommandInvocationResultTypeDef,
ListCommandInvocationsRequestRequestTypeDef,
ListCommandsRequestRequestTypeDef,
CommandInvocationTypeDef,
MaintenanceWindowRunCommandParametersTypeDef,
ComplianceItemTypeDef,
PutComplianceItemsRequestRequestTypeDef,
ListComplianceItemsRequestRequestTypeDef,
ListComplianceSummariesRequestRequestTypeDef,
ListResourceComplianceSummariesRequestRequestTypeDef,
CompliantSummaryTypeDef,
NonCompliantSummaryTypeDef,
CreateActivationRequestRequestTypeDef,
CreateDocumentRequestRequestTypeDef,
DocumentIdentifierTypeDef,
GetDocumentResultTypeDef,
OpsItemSummaryTypeDef,
CreateOpsItemRequestRequestTypeDef,
OpsItemTypeDef,
UpdateOpsItemRequestRequestTypeDef,
CreateOpsMetadataRequestRequestTypeDef,
GetOpsMetadataResultTypeDef,
UpdateOpsMetadataRequestRequestTypeDef,
DescribeActivationsRequestRequestTypeDef,
DescribeActivationsRequestDescribeActivationsPaginateTypeDef,
DescribeAssociationExecutionTargetsRequestDescribeAssociationExecutionTargetsPaginateTypeDef,
DescribeAssociationExecutionsRequestDescribeAssociationExecutionsPaginateTypeDef,
DescribeAutomationExecutionsRequestDescribeAutomationExecutionsPaginateTypeDef,
DescribeEffectiveInstanceAssociationsRequestDescribeEffectiveInstanceAssociationsPaginateTypeDef,
DescribeEffectivePatchesForPatchBaselineRequestDescribeEffectivePatchesForPatchBaselinePaginateTypeDef,
DescribeInstanceAssociationsStatusRequestDescribeInstanceAssociationsStatusPaginateTypeDef,
DescribeInstancePatchStatesRequestDescribeInstancePatchStatesPaginateTypeDef,
DescribeInventoryDeletionsRequestDescribeInventoryDeletionsPaginateTypeDef,
DescribeMaintenanceWindowsForTargetRequestDescribeMaintenanceWindowsForTargetPaginateTypeDef,
DescribePatchPropertiesRequestDescribePatchPropertiesPaginateTypeDef,
GetInventorySchemaRequestGetInventorySchemaPaginateTypeDef,
GetParameterHistoryRequestGetParameterHistoryPaginateTypeDef,
GetResourcePoliciesRequestGetResourcePoliciesPaginateTypeDef,
ListAssociationVersionsRequestListAssociationVersionsPaginateTypeDef,
ListAssociationsRequestListAssociationsPaginateTypeDef,
ListCommandInvocationsRequestListCommandInvocationsPaginateTypeDef,
ListCommandsRequestListCommandsPaginateTypeDef,
ListComplianceItemsRequestListComplianceItemsPaginateTypeDef,
ListComplianceSummariesRequestListComplianceSummariesPaginateTypeDef,
ListDocumentVersionsRequestListDocumentVersionsPaginateTypeDef,
ListResourceComplianceSummariesRequestListResourceComplianceSummariesPaginateTypeDef,
ListResourceDataSyncRequestListResourceDataSyncPaginateTypeDef,
DescribeAutomationStepExecutionsRequestDescribeAutomationStepExecutionsPaginateTypeDef,
DescribeAutomationStepExecutionsRequestRequestTypeDef,
DescribeAvailablePatchesRequestDescribeAvailablePatchesPaginateTypeDef,
DescribeAvailablePatchesRequestRequestTypeDef,
DescribeInstancePatchesRequestDescribeInstancePatchesPaginateTypeDef,
DescribeInstancePatchesRequestRequestTypeDef,
DescribeMaintenanceWindowScheduleRequestDescribeMaintenanceWindowSchedulePaginateTypeDef,
DescribeMaintenanceWindowScheduleRequestRequestTypeDef,
DescribePatchBaselinesRequestDescribePatchBaselinesPaginateTypeDef,
DescribePatchBaselinesRequestRequestTypeDef,
DescribePatchGroupsRequestDescribePatchGroupsPaginateTypeDef,
DescribePatchGroupsRequestRequestTypeDef,
DescribeAvailablePatchesResultTypeDef,
DescribeEffectiveInstanceAssociationsResultTypeDef,
DescribeInstanceInformationRequestDescribeInstanceInformationPaginateTypeDef,
DescribeInstanceInformationRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestDescribeInstancePatchStatesForPatchGroupPaginateTypeDef,
DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef,
DescribeInstancePatchStatesForPatchGroupResultTypeDef,
DescribeInstancePatchStatesResultTypeDef,
DescribeInstancePatchesResultTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestDescribeMaintenanceWindowExecutionTaskInvocationsPaginateTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestDescribeMaintenanceWindowExecutionTasksPaginateTypeDef,
DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionsRequestDescribeMaintenanceWindowExecutionsPaginateTypeDef,
DescribeMaintenanceWindowExecutionsRequestRequestTypeDef,
DescribeMaintenanceWindowTargetsRequestDescribeMaintenanceWindowTargetsPaginateTypeDef,
DescribeMaintenanceWindowTargetsRequestRequestTypeDef,
DescribeMaintenanceWindowTasksRequestDescribeMaintenanceWindowTasksPaginateTypeDef,
DescribeMaintenanceWindowTasksRequestRequestTypeDef,
DescribeMaintenanceWindowsRequestDescribeMaintenanceWindowsPaginateTypeDef,
DescribeMaintenanceWindowsRequestRequestTypeDef,
DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef,
DescribeMaintenanceWindowExecutionsResultTypeDef,
DescribeMaintenanceWindowScheduleResultTypeDef,
DescribeMaintenanceWindowsForTargetResultTypeDef,
DescribeMaintenanceWindowsResultTypeDef,
DescribeOpsItemsRequestDescribeOpsItemsPaginateTypeDef,
DescribeOpsItemsRequestRequestTypeDef,
GetParametersByPathRequestGetParametersByPathPaginateTypeDef,
GetParametersByPathRequestRequestTypeDef,
DescribeParametersRequestDescribeParametersPaginateTypeDef,
DescribeParametersRequestRequestTypeDef,
DescribePatchBaselinesResultTypeDef,
PatchGroupPatchBaselineMappingTypeDef,
DescribeSessionsRequestDescribeSessionsPaginateTypeDef,
DescribeSessionsRequestRequestTypeDef,
UpdateDocumentDefaultVersionResultTypeDef,
DocumentDescriptionTypeDef,
ListDocumentsRequestListDocumentsPaginateTypeDef,
ListDocumentsRequestRequestTypeDef,
DocumentReviewerResponseSourceTypeDef,
DocumentReviewsTypeDef,
ListDocumentVersionsResultTypeDef,
EffectivePatchTypeDef,
GetCommandInvocationRequestCommandExecutedWaitTypeDef,
InventoryGroupTypeDef,
ListInventoryEntriesRequestRequestTypeDef,
GetInventoryRequestGetInventoryPaginateTypeDef,
GetInventoryRequestRequestTypeDef,
OpsAggregatorTypeDef,
GetOpsSummaryRequestGetOpsSummaryPaginateTypeDef,
GetOpsSummaryRequestRequestTypeDef,
GetParameterResultTypeDef,
GetParametersByPathResultTypeDef,
GetParametersResultTypeDef,
GetResourcePoliciesResponseTypeDef,
GetServiceSettingResultTypeDef,
ResetServiceSettingResultTypeDef,
InstanceInformationTypeDef,
InstanceAssociationOutputLocationTypeDef,
InstanceAssociationOutputUrlTypeDef,
InventoryDeletionSummaryTypeDef,
InventoryItemSchemaTypeDef,
PutInventoryRequestRequestTypeDef,
InventoryResultEntityTypeDef,
ListOpsItemEventsRequestListOpsItemEventsPaginateTypeDef,
ListOpsItemEventsRequestRequestTypeDef,
ListOpsItemRelatedItemsRequestListOpsItemRelatedItemsPaginateTypeDef,
ListOpsItemRelatedItemsRequestRequestTypeDef,
ListOpsMetadataRequestListOpsMetadataPaginateTypeDef,
ListOpsMetadataRequestRequestTypeDef,
ListOpsMetadataResultTypeDef,
OpsEntityTypeDef,
OpsItemEventSummaryTypeDef,
OpsItemRelatedItemSummaryTypeDef,
ParameterHistoryTypeDef,
ParameterMetadataTypeDef,
PatchFilterGroupTypeDef,
ResourceDataSyncAwsOrganizationsSourceTypeDef,
ResourceDataSyncS3DestinationTypeDef,
SessionTypeDef,
DescribeActivationsResultTypeDef,
AssociationExecutionTypeDef,
CommandTypeDef,
GetMaintenanceWindowExecutionTaskResultTypeDef,
MaintenanceWindowExecutionTaskIdentityTypeDef,
MaintenanceWindowTaskTypeDef,
SendCommandRequestRequestTypeDef,
TargetLocationTypeDef,
ListAssociationsResultTypeDef,
DescribeMaintenanceWindowTargetsResultTypeDef,
DescribeAssociationExecutionTargetsResultTypeDef,
ListCommandInvocationsResultTypeDef,
MaintenanceWindowTaskInvocationParametersTypeDef,
ListComplianceItemsResultTypeDef,
ComplianceSummaryItemTypeDef,
ResourceComplianceSummaryItemTypeDef,
ListDocumentsResultTypeDef,
DescribeOpsItemsResponseTypeDef,
GetOpsItemResponseTypeDef,
DescribePatchGroupsResultTypeDef,
CreateDocumentResultTypeDef,
DescribeDocumentResultTypeDef,
UpdateDocumentResultTypeDef,
DocumentMetadataResponseInfoTypeDef,
UpdateDocumentMetadataRequestRequestTypeDef,
DescribeEffectivePatchesForPatchBaselineResultTypeDef,
InventoryAggregatorTypeDef,
DescribeInstanceInformationResultTypeDef,
InstanceAssociationStatusInfoTypeDef,
DeleteInventoryResultTypeDef,
InventoryDeletionStatusItemTypeDef,
GetInventorySchemaResultTypeDef,
GetInventoryResultTypeDef,
GetOpsSummaryResultTypeDef,
ListOpsItemEventsResponseTypeDef,
ListOpsItemRelatedItemsResponseTypeDef,
GetParameterHistoryResultTypeDef,
DescribeParametersResultTypeDef,
PatchRuleTypeDef,
ResourceDataSyncSourceTypeDef,
ResourceDataSyncSourceWithStateTypeDef,
DescribeSessionsResponseTypeDef,
DescribeAssociationExecutionsResultTypeDef,
ListCommandsResultTypeDef,
SendCommandResultTypeDef,
DescribeMaintenanceWindowExecutionTasksResultTypeDef,
DescribeMaintenanceWindowTasksResultTypeDef,
AssociationDescriptionTypeDef,
AssociationVersionInfoTypeDef,
CreateAssociationBatchRequestEntryTypeDef,
CreateAssociationRequestRequestTypeDef,
RunbookTypeDef,
StartAutomationExecutionRequestRequestTypeDef,
StepExecutionTypeDef,
UpdateAssociationRequestRequestTypeDef,
GetMaintenanceWindowTaskResultTypeDef,
RegisterTaskWithMaintenanceWindowRequestRequestTypeDef,
UpdateMaintenanceWindowTaskRequestRequestTypeDef,
UpdateMaintenanceWindowTaskResultTypeDef,
ListComplianceSummariesResultTypeDef,
ListResourceComplianceSummariesResultTypeDef,
ListDocumentMetadataHistoryResponseTypeDef,
DescribeInstanceAssociationsStatusResultTypeDef,
DescribeInventoryDeletionsResultTypeDef,
PatchRuleGroupTypeDef,
CreateResourceDataSyncRequestRequestTypeDef,
UpdateResourceDataSyncRequestRequestTypeDef,
ResourceDataSyncItemTypeDef,
CreateAssociationResultTypeDef,
DescribeAssociationResultTypeDef,
UpdateAssociationResultTypeDef,
UpdateAssociationStatusResultTypeDef,
ListAssociationVersionsResultTypeDef,
CreateAssociationBatchRequestRequestTypeDef,
FailedCreateAssociationTypeDef,
AutomationExecutionMetadataTypeDef,
StartChangeRequestExecutionRequestRequestTypeDef,
AutomationExecutionTypeDef,
DescribeAutomationStepExecutionsResultTypeDef,
BaselineOverrideTypeDef,
CreatePatchBaselineRequestRequestTypeDef,
GetPatchBaselineResultTypeDef,
UpdatePatchBaselineRequestRequestTypeDef,
UpdatePatchBaselineResultTypeDef,
ListResourceDataSyncResultTypeDef,
CreateAssociationBatchResultTypeDef,
DescribeAutomationExecutionsResultTypeDef,
GetAutomationExecutionResultTypeDef,
GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef,
)
def get_structure() -> AccountSharingInfoTypeDef:
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-ssm` 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_ssm/)
## 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-ssm-1.26.97
%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-ssm -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot - 1.26.97-1
- Package Spec generated