SsmSap module#
Index > SsmSap
Auto-generated documentation for SsmSap type annotations stubs module mypy-boto3-ssm-sap.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
SsmSap
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SsmSap
.
From PyPI with pip#
Install boto3-stubs
for SsmSap
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm-sap]'
# 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-sap]'
# standalone installation
python -m pip install mypy-boto3-ssm-sap
How to uninstall#
python -m pip uninstall -y mypy-boto3-ssm-sap
Usage#
Code samples can be found in Examples.
SsmSapClient#
Type annotations and code completion for boto3.client("ssm-sap")
as SsmSapClient
boto3 documentation
# SsmSapClient usage example
from boto3.session import Session
from mypy_boto3_ssm_sap.client import SsmSapClient
def get_client() -> SsmSapClient:
return Session().client("ssm-sap")
Paginators#
Type annotations and code completion for paginators
from boto3.client("ssm-sap").get_paginator("...")
.
# ListApplicationsPaginator usage example
from boto3.session import Session
from mypy_boto3_ssm_sap.paginator import ListApplicationsPaginator
def get_list_applications_paginator() -> ListApplicationsPaginator:
return Session().client("ssm-sap").get_paginator("list_applications"))
- ListApplicationsPaginator
- ListComponentsPaginator
- ListDatabasesPaginator
- ListOperationEventsPaginator
- ListOperationsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AllocationTypeType usage example
from mypy_boto3_ssm_sap.literals import AllocationTypeType
def get_value() -> AllocationTypeType:
return "ELASTIC_IP"
- AllocationTypeType
- ApplicationDiscoveryStatusType
- ApplicationStatusType
- ApplicationTypeType
- BackintModeType
- ClusterStatusType
- ComponentStatusType
- ComponentTypeType
- ConnectedEntityTypeType
- CredentialTypeType
- DatabaseConnectionMethodType
- DatabaseStatusType
- DatabaseTypeType
- FilterOperatorType
- HostRoleType
- ListApplicationsPaginatorName
- ListComponentsPaginatorName
- ListDatabasesPaginatorName
- ListOperationEventsPaginatorName
- ListOperationsPaginatorName
- OperationEventStatusType
- OperationModeType
- OperationStatusType
- PermissionActionTypeType
- ReplicationModeType
- SsmSapServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ApplicationCredentialTypeDef
- ApplicationSummaryTypeDef
- ApplicationTypeDef
- IpAddressMemberTypeDef
- BackintConfigTypeDef
- ComponentInfoTypeDef
- ComponentSummaryTypeDef
- DatabaseConnectionTypeDef
- HostTypeDef
- ResilienceTypeDef
- DatabaseSummaryTypeDef
- DeleteResourcePermissionInputRequestTypeDef
- ResponseMetadataTypeDef
- DeregisterApplicationInputRequestTypeDef
- FilterTypeDef
- GetApplicationInputRequestTypeDef
- GetComponentInputRequestTypeDef
- GetDatabaseInputRequestTypeDef
- GetOperationInputRequestTypeDef
- OperationTypeDef
- GetResourcePermissionInputRequestTypeDef
- PaginatorConfigTypeDef
- ListComponentsInputRequestTypeDef
- ListDatabasesInputRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ResourceTypeDef
- PutResourcePermissionInputRequestTypeDef
- StartApplicationInputRequestTypeDef
- StartApplicationRefreshInputRequestTypeDef
- StopApplicationInputRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- DatabaseTypeDef
- AssociatedHostTypeDef
- UpdateApplicationSettingsInputRequestTypeDef
- RegisterApplicationInputRequestTypeDef
- DeleteResourcePermissionOutputTypeDef
- GetApplicationOutputTypeDef
- GetResourcePermissionOutputTypeDef
- ListApplicationsOutputTypeDef
- ListComponentsOutputTypeDef
- ListDatabasesOutputTypeDef
- ListTagsForResourceResponseTypeDef
- PutResourcePermissionOutputTypeDef
- RegisterApplicationOutputTypeDef
- StartApplicationOutputTypeDef
- StartApplicationRefreshOutputTypeDef
- StopApplicationOutputTypeDef
- UpdateApplicationSettingsOutputTypeDef
- ListApplicationsInputRequestTypeDef
- ListOperationEventsInputRequestTypeDef
- ListOperationsInputRequestTypeDef
- GetOperationOutputTypeDef
- ListOperationsOutputTypeDef
- ListApplicationsInputPaginateTypeDef
- ListComponentsInputPaginateTypeDef
- ListDatabasesInputPaginateTypeDef
- ListOperationEventsInputPaginateTypeDef
- ListOperationsInputPaginateTypeDef
- OperationEventTypeDef
- GetDatabaseOutputTypeDef
- ComponentTypeDef
- ListOperationEventsOutputTypeDef
- GetComponentOutputTypeDef