SsmSapClient
Auto-generated documentation for SsmSap type annotations stubs module mypy-boto3-ssm-sap.
SsmSapClient
Type annotations and code completion for boto3.client("ssm-sap")
.
boto3 documentation
from boto3.session import Session
from mypy_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.
client = boto3.client("ssm-sap")
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_ssm_sap.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ssm-sap").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ssm-sap").close
method.
boto3 documentation
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
def delete_resource_permission(
self,
*,
ResourceArn: str,
ActionType: PermissionActionTypeType = ..., # (1)
SourceResourceArn: str = ...,
) -> DeleteResourcePermissionOutputTypeDef: # (2)
...
kwargs: DeleteResourcePermissionInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_resource_permission(**kwargs)
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
kwargs: DeregisterApplicationInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.deregister_application(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("ssm-sap").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def get_application(
self,
*,
ApplicationId: str = ...,
ApplicationArn: str = ...,
AppRegistryArn: str = ...,
) -> GetApplicationOutputTypeDef: # (1)
...
kwargs: GetApplicationInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_application(**kwargs)
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
def get_component(
self,
*,
ApplicationId: str,
ComponentId: str,
) -> GetComponentOutputTypeDef: # (1)
...
kwargs: GetComponentInputRequestTypeDef = { # (1)
"ApplicationId": ...,
"ComponentId": ...,
}
parent.get_component(**kwargs)
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
def get_database(
self,
*,
ApplicationId: str = ...,
ComponentId: str = ...,
DatabaseId: str = ...,
DatabaseArn: str = ...,
) -> GetDatabaseOutputTypeDef: # (1)
...
kwargs: GetDatabaseInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_database(**kwargs)
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
def get_operation(
self,
*,
OperationId: str,
) -> GetOperationOutputTypeDef: # (1)
...
kwargs: GetOperationInputRequestTypeDef = { # (1)
"OperationId": ...,
}
parent.get_operation(**kwargs)
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
def get_resource_permission(
self,
*,
ResourceArn: str,
ActionType: PermissionActionTypeType = ..., # (1)
) -> GetResourcePermissionOutputTypeDef: # (2)
...
kwargs: GetResourcePermissionInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_resource_permission(**kwargs)
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
def list_applications(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListApplicationsOutputTypeDef: # (1)
...
kwargs: ListApplicationsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_applications(**kwargs)
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
def list_components(
self,
*,
ApplicationId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListComponentsOutputTypeDef: # (1)
...
kwargs: ListComponentsInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.list_components(**kwargs)
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
def list_databases(
self,
*,
ApplicationId: str = ...,
ComponentId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDatabasesOutputTypeDef: # (1)
...
kwargs: ListDatabasesInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.list_databases(**kwargs)
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
def list_operations(
self,
*,
ApplicationId: str,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListOperationsOutputTypeDef: # (2)
...
kwargs: ListOperationsInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.list_operations(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_resource_permission(
self,
*,
ActionType: PermissionActionTypeType, # (1)
SourceResourceArn: str,
ResourceArn: str,
) -> PutResourcePermissionOutputTypeDef: # (2)
...
kwargs: PutResourcePermissionInputRequestTypeDef = { # (1)
"ActionType": ...,
"SourceResourceArn": ...,
"ResourceArn": ...,
}
parent.put_resource_permission(**kwargs)
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
def register_application(
self,
*,
ApplicationId: str,
ApplicationType: ApplicationTypeType, # (1)
Instances: Sequence[str],
Credentials: Sequence[ApplicationCredentialTypeDef], # (2)
SapInstanceNumber: str = ...,
Sid: str = ...,
Tags: Mapping[str, str] = ...,
) -> RegisterApplicationOutputTypeDef: # (3)
...
kwargs: RegisterApplicationInputRequestTypeDef = { # (1)
"ApplicationId": ...,
"ApplicationType": ...,
"Instances": ...,
"Credentials": ...,
}
parent.register_application(**kwargs)
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
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Delete the tags for a resource.
Type annotations and code completion for boto3.client("ssm-sap").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_application_settings(
self,
*,
ApplicationId: str,
CredentialsToAddOrUpdate: Sequence[ApplicationCredentialTypeDef] = ..., # (1)
CredentialsToRemove: Sequence[ApplicationCredentialTypeDef] = ..., # (1)
) -> UpdateApplicationSettingsOutputTypeDef: # (3)
...
- See ApplicationCredentialTypeDef
- See ApplicationCredentialTypeDef
- See UpdateApplicationSettingsOutputTypeDef
kwargs: UpdateApplicationSettingsInputRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.update_application_settings(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("ssm-sap").get_paginator
method with overloads.
client.get_paginator("list_applications")
-> ListApplicationsPaginatorclient.get_paginator("list_components")
-> ListComponentsPaginatorclient.get_paginator("list_databases")
-> ListDatabasesPaginatorclient.get_paginator("list_operations")
-> ListOperationsPaginator