Table of Contents
SsmSap.Client¶A low-level client representing AWS Systems Manager for SAP (SsmSap)
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.
import boto3
client = boto3.client('ssm-sap')
These are the available methods:
can_paginate()close()delete_resource_permission()deregister_application()get_application()get_component()get_database()get_operation()get_paginator()get_resource_permission()get_waiter()list_applications()list_components()list_databases()list_tags_for_resource()put_resource_permission()register_application()tag_resource()untag_resource()update_application_settings()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_resource_permission(**kwargs)¶Removes permissions associated with the target database.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_permission(
ActionType='RESTORE',
SourceResourceArn='string',
ResourceArn='string'
)
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionderegister_application(**kwargs)¶Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
See also: AWS API Documentation
Request Syntax
response = client.deregister_application(
ApplicationId='string'
)
{}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_application(**kwargs)¶Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
See also: AWS API Documentation
Request Syntax
response = client.get_application(
ApplicationId='string',
ApplicationArn='string'
)
dict
Response Syntax
{
'Application': {
'Id': 'string',
'Type': 'HANA',
'Arn': 'string',
'AppRegistryArn': 'string',
'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'FAILED'|'REGISTERING'|'DELETING'|'UNKNOWN',
'Components': [
'string',
],
'LastUpdated': datetime(2015, 1, 1),
'StatusMessage': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_component(**kwargs)¶Gets the component of an application registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.get_component(
ApplicationId='string',
ComponentId='string'
)
dict
Response Syntax
{
'Component': {
'ComponentId': 'string',
'ApplicationId': 'string',
'ComponentType': 'HANA',
'Status': 'ACTIVATED',
'Databases': [
'string',
],
'Hosts': [
{
'HostName': 'string',
'HostRole': 'LEADER'|'WORKER'|'STANDBY'|'UNKNOWN',
'HostIp': 'string',
'InstanceId': 'string'
},
],
'PrimaryHost': 'string',
'LastUpdated': datetime(2015, 1, 1)
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_database(**kwargs)¶Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.get_database(
ApplicationId='string',
ComponentId='string',
DatabaseId='string',
DatabaseArn='string'
)
dict
Response Syntax
{
'Database': {
'ApplicationId': 'string',
'ComponentId': 'string',
'Credentials': [
{
'DatabaseName': 'string',
'CredentialType': 'ADMIN',
'SecretId': 'string'
},
],
'DatabaseId': 'string',
'DatabaseName': 'string',
'DatabaseType': 'SYSTEM'|'TENANT',
'Arn': 'string',
'Status': 'RUNNING'|'STARTING'|'STOPPED'|'WARNING'|'UNKNOWN',
'PrimaryHost': 'string',
'SQLPort': 123,
'LastUpdated': datetime(2015, 1, 1)
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_operation(**kwargs)¶Gets the details of an operation by specifying the operation ID.
See also: AWS API Documentation
Request Syntax
response = client.get_operation(
OperationId='string'
)
{
'Operation': {
'Id': 'string',
'Type': 'string',
'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
'StatusMessage': 'string',
'Properties': {
'string': 'string'
},
'ResourceType': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_resource_permission(**kwargs)¶Gets permissions associated with the target database.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_permission(
ActionType='RESTORE',
ResourceArn='string'
)
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_applications(**kwargs)¶Lists all the applications registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Applications': [
{
'Id': 'string',
'Type': 'HANA',
'Arn': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionlist_components(**kwargs)¶Lists all the components registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.list_components(
ApplicationId='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Components': [
{
'ApplicationId': 'string',
'ComponentId': 'string',
'ComponentType': 'HANA',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionlist_databases(**kwargs)¶Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.list_databases(
ApplicationId='string',
ComponentId='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Databases': [
{
'ApplicationId': 'string',
'ComponentId': 'string',
'DatabaseId': 'string',
'DatabaseType': 'SYSTEM'|'TENANT',
'Arn': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionLists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
{
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.ConflictExceptionput_resource_permission(**kwargs)¶Adds permissions to the target database.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_permission(
ActionType='RESTORE',
SourceResourceArn='string',
ResourceArn='string'
)
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionregister_application(**kwargs)¶Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
See also: AWS API Documentation
Request Syntax
response = client.register_application(
ApplicationId='string',
ApplicationType='HANA',
Instances=[
'string',
],
SapInstanceNumber='string',
Sid='string',
Tags={
'string': 'string'
},
Credentials=[
{
'DatabaseName': 'string',
'CredentialType': 'ADMIN',
'SecretId': 'string'
},
]
)
[REQUIRED]
[REQUIRED]
dict
Response Syntax
{
'Application': {
'Id': 'string',
'Type': 'HANA',
'Arn': 'string',
'AppRegistryArn': 'string',
'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'FAILED'|'REGISTERING'|'DELETING'|'UNKNOWN',
'Components': [
'string',
],
'LastUpdated': datetime(2015, 1, 1),
'StatusMessage': 'string'
},
'OperationId': 'string'
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.ConflictExceptionSsmSap.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Creates tag for a resource by specifying the ARN.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
dict
Response Syntax
{}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.ConflictExceptionuntag_resource(**kwargs)¶Delete the tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.
dict
Response Syntax
{}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.ConflictExceptionupdate_application_settings(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_application_settings(
ApplicationId='string',
CredentialsToAddOrUpdate=[
{
'DatabaseName': 'string',
'CredentialType': 'ADMIN',
'SecretId': 'string'
},
],
CredentialsToRemove=[
{
'DatabaseName': 'string',
'CredentialType': 'ADMIN',
'SecretId': 'string'
},
]
)
dict
Response Syntax
{
'Message': 'string',
'OperationIds': [
'string',
]
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundExceptionSsmSap.Client.exceptions.ValidationExceptionSsmSap.Client.exceptions.InternalServerExceptionThe available paginators are:
SsmSap.Paginator.ListApplications¶paginator = client.get_paginator('list_applications')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SsmSap.Client.list_applications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Applications': [
{
'Id': 'string',
'Type': 'HANA',
'Arn': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
SsmSap.Paginator.ListComponents¶paginator = client.get_paginator('list_components')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SsmSap.Client.list_components().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApplicationId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Components': [
{
'ApplicationId': 'string',
'ComponentId': 'string',
'ComponentType': 'HANA',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
SsmSap.Paginator.ListDatabases¶paginator = client.get_paginator('list_databases')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SsmSap.Client.list_databases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApplicationId='string',
ComponentId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Databases': [
{
'ApplicationId': 'string',
'ComponentId': 'string',
'DatabaseId': 'string',
'DatabaseType': 'SYSTEM'|'TENANT',
'Arn': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure