Table of Contents
SsmSap.
Client
¶A low-level client representing AWS Systems Manager for SAP (SsmSap)
import boto3
client = boto3.client('ssmsap')
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)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
deregister_application
(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.deregister_application(
ApplicationId='string'
)
{}
Response Structure
Exceptions
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_application
(**kwargs)¶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.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_component
(**kwargs)¶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.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_database
(**kwargs)¶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.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_operation
(**kwargs)¶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.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_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)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_applications
(**kwargs)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
list_components
(**kwargs)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
list_databases
(**kwargs)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
{
'tags': {
'string': 'string'
}
}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.ConflictException
put_resource_permission
(**kwargs)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
register_application
(**kwargs)¶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.ValidationException
SsmSap.Client.exceptions.ConflictException
SsmSap.Client.exceptions.InternalServerException
tag_resource
(**kwargs)¶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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.ConflictException
untag_resource
(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
dict
Response Syntax
{}
Response Structure
Exceptions
SsmSap.Client.exceptions.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.ConflictException
update_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.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException
The 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