Typed dictionaries
Auto-generated documentation for SsmSap type annotations stubs module mypy-boto3-ssm-sap.
ApplicationCredentialTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ApplicationCredentialTypeDef
def get_value() -> ApplicationCredentialTypeDef:
return {
"DatabaseName": ...,
"CredentialType": ...,
"SecretId": ...,
}
Definition
class ApplicationCredentialTypeDef(TypedDict):
DatabaseName: str,
CredentialType: CredentialTypeType, # (1)
SecretId: str,
ApplicationSummaryTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ApplicationSummaryTypeDef
def get_value() -> ApplicationSummaryTypeDef:
return {
"Id": ...,
}
Definition
class ApplicationSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[ApplicationTypeType], # (1)
Arn: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
ApplicationTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ApplicationTypeDef
def get_value() -> ApplicationTypeDef:
return {
"Id": ...,
}
Definition
class ApplicationTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[ApplicationTypeType], # (1)
Arn: NotRequired[str],
AppRegistryArn: NotRequired[str],
Status: NotRequired[ApplicationStatusType], # (2)
Components: NotRequired[List[str]],
LastUpdated: NotRequired[datetime],
StatusMessage: NotRequired[str],
ComponentSummaryTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ComponentSummaryTypeDef
def get_value() -> ComponentSummaryTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ComponentSummaryTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
ComponentType: NotRequired[ComponentTypeType], # (1)
Tags: NotRequired[Dict[str, str]],
HostTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import HostTypeDef
def get_value() -> HostTypeDef:
return {
"HostName": ...,
}
Definition
class HostTypeDef(TypedDict):
HostName: NotRequired[str],
HostRole: NotRequired[HostRoleType], # (1)
HostIp: NotRequired[str],
InstanceId: NotRequired[str],
- See HostRoleType
DatabaseSummaryTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import DatabaseSummaryTypeDef
def get_value() -> DatabaseSummaryTypeDef:
return {
"ApplicationId": ...,
}
Definition
class DatabaseSummaryTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
DatabaseId: NotRequired[str],
DatabaseType: NotRequired[DatabaseTypeType], # (1)
Arn: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
- See DatabaseTypeType
DeleteResourcePermissionInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import DeleteResourcePermissionInputRequestTypeDef
def get_value() -> DeleteResourcePermissionInputRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class DeleteResourcePermissionInputRequestTypeDef(TypedDict):
ResourceArn: str,
ActionType: NotRequired[PermissionActionTypeType], # (1)
SourceResourceArn: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeregisterApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import DeregisterApplicationInputRequestTypeDef
def get_value() -> DeregisterApplicationInputRequestTypeDef:
return {
"ApplicationId": ...,
}
FilterTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Name": ...,
"Value": ...,
"Operator": ...,
}
Definition
class FilterTypeDef(TypedDict):
Name: str,
Value: str,
Operator: FilterOperatorType, # (1)
GetApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetApplicationInputRequestTypeDef
def get_value() -> GetApplicationInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class GetApplicationInputRequestTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ApplicationArn: NotRequired[str],
AppRegistryArn: NotRequired[str],
GetComponentInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetComponentInputRequestTypeDef
def get_value() -> GetComponentInputRequestTypeDef:
return {
"ApplicationId": ...,
"ComponentId": ...,
}
GetDatabaseInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetDatabaseInputRequestTypeDef
def get_value() -> GetDatabaseInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class GetDatabaseInputRequestTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
DatabaseId: NotRequired[str],
DatabaseArn: NotRequired[str],
GetOperationInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetOperationInputRequestTypeDef
def get_value() -> GetOperationInputRequestTypeDef:
return {
"OperationId": ...,
}
OperationTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import OperationTypeDef
def get_value() -> OperationTypeDef:
return {
"Id": ...,
}
Definition
class OperationTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[str],
Status: NotRequired[OperationStatusType], # (1)
StatusMessage: NotRequired[str],
Properties: NotRequired[Dict[str, str]],
ResourceType: NotRequired[str],
ResourceId: NotRequired[str],
ResourceArn: NotRequired[str],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
GetResourcePermissionInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetResourcePermissionInputRequestTypeDef
def get_value() -> GetResourcePermissionInputRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class GetResourcePermissionInputRequestTypeDef(TypedDict):
ResourceArn: str,
ActionType: NotRequired[PermissionActionTypeType], # (1)
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListApplicationsInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListApplicationsInputRequestTypeDef
def get_value() -> ListApplicationsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListApplicationsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListComponentsInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListComponentsInputRequestTypeDef
def get_value() -> ListComponentsInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListComponentsInputRequestTypeDef(TypedDict):
ApplicationId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDatabasesInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListDatabasesInputRequestTypeDef
def get_value() -> ListDatabasesInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListDatabasesInputRequestTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
PutResourcePermissionInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import PutResourcePermissionInputRequestTypeDef
def get_value() -> PutResourcePermissionInputRequestTypeDef:
return {
"ActionType": ...,
"SourceResourceArn": ...,
"ResourceArn": ...,
}
Definition
class PutResourcePermissionInputRequestTypeDef(TypedDict):
ActionType: PermissionActionTypeType, # (1)
SourceResourceArn: str,
ResourceArn: str,
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
DatabaseTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import DatabaseTypeDef
def get_value() -> DatabaseTypeDef:
return {
"ApplicationId": ...,
}
Definition
class DatabaseTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
Credentials: NotRequired[List[ApplicationCredentialTypeDef]], # (1)
DatabaseId: NotRequired[str],
DatabaseName: NotRequired[str],
DatabaseType: NotRequired[DatabaseTypeType], # (2)
Arn: NotRequired[str],
Status: NotRequired[DatabaseStatusType], # (3)
PrimaryHost: NotRequired[str],
SQLPort: NotRequired[int],
LastUpdated: NotRequired[datetime],
RegisterApplicationInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import RegisterApplicationInputRequestTypeDef
def get_value() -> RegisterApplicationInputRequestTypeDef:
return {
"ApplicationId": ...,
"ApplicationType": ...,
"Instances": ...,
"Credentials": ...,
}
Definition
class RegisterApplicationInputRequestTypeDef(TypedDict):
ApplicationId: str,
ApplicationType: ApplicationTypeType, # (1)
Instances: Sequence[str],
Credentials: Sequence[ApplicationCredentialTypeDef], # (2)
SapInstanceNumber: NotRequired[str],
Sid: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
UpdateApplicationSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import UpdateApplicationSettingsInputRequestTypeDef
def get_value() -> UpdateApplicationSettingsInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class UpdateApplicationSettingsInputRequestTypeDef(TypedDict):
ApplicationId: str,
CredentialsToAddOrUpdate: NotRequired[Sequence[ApplicationCredentialTypeDef]], # (1)
CredentialsToRemove: NotRequired[Sequence[ApplicationCredentialTypeDef]], # (1)
ComponentTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ComponentTypeDef
def get_value() -> ComponentTypeDef:
return {
"ComponentId": ...,
}
Definition
class ComponentTypeDef(TypedDict):
ComponentId: NotRequired[str],
ApplicationId: NotRequired[str],
ComponentType: NotRequired[ComponentTypeType], # (1)
Status: NotRequired[ComponentStatusType], # (2)
Databases: NotRequired[List[str]],
Hosts: NotRequired[List[HostTypeDef]], # (3)
PrimaryHost: NotRequired[str],
LastUpdated: NotRequired[datetime],
- See ComponentTypeType
- See ComponentStatusType
- See HostTypeDef
DeleteResourcePermissionOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import DeleteResourcePermissionOutputTypeDef
def get_value() -> DeleteResourcePermissionOutputTypeDef:
return {
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteResourcePermissionOutputTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetApplicationOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetApplicationOutputTypeDef
def get_value() -> GetApplicationOutputTypeDef:
return {
"Application": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class GetApplicationOutputTypeDef(TypedDict):
Application: ApplicationTypeDef, # (1)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetResourcePermissionOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetResourcePermissionOutputTypeDef
def get_value() -> GetResourcePermissionOutputTypeDef:
return {
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class GetResourcePermissionOutputTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListApplicationsOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListApplicationsOutputTypeDef
def get_value() -> ListApplicationsOutputTypeDef:
return {
"Applications": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListApplicationsOutputTypeDef(TypedDict):
Applications: List[ApplicationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListComponentsOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListComponentsOutputTypeDef
def get_value() -> ListComponentsOutputTypeDef:
return {
"Components": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListComponentsOutputTypeDef(TypedDict):
Components: List[ComponentSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatabasesOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListDatabasesOutputTypeDef
def get_value() -> ListDatabasesOutputTypeDef:
return {
"Databases": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatabasesOutputTypeDef(TypedDict):
Databases: List[DatabaseSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutResourcePermissionOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import PutResourcePermissionOutputTypeDef
def get_value() -> PutResourcePermissionOutputTypeDef:
return {
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class PutResourcePermissionOutputTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterApplicationOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import RegisterApplicationOutputTypeDef
def get_value() -> RegisterApplicationOutputTypeDef:
return {
"Application": ...,
"OperationId": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterApplicationOutputTypeDef(TypedDict):
Application: ApplicationTypeDef, # (1)
OperationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateApplicationSettingsOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import UpdateApplicationSettingsOutputTypeDef
def get_value() -> UpdateApplicationSettingsOutputTypeDef:
return {
"Message": ...,
"OperationIds": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateApplicationSettingsOutputTypeDef(TypedDict):
Message: str,
OperationIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListOperationsInputRequestTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListOperationsInputRequestTypeDef
def get_value() -> ListOperationsInputRequestTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListOperationsInputRequestTypeDef(TypedDict):
ApplicationId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
GetOperationOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetOperationOutputTypeDef
def get_value() -> GetOperationOutputTypeDef:
return {
"Operation": ...,
"ResponseMetadata": ...,
}
Definition
class GetOperationOutputTypeDef(TypedDict):
Operation: OperationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListOperationsOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListOperationsOutputTypeDef
def get_value() -> ListOperationsOutputTypeDef:
return {
"Operations": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListOperationsOutputTypeDef(TypedDict):
Operations: List[OperationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListApplicationsInputListApplicationsPaginateTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListApplicationsInputListApplicationsPaginateTypeDef
def get_value() -> ListApplicationsInputListApplicationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListApplicationsInputListApplicationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListComponentsInputListComponentsPaginateTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListComponentsInputListComponentsPaginateTypeDef
def get_value() -> ListComponentsInputListComponentsPaginateTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListComponentsInputListComponentsPaginateTypeDef(TypedDict):
ApplicationId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatabasesInputListDatabasesPaginateTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListDatabasesInputListDatabasesPaginateTypeDef
def get_value() -> ListDatabasesInputListDatabasesPaginateTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListDatabasesInputListDatabasesPaginateTypeDef(TypedDict):
ApplicationId: NotRequired[str],
ComponentId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOperationsInputListOperationsPaginateTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import ListOperationsInputListOperationsPaginateTypeDef
def get_value() -> ListOperationsInputListOperationsPaginateTypeDef:
return {
"ApplicationId": ...,
}
Definition
class ListOperationsInputListOperationsPaginateTypeDef(TypedDict):
ApplicationId: str,
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
GetDatabaseOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetDatabaseOutputTypeDef
def get_value() -> GetDatabaseOutputTypeDef:
return {
"Database": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class GetDatabaseOutputTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetComponentOutputTypeDef
Usage Example
from mypy_boto3_ssm_sap.type_defs import GetComponentOutputTypeDef
def get_value() -> GetComponentOutputTypeDef:
return {
"Component": ...,
"ResponseMetadata": ...,
}