Skip to content

Type definitions#

Index > SsmSap > Type definitions

Auto-generated documentation for SsmSap type annotations stubs module mypy-boto3-ssm-sap.

ApplicationCredentialTypeDef#

# ApplicationCredentialTypeDef definition

class ApplicationCredentialTypeDef(TypedDict):
    DatabaseName: str,
    CredentialType: CredentialTypeType,  # (1)
    SecretId: str,
  1. See CredentialTypeType

ApplicationSummaryTypeDef#

# ApplicationSummaryTypeDef definition

class ApplicationSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    DiscoveryStatus: NotRequired[ApplicationDiscoveryStatusType],  # (1)
    Type: NotRequired[ApplicationTypeType],  # (2)
    Arn: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
  1. See ApplicationDiscoveryStatusType
  2. See ApplicationTypeType

ApplicationTypeDef#

# ApplicationTypeDef definition

class ApplicationTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[ApplicationTypeType],  # (1)
    Arn: NotRequired[str],
    AppRegistryArn: NotRequired[str],
    Status: NotRequired[ApplicationStatusType],  # (2)
    DiscoveryStatus: NotRequired[ApplicationDiscoveryStatusType],  # (3)
    Components: NotRequired[List[str]],
    LastUpdated: NotRequired[datetime],
    StatusMessage: NotRequired[str],
  1. See ApplicationTypeType
  2. See ApplicationStatusType
  3. See ApplicationDiscoveryStatusType

IpAddressMemberTypeDef#

# IpAddressMemberTypeDef definition

class IpAddressMemberTypeDef(TypedDict):
    IpAddress: NotRequired[str],
    Primary: NotRequired[bool],
    AllocationType: NotRequired[AllocationTypeType],  # (1)
  1. See AllocationTypeType

BackintConfigTypeDef#

# BackintConfigTypeDef definition

class BackintConfigTypeDef(TypedDict):
    BackintMode: BackintModeType,  # (1)
    EnsureNoBackupInProcess: bool,
  1. See BackintModeType

ComponentSummaryTypeDef#

# ComponentSummaryTypeDef definition

class ComponentSummaryTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ComponentId: NotRequired[str],
    ComponentType: NotRequired[ComponentTypeType],  # (1)
    Tags: NotRequired[Dict[str, str]],
    Arn: NotRequired[str],
  1. See ComponentTypeType

DatabaseConnectionTypeDef#

# DatabaseConnectionTypeDef definition

class DatabaseConnectionTypeDef(TypedDict):
    DatabaseConnectionMethod: NotRequired[DatabaseConnectionMethodType],  # (1)
    DatabaseArn: NotRequired[str],
    ConnectionIp: NotRequired[str],
  1. See DatabaseConnectionMethodType

HostTypeDef#

# HostTypeDef definition

class HostTypeDef(TypedDict):
    HostName: NotRequired[str],
    HostIp: NotRequired[str],
    EC2InstanceId: NotRequired[str],
    InstanceId: NotRequired[str],
    HostRole: NotRequired[HostRoleType],  # (1)
    OsVersion: NotRequired[str],
  1. See HostRoleType

ResilienceTypeDef#

# ResilienceTypeDef definition

class ResilienceTypeDef(TypedDict):
    HsrTier: NotRequired[str],
    HsrReplicationMode: NotRequired[ReplicationModeType],  # (1)
    HsrOperationMode: NotRequired[OperationModeType],  # (2)
    ClusterStatus: NotRequired[ClusterStatusType],  # (3)
    EnqueueReplication: NotRequired[bool],
  1. See ReplicationModeType
  2. See OperationModeType
  3. See ClusterStatusType

DatabaseSummaryTypeDef#

# DatabaseSummaryTypeDef 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]],
  1. See DatabaseTypeType

DeleteResourcePermissionInputRequestTypeDef#

# DeleteResourcePermissionInputRequestTypeDef definition

class DeleteResourcePermissionInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    ActionType: NotRequired[PermissionActionTypeType],  # (1)
    SourceResourceArn: NotRequired[str],
  1. See PermissionActionTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeregisterApplicationInputRequestTypeDef#

# DeregisterApplicationInputRequestTypeDef definition

class DeregisterApplicationInputRequestTypeDef(TypedDict):
    ApplicationId: str,

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: str,
    Value: str,
    Operator: FilterOperatorType,  # (1)
  1. See FilterOperatorType

GetApplicationInputRequestTypeDef#

# GetApplicationInputRequestTypeDef definition

class GetApplicationInputRequestTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ApplicationArn: NotRequired[str],
    AppRegistryArn: NotRequired[str],

GetComponentInputRequestTypeDef#

# GetComponentInputRequestTypeDef definition

class GetComponentInputRequestTypeDef(TypedDict):
    ApplicationId: str,
    ComponentId: str,

GetDatabaseInputRequestTypeDef#

# GetDatabaseInputRequestTypeDef definition

class GetDatabaseInputRequestTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ComponentId: NotRequired[str],
    DatabaseId: NotRequired[str],
    DatabaseArn: NotRequired[str],

GetOperationInputRequestTypeDef#

# GetOperationInputRequestTypeDef definition

class GetOperationInputRequestTypeDef(TypedDict):
    OperationId: str,

OperationTypeDef#

# OperationTypeDef 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],
  1. See OperationStatusType

GetResourcePermissionInputRequestTypeDef#

# GetResourcePermissionInputRequestTypeDef definition

class GetResourcePermissionInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    ActionType: NotRequired[PermissionActionTypeType],  # (1)
  1. See PermissionActionTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListComponentsInputRequestTypeDef#

# ListComponentsInputRequestTypeDef definition

class ListComponentsInputRequestTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDatabasesInputRequestTypeDef#

# ListDatabasesInputRequestTypeDef definition

class ListDatabasesInputRequestTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ComponentId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    ResourceType: NotRequired[str],

PutResourcePermissionInputRequestTypeDef#

# PutResourcePermissionInputRequestTypeDef definition

class PutResourcePermissionInputRequestTypeDef(TypedDict):
    ActionType: PermissionActionTypeType,  # (1)
    SourceResourceArn: str,
    ResourceArn: str,
  1. See PermissionActionTypeType

StartApplicationInputRequestTypeDef#

# StartApplicationInputRequestTypeDef definition

class StartApplicationInputRequestTypeDef(TypedDict):
    ApplicationId: str,

StartApplicationRefreshInputRequestTypeDef#

# StartApplicationRefreshInputRequestTypeDef definition

class StartApplicationRefreshInputRequestTypeDef(TypedDict):
    ApplicationId: str,

StopApplicationInputRequestTypeDef#

# StopApplicationInputRequestTypeDef definition

class StopApplicationInputRequestTypeDef(TypedDict):
    ApplicationId: str,
    StopConnectedEntity: NotRequired[ConnectedEntityTypeType],  # (1)
    IncludeEc2InstanceShutdown: NotRequired[bool],
  1. See ConnectedEntityTypeType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

DatabaseTypeDef#

# DatabaseTypeDef 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],
  1. See ApplicationCredentialTypeDef
  2. See DatabaseTypeType
  3. See DatabaseStatusType

RegisterApplicationInputRequestTypeDef#

# RegisterApplicationInputRequestTypeDef definition

class RegisterApplicationInputRequestTypeDef(TypedDict):
    ApplicationId: str,
    ApplicationType: ApplicationTypeType,  # (1)
    Instances: Sequence[str],
    SapInstanceNumber: NotRequired[str],
    Sid: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    Credentials: NotRequired[Sequence[ApplicationCredentialTypeDef]],  # (2)
    DatabaseArn: NotRequired[str],
  1. See ApplicationTypeType
  2. See ApplicationCredentialTypeDef

AssociatedHostTypeDef#

# AssociatedHostTypeDef definition

class AssociatedHostTypeDef(TypedDict):
    Hostname: NotRequired[str],
    Ec2InstanceId: NotRequired[str],
    IpAddresses: NotRequired[List[IpAddressMemberTypeDef]],  # (1)
    OsVersion: NotRequired[str],
  1. See IpAddressMemberTypeDef

UpdateApplicationSettingsInputRequestTypeDef#

# UpdateApplicationSettingsInputRequestTypeDef definition

class UpdateApplicationSettingsInputRequestTypeDef(TypedDict):
    ApplicationId: str,
    CredentialsToAddOrUpdate: NotRequired[Sequence[ApplicationCredentialTypeDef]],  # (1)
    CredentialsToRemove: NotRequired[Sequence[ApplicationCredentialTypeDef]],  # (1)
    Backint: NotRequired[BackintConfigTypeDef],  # (3)
    DatabaseArn: NotRequired[str],
  1. See ApplicationCredentialTypeDef
  2. See ApplicationCredentialTypeDef
  3. See BackintConfigTypeDef

DeleteResourcePermissionOutputTypeDef#

# DeleteResourcePermissionOutputTypeDef definition

class DeleteResourcePermissionOutputTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetApplicationOutputTypeDef#

# GetApplicationOutputTypeDef definition

class GetApplicationOutputTypeDef(TypedDict):
    Application: ApplicationTypeDef,  # (1)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApplicationTypeDef
  2. See ResponseMetadataTypeDef

GetResourcePermissionOutputTypeDef#

# GetResourcePermissionOutputTypeDef definition

class GetResourcePermissionOutputTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListApplicationsOutputTypeDef#

# ListApplicationsOutputTypeDef definition

class ListApplicationsOutputTypeDef(TypedDict):
    Applications: List[ApplicationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ApplicationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListComponentsOutputTypeDef#

# ListComponentsOutputTypeDef definition

class ListComponentsOutputTypeDef(TypedDict):
    Components: List[ComponentSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ComponentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDatabasesOutputTypeDef#

# ListDatabasesOutputTypeDef definition

class ListDatabasesOutputTypeDef(TypedDict):
    Databases: List[DatabaseSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DatabaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutResourcePermissionOutputTypeDef#

# PutResourcePermissionOutputTypeDef definition

class PutResourcePermissionOutputTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterApplicationOutputTypeDef#

# RegisterApplicationOutputTypeDef definition

class RegisterApplicationOutputTypeDef(TypedDict):
    Application: ApplicationTypeDef,  # (1)
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApplicationTypeDef
  2. See ResponseMetadataTypeDef

StartApplicationOutputTypeDef#

# StartApplicationOutputTypeDef definition

class StartApplicationOutputTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartApplicationRefreshOutputTypeDef#

# StartApplicationRefreshOutputTypeDef definition

class StartApplicationRefreshOutputTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopApplicationOutputTypeDef#

# StopApplicationOutputTypeDef definition

class StopApplicationOutputTypeDef(TypedDict):
    OperationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateApplicationSettingsOutputTypeDef#

# UpdateApplicationSettingsOutputTypeDef definition

class UpdateApplicationSettingsOutputTypeDef(TypedDict):
    Message: str,
    OperationIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListApplicationsInputRequestTypeDef#

# ListApplicationsInputRequestTypeDef definition

class ListApplicationsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListOperationEventsInputRequestTypeDef#

# ListOperationEventsInputRequestTypeDef definition

class ListOperationEventsInputRequestTypeDef(TypedDict):
    OperationId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListOperationsInputRequestTypeDef#

# ListOperationsInputRequestTypeDef definition

class ListOperationsInputRequestTypeDef(TypedDict):
    ApplicationId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

GetOperationOutputTypeDef#

# GetOperationOutputTypeDef definition

class GetOperationOutputTypeDef(TypedDict):
    Operation: OperationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OperationTypeDef
  2. See ResponseMetadataTypeDef

ListOperationsOutputTypeDef#

# ListOperationsOutputTypeDef definition

class ListOperationsOutputTypeDef(TypedDict):
    Operations: List[OperationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See OperationTypeDef
  2. See ResponseMetadataTypeDef

ListApplicationsInputListApplicationsPaginateTypeDef#

# ListApplicationsInputListApplicationsPaginateTypeDef definition

class ListApplicationsInputListApplicationsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListComponentsInputListComponentsPaginateTypeDef#

# ListComponentsInputListComponentsPaginateTypeDef definition

class ListComponentsInputListComponentsPaginateTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatabasesInputListDatabasesPaginateTypeDef#

# ListDatabasesInputListDatabasesPaginateTypeDef definition

class ListDatabasesInputListDatabasesPaginateTypeDef(TypedDict):
    ApplicationId: NotRequired[str],
    ComponentId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListOperationEventsInputListOperationEventsPaginateTypeDef