SsmSapClient

Index > SsmSap > SsmSapClient

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

SsmSapClient

Type annotations and code completion for boto3.client("ssm-sap"). boto3 documentation

# SsmSapClient usage example

from boto3.session import Session
from types_boto3_ssm_sap.client import SsmSapClient

def get_ssm-sap_client() -> SsmSapClient:
    return Session().client("ssm-sap")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ssm-sap").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("ssm-sap")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_ssm_sap.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("ssm-sap").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("ssm-sap").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

delete_resource_permission

Removes permissions associated with the target database.

Type annotations and code completion for boto3.client("ssm-sap").delete_resource_permission method. boto3 documentation

# delete_resource_permission method definition

def delete_resource_permission(
    self,
    *,
    ResourceArn: str,
    ActionType: PermissionActionTypeType = ...,  # (1)
    SourceResourceArn: str = ...,
) -> DeleteResourcePermissionOutputTypeDef:  # (2)
    ...

1. See PermissionActionTypeType
2. See DeleteResourcePermissionOutputTypeDef

# delete_resource_permission method usage example with argument unpacking

kwargs: DeleteResourcePermissionInputTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_permission(**kwargs)

1. See DeleteResourcePermissionInputTypeDef

deregister_application

Deregister an SAP application with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").deregister_application method. boto3 documentation

# deregister_application method definition

def deregister_application(
    self,
    *,
    ApplicationId: str,
) -> Dict[str, Any]:
    ...

# deregister_application method usage example with argument unpacking

kwargs: DeregisterApplicationInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.deregister_application(**kwargs)

1. See DeregisterApplicationInputTypeDef

get_application

Gets an application registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    ApplicationId: str = ...,
    ApplicationArn: str = ...,
    AppRegistryArn: str = ...,
) -> GetApplicationOutputTypeDef:  # (1)
    ...

1. See GetApplicationOutputTypeDef

# get_application method usage example with argument unpacking

kwargs: GetApplicationInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationInputTypeDef

get_component

Gets the component of an application registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").get_component method. boto3 documentation

# get_component method definition

def get_component(
    self,
    *,
    ApplicationId: str,
    ComponentId: str,
) -> GetComponentOutputTypeDef:  # (1)
    ...

1. See GetComponentOutputTypeDef

# get_component method usage example with argument unpacking

kwargs: GetComponentInputTypeDef = {  # (1)
    "ApplicationId": ...,
    "ComponentId": ...,
}

parent.get_component(**kwargs)

1. See GetComponentInputTypeDef

get_configuration_check_operation

Gets the details of a configuration check operation by specifying the operation ID.

Type annotations and code completion for boto3.client("ssm-sap").get_configuration_check_operation method. boto3 documentation

# get_configuration_check_operation method definition

def get_configuration_check_operation(
    self,
    *,
    OperationId: str,
) -> GetConfigurationCheckOperationOutputTypeDef:  # (1)
    ...

1. See GetConfigurationCheckOperationOutputTypeDef

# get_configuration_check_operation method usage example with argument unpacking

kwargs: GetConfigurationCheckOperationInputTypeDef = {  # (1)
    "OperationId": ...,
}

parent.get_configuration_check_operation(**kwargs)

1. See GetConfigurationCheckOperationInputTypeDef

get_database

Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").get_database method. boto3 documentation

# get_database method definition

def get_database(
    self,
    *,
    ApplicationId: str = ...,
    ComponentId: str = ...,
    DatabaseId: str = ...,
    DatabaseArn: str = ...,
) -> GetDatabaseOutputTypeDef:  # (1)
    ...

1. See GetDatabaseOutputTypeDef

# get_database method usage example with argument unpacking

kwargs: GetDatabaseInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_database(**kwargs)

1. See GetDatabaseInputTypeDef

get_operation

Gets the details of an operation by specifying the operation ID.

Type annotations and code completion for boto3.client("ssm-sap").get_operation method. boto3 documentation

# get_operation method definition

def get_operation(
    self,
    *,
    OperationId: str,
) -> GetOperationOutputTypeDef:  # (1)
    ...

1. See GetOperationOutputTypeDef

# get_operation method usage example with argument unpacking

kwargs: GetOperationInputTypeDef = {  # (1)
    "OperationId": ...,
}

parent.get_operation(**kwargs)

1. See GetOperationInputTypeDef

get_resource_permission

Gets permissions associated with the target database.

Type annotations and code completion for boto3.client("ssm-sap").get_resource_permission method. boto3 documentation

# get_resource_permission method definition

def get_resource_permission(
    self,
    *,
    ResourceArn: str,
    ActionType: PermissionActionTypeType = ...,  # (1)
) -> GetResourcePermissionOutputTypeDef:  # (2)
    ...

1. See PermissionActionTypeType
2. See GetResourcePermissionOutputTypeDef

# get_resource_permission method usage example with argument unpacking

kwargs: GetResourcePermissionInputTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_permission(**kwargs)

1. See GetResourcePermissionInputTypeDef

list_applications

Lists all the applications registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListApplicationsOutputTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListApplicationsOutputTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsInputTypeDef

list_components

Lists all the components registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_components method. boto3 documentation

# list_components method definition

def list_components(
    self,
    *,
    ApplicationId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComponentsOutputTypeDef:  # (1)
    ...

1. See ListComponentsOutputTypeDef

# list_components method usage example with argument unpacking

kwargs: ListComponentsInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_components(**kwargs)

1. See ListComponentsInputTypeDef

list_configuration_check_definitions

Lists all configuration check types supported by AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_configuration_check_definitions method. boto3 documentation

# list_configuration_check_definitions method definition

def list_configuration_check_definitions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationCheckDefinitionsOutputTypeDef:  # (1)
    ...

1. See ListConfigurationCheckDefinitionsOutputTypeDef

# list_configuration_check_definitions method usage example with argument unpacking

kwargs: ListConfigurationCheckDefinitionsInputTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_configuration_check_definitions(**kwargs)

1. See ListConfigurationCheckDefinitionsInputTypeDef

list_configuration_check_operations

Lists the configuration check operations performed by AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_configuration_check_operations method. boto3 documentation

# list_configuration_check_operations method definition

def list_configuration_check_operations(
    self,
    *,
    ApplicationId: str,
    ListMode: ConfigurationCheckOperationListingModeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
) -> ListConfigurationCheckOperationsOutputTypeDef:  # (3)
    ...

1. See ConfigurationCheckOperationListingModeType
2. See Sequence[FilterTypeDef]
3. See ListConfigurationCheckOperationsOutputTypeDef

# list_configuration_check_operations method usage example with argument unpacking

kwargs: ListConfigurationCheckOperationsInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_configuration_check_operations(**kwargs)

1. See ListConfigurationCheckOperationsInputTypeDef

list_databases

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_databases method. boto3 documentation

# list_databases method definition

def list_databases(
    self,
    *,
    ApplicationId: str = ...,
    ComponentId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatabasesOutputTypeDef:  # (1)
    ...

1. See ListDatabasesOutputTypeDef

# list_databases method usage example with argument unpacking

kwargs: ListDatabasesInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_databases(**kwargs)

1. See ListDatabasesInputTypeDef

list_operation_events

Returns a list of operations events.

Type annotations and code completion for boto3.client("ssm-sap").list_operation_events method. boto3 documentation

# list_operation_events method definition

def list_operation_events(
    self,
    *,
    OperationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListOperationEventsOutputTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListOperationEventsOutputTypeDef

# list_operation_events method usage example with argument unpacking

kwargs: ListOperationEventsInputTypeDef = {  # (1)
    "OperationId": ...,
}

parent.list_operation_events(**kwargs)

1. See ListOperationEventsInputTypeDef

list_operations

Lists the operations performed by AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_operations method. boto3 documentation

# list_operations method definition

def list_operations(
    self,
    *,
    ApplicationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListOperationsOutputTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListOperationsOutputTypeDef

# list_operations method usage example with argument unpacking

kwargs: ListOperationsInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_operations(**kwargs)

1. See ListOperationsInputTypeDef

list_sub_check_results

Lists the sub-check results of a specified configuration check operation.

Type annotations and code completion for boto3.client("ssm-sap").list_sub_check_results method. boto3 documentation

# list_sub_check_results method definition

def list_sub_check_results(
    self,
    *,
    OperationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSubCheckResultsOutputTypeDef:  # (1)
    ...

1. See ListSubCheckResultsOutputTypeDef

# list_sub_check_results method usage example with argument unpacking

kwargs: ListSubCheckResultsInputTypeDef = {  # (1)
    "OperationId": ...,
}

parent.list_sub_check_results(**kwargs)

1. See ListSubCheckResultsInputTypeDef

list_sub_check_rule_results

Lists the rules of a specified sub-check belonging to a configuration check operation.

Type annotations and code completion for boto3.client("ssm-sap").list_sub_check_rule_results method. boto3 documentation

# list_sub_check_rule_results method definition

def list_sub_check_rule_results(
    self,
    *,
    SubCheckResultId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSubCheckRuleResultsOutputTypeDef:  # (1)
    ...

1. See ListSubCheckRuleResultsOutputTypeDef

# list_sub_check_rule_results method usage example with argument unpacking

kwargs: ListSubCheckRuleResultsInputTypeDef = {  # (1)
    "SubCheckResultId": ...,
}

parent.list_sub_check_rule_results(**kwargs)

1. See ListSubCheckRuleResultsInputTypeDef

list_tags_for_resource

Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

put_resource_permission

Adds permissions to the target database.

Type annotations and code completion for boto3.client("ssm-sap").put_resource_permission method. boto3 documentation

# put_resource_permission method definition

def put_resource_permission(
    self,
    *,
    ActionType: PermissionActionTypeType,  # (1)
    SourceResourceArn: str,
    ResourceArn: str,
) -> PutResourcePermissionOutputTypeDef:  # (2)
    ...

1. See PermissionActionTypeType
2. See PutResourcePermissionOutputTypeDef

# put_resource_permission method usage example with argument unpacking

kwargs: PutResourcePermissionInputTypeDef = {  # (1)
    "ActionType": ...,
    "SourceResourceArn": ...,
    "ResourceArn": ...,
}

parent.put_resource_permission(**kwargs)

1. See PutResourcePermissionInputTypeDef

register_application

Register an SAP application with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").register_application method. boto3 documentation

# register_application method definition

def register_application(
    self,
    *,
    ApplicationId: str,
    ApplicationType: ApplicationTypeType,  # (1)
    Instances: Sequence[str],
    SapInstanceNumber: str = ...,
    Sid: str = ...,
    Tags: Mapping[str, str] = ...,
    Credentials: Sequence[ApplicationCredentialTypeDef] = ...,  # (2)
    DatabaseArn: str = ...,
    ComponentsInfo: Sequence[ComponentInfoTypeDef] = ...,  # (3)
) -> RegisterApplicationOutputTypeDef:  # (4)
    ...

1. See ApplicationTypeType
2. See Sequence[ApplicationCredentialTypeDef]
3. See Sequence[ComponentInfoTypeDef]
4. See RegisterApplicationOutputTypeDef

# register_application method usage example with argument unpacking

kwargs: RegisterApplicationInputTypeDef = {  # (1)
    "ApplicationId": ...,
    "ApplicationType": ...,
    "Instances": ...,
}

parent.register_application(**kwargs)

1. See RegisterApplicationInputTypeDef

start_application

Request is an operation which starts an application.

Type annotations and code completion for boto3.client("ssm-sap").start_application method. boto3 documentation

# start_application method definition

def start_application(
    self,
    *,
    ApplicationId: str,
) -> StartApplicationOutputTypeDef:  # (1)
    ...

1. See StartApplicationOutputTypeDef

# start_application method usage example with argument unpacking

kwargs: StartApplicationInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.start_application(**kwargs)

1. See StartApplicationInputTypeDef

start_application_refresh

Refreshes a registered application.

Type annotations and code completion for boto3.client("ssm-sap").start_application_refresh method. boto3 documentation

# start_application_refresh method definition

def start_application_refresh(
    self,
    *,
    ApplicationId: str,
) -> StartApplicationRefreshOutputTypeDef:  # (1)
    ...

1. See StartApplicationRefreshOutputTypeDef

# start_application_refresh method usage example with argument unpacking

kwargs: StartApplicationRefreshInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.start_application_refresh(**kwargs)

1. See StartApplicationRefreshInputTypeDef

start_configuration_checks

Initiates configuration check operations against a specified application.

Type annotations and code completion for boto3.client("ssm-sap").start_configuration_checks method. boto3 documentation

# start_configuration_checks method definition

def start_configuration_checks(
    self,
    *,
    ApplicationId: str,
    ConfigurationCheckIds: Sequence[ConfigurationCheckTypeType] = ...,  # (1)
) -> StartConfigurationChecksOutputTypeDef:  # (2)
    ...

1. See Sequence[ConfigurationCheckTypeType]
2. See StartConfigurationChecksOutputTypeDef

# start_configuration_checks method usage example with argument unpacking

kwargs: StartConfigurationChecksInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.start_configuration_checks(**kwargs)

1. See StartConfigurationChecksInputTypeDef

stop_application

Request is an operation to stop an application.

Type annotations and code completion for boto3.client("ssm-sap").stop_application method. boto3 documentation

# stop_application method definition

def stop_application(
    self,
    *,
    ApplicationId: str,
    StopConnectedEntity: ConnectedEntityTypeType = ...,  # (1)
    IncludeEc2InstanceShutdown: bool = ...,
) -> StopApplicationOutputTypeDef:  # (2)
    ...

1. See ConnectedEntityTypeType
2. See StopApplicationOutputTypeDef

# stop_application method usage example with argument unpacking

kwargs: StopApplicationInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.stop_application(**kwargs)

1. See StopApplicationInputTypeDef

tag_resource

Creates tag for a resource by specifying the ARN.

Type annotations and code completion for boto3.client("ssm-sap").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Delete the tags for a resource.

Type annotations and code completion for boto3.client("ssm-sap").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_application_settings

Updates the settings of an application registered with AWS Systems Manager for SAP.

Type annotations and code completion for boto3.client("ssm-sap").update_application_settings method. boto3 documentation

# update_application_settings method definition

def update_application_settings(
    self,
    *,
    ApplicationId: str,
    CredentialsToAddOrUpdate: Sequence[ApplicationCredentialTypeDef] = ...,  # (1)
    CredentialsToRemove: Sequence[ApplicationCredentialTypeDef] = ...,  # (1)
    Backint: BackintConfigTypeDef = ...,  # (3)
    DatabaseArn: str = ...,
) -> UpdateApplicationSettingsOutputTypeDef:  # (4)
    ...

1. See Sequence[ApplicationCredentialTypeDef]
2. See Sequence[ApplicationCredentialTypeDef]
3. See BackintConfigTypeDef
4. See UpdateApplicationSettingsOutputTypeDef

# update_application_settings method usage example with argument unpacking

kwargs: UpdateApplicationSettingsInputTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.update_application_settings(**kwargs)

1. See UpdateApplicationSettingsInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("ssm-sap").get_paginator method with overloads.

• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_components") -> ListComponentsPaginator
• client.get_paginator("list_configuration_check_definitions") -> ListConfigurationCheckDefinitionsPaginator
• client.get_paginator("list_configuration_check_operations") -> ListConfigurationCheckOperationsPaginator
• client.get_paginator("list_databases") -> ListDatabasesPaginator
• client.get_paginator("list_operation_events") -> ListOperationEventsPaginator
• client.get_paginator("list_operations") -> ListOperationsPaginator
• client.get_paginator("list_sub_check_results") -> ListSubCheckResultsPaginator
• client.get_paginator("list_sub_check_rule_results") -> ListSubCheckRuleResultsPaginator