SsmSap

Client

class 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.

client = session.create_client('ssm-sap')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
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'
)
Parameters
  • ActionType (string) -- Delete or restore the permissions on the target database.
  • SourceResourceArn (string) -- The Amazon Resource Name (ARN) of the source resource.
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) --

    • Policy (string) --

      The policy that removes permissions on the target database.

Exceptions

deregister_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'
)
Parameters
ApplicationId (string) --

[REQUIRED]

The ID of the application.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_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',
    AppRegistryArn='string'
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • ApplicationArn (string) -- The Amazon Resource Name (ARN) of the application.
  • AppRegistryArn (string) -- The Amazon Resource Name (ARN) of the application registry.
Return type

dict

Returns

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

  • (dict) --

    • Application (dict) --

      Returns all of the metadata of an application registered with AWS Systems Manager for SAP.

      • Id (string) --

        The ID of the application.

      • Type (string) --

        The type of the application.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the application.

      • AppRegistryArn (string) --

        The Amazon Resource Name (ARN) of the Application Registry.

      • Status (string) --

        The status of the application.

      • Components (list) --

        The components of the application.

        • (string) --
      • LastUpdated (datetime) --

        The time at which the application was last updated.

      • StatusMessage (string) --

        The status message.

    • Tags (dict) --

      The tags of a registered application.

      • (string) --
        • (string) --

Exceptions

get_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'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The ID of the application.

  • ComponentId (string) --

    [REQUIRED]

    The ID of the component.

Return type

dict

Returns

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

  • (dict) --

    • Component (dict) --

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

      • ComponentId (string) --

        The ID of the component.

      • ApplicationId (string) --

        The ID of the application.

      • ComponentType (string) --

        The type of the component.

      • Status (string) --

        The status of the component.

      • Databases (list) --

        The SAP HANA databases of the component.

        • (string) --
      • Hosts (list) --

        The hosts of the component.

        • (dict) --

          Describes the properties of the Dedicated Host.

          • HostName (string) --

            The name of the Dedicated Host.

          • HostRole (string) --

            The role of the Dedicated Host.

          • HostIp (string) --

            The IP address of the Dedicated Host.

          • InstanceId (string) --

            The instance ID of the instance on the Dedicated Host.

      • PrimaryHost (string) --

        The primary host of the component.

      • LastUpdated (datetime) --

        The time at which the component was last updated.

Exceptions

get_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'
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • ComponentId (string) -- The ID of the component.
  • DatabaseId (string) -- The ID of the database.
  • DatabaseArn (string) -- The Amazon Resource Name (ARN) of the database.
Return type

dict

Returns

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

  • (dict) --

    • Database (dict) --

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

      • ApplicationId (string) --

        The ID of the application.

      • ComponentId (string) --

        The ID of the component.

      • Credentials (list) --

        The credentials of the database.

        • (dict) --

          The credentials of your SAP application.

          • DatabaseName (string) --

            The name of the SAP HANA database.

          • CredentialType (string) --

            The type of the application credentials.

          • SecretId (string) --

            The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

      • DatabaseId (string) --

        The ID of the SAP HANA database.

      • DatabaseName (string) --

        The name of the database.

      • DatabaseType (string) --

        The type of the database.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the database.

      • Status (string) --

        The status of the database.

      • PrimaryHost (string) --

        The primary host of the database.

      • SQLPort (integer) --

        The SQL port of the database.

      • LastUpdated (datetime) --

        The time at which the database was last updated.

    • Tags (dict) --

      The tags of a database.

      • (string) --
        • (string) --

Exceptions

get_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'
)
Parameters
OperationId (string) --

[REQUIRED]

The ID of the operation.

Return type
dict
Returns
Response Syntax
{
    '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

  • (dict) --
    • Operation (dict) --

      Returns the details of an operation.

      • Id (string) --

        The ID of the operation.

      • Type (string) --

        The type of the operation.

      • Status (string) --

        The status of the operation.

      • StatusMessage (string) --

        The status message of the operation.

      • Properties (dict) --

        The properties of the operation.

        • (string) --
          • (string) --
      • ResourceType (string) --

        The resource type of the operation.

      • ResourceId (string) --

        The resource ID of the operation.

      • ResourceArn (string) --

        The Amazon Resource Name (ARN) of the operation.

      • StartTime (datetime) --

        The start time of the operation.

      • EndTime (datetime) --

        The end time of the operation.

      • LastUpdatedTime (datetime) --

        The time at which the operation was last updated.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
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'
)
Parameters
  • ActionType (string) --
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) --
    • Policy (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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
)
Parameters
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Return type

dict

Returns

Response Syntax

{
    'Applications': [
        {
            'Id': 'string',
            'Type': 'HANA',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Applications (list) --

      The applications registered with AWS Systems Manager for SAP.

      • (dict) --

        The summary of the SAP application registered with AWS Systems Manager for SAP.

        • Id (string) --

          The ID of the application.

        • Type (string) --

          The type of the application.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the application.

        • Tags (dict) --

          The tags on the application.

          • (string) --
            • (string) --
    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_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
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) --

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If you do not specify a value for MaxResults, the request returns 50 items per page by default.

Return type

dict

Returns

Response Syntax

{
    'Components': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'ComponentType': 'HANA',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Components (list) --

      List of components registered with AWS System Manager for SAP.

      • (dict) --

        The summary of the component.

        • ApplicationId (string) --

          The ID of the application.

        • ComponentId (string) --

          The ID of the component.

        • ComponentType (string) --

          The type of the component.

        • Tags (dict) --

          The tags of the component.

          • (string) --
            • (string) --
    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_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
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • ComponentId (string) -- The ID of the component.
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.
Return type

dict

Returns

Response Syntax

{
    'Databases': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'DatabaseId': 'string',
            'DatabaseType': 'SYSTEM'|'TENANT',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Databases (list) --

      The SAP HANA databases of an application.

      • (dict) --

        The summary of the database.

        • ApplicationId (string) --

          The ID of the application.

        • ComponentId (string) --

          The ID of the component.

        • DatabaseId (string) --

          The ID of the database.

        • DatabaseType (string) --

          The type of the database.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the database.

        • Tags (dict) --

          The tags of the database.

          • (string) --
            • (string) --
    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_operations(**kwargs)

Lists the operations performed by AWS Systems Manager for SAP.

See also: AWS API Documentation

Request Syntax

response = client.list_operations(
    ApplicationId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Value': 'string',
            'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
        },
    ]
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The ID of the application.

  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.
  • NextToken (string) -- The token for the next page of results.
  • Filters (list) --

    The filters of an operation.

    • (dict) --

      A specific result obtained by specifying the name, value, and operator.

      • Name (string) -- [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Value (string) -- [REQUIRED]

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator (string) -- [REQUIRED]

        The operator for the filter.

Return type

dict

Returns

Response Syntax

{
    'Operations': [
        {
            '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Operations (list) --

      List of operations performed by AWS Systems Manager for SAP.

      • (dict) --

        The operations performed by AWS Systems Manager for SAP.

        • Id (string) --

          The ID of the operation.

        • Type (string) --

          The type of the operation.

        • Status (string) --

          The status of the operation.

        • StatusMessage (string) --

          The status message of the operation.

        • Properties (dict) --

          The properties of the operation.

          • (string) --
            • (string) --
        • ResourceType (string) --

          The resource type of the operation.

        • ResourceId (string) --

          The resource ID of the operation.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the operation.

        • StartTime (datetime) --

          The start time of the operation.

        • EndTime (datetime) --

          The end time of the operation.

        • LastUpdatedTime (datetime) --

          The time at which the operation was last updated.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_tags_for_resource(**kwargs)

Lists 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'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --
      • (string) --
        • (string) --

Exceptions

put_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'
)
Parameters
  • ActionType (string) -- [REQUIRED]
  • SourceResourceArn (string) -- [REQUIRED]
  • ResourceArn (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) --
    • Policy (string) --

Exceptions

register_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'
        },
    ]
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The ID of the application.

  • ApplicationType (string) --

    [REQUIRED]

    The type of the application.

  • Instances (list) --

    [REQUIRED]

    The Amazon EC2 instances on which your SAP application is running.

    • (string) --
  • SapInstanceNumber (string) -- The SAP instance number of the application.
  • Sid (string) -- The System ID of the application.
  • Tags (dict) --

    The tags to be attached to the SAP application.

    • (string) --
      • (string) --
  • Credentials (list) --

    [REQUIRED]

    The credentials of the SAP application.

    • (dict) --

      The credentials of your SAP application.

      • DatabaseName (string) -- [REQUIRED]

        The name of the SAP HANA database.

      • CredentialType (string) -- [REQUIRED]

        The type of the application credentials.

      • SecretId (string) -- [REQUIRED]

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

Return type

dict

Returns

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

  • (dict) --

    • Application (dict) --

      The application registered with AWS Systems Manager for SAP.

      • Id (string) --

        The ID of the application.

      • Type (string) --

        The type of the application.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the application.

      • AppRegistryArn (string) --

        The Amazon Resource Name (ARN) of the Application Registry.

      • Status (string) --

        The status of the application.

      • Components (list) --

        The components of the application.

        • (string) --
      • LastUpdated (datetime) --

        The time at which the application was last updated.

      • StatusMessage (string) --

        The status message.

    • OperationId (string) --

      The ID of the operation.

Exceptions

tag_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'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tags (dict) --

    [REQUIRED]

    The tags on a resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Delete the tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • tagKeys (list) --

    [REQUIRED]

    Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_application_settings(**kwargs)

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

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'
        },
    ]
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The ID of the application.

  • CredentialsToAddOrUpdate (list) --

    The credentials to be added or updated.

    • (dict) --

      The credentials of your SAP application.

      • DatabaseName (string) -- [REQUIRED]

        The name of the SAP HANA database.

      • CredentialType (string) -- [REQUIRED]

        The type of the application credentials.

      • SecretId (string) -- [REQUIRED]

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

  • CredentialsToRemove (list) --

    The credentials to be removed.

    • (dict) --

      The credentials of your SAP application.

      • DatabaseName (string) -- [REQUIRED]

        The name of the SAP HANA database.

      • CredentialType (string) -- [REQUIRED]

        The type of the application credentials.

      • SecretId (string) -- [REQUIRED]

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

Return type

dict

Returns

Response Syntax

{
    'Message': 'string',
    'OperationIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Message (string) --

      The update message.

    • OperationIds (list) --

      The IDs of the operations.

      • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class SsmSap.Client.exceptions.ConflictException

A conflict has occurred.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A conflict has occurred.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SsmSap.Client.exceptions.InternalServerException

An internal error has occurred.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An internal error has occurred.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SsmSap.Client.exceptions.ResourceNotFoundException

The resource is not available.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource is not available.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SsmSap.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by an AWS service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by an AWS service.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class 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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Applications': [
        {
            'Id': 'string',
            'Type': 'HANA',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --
    • Applications (list) --

      The applications registered with AWS Systems Manager for SAP.

      • (dict) --

        The summary of the SAP application registered with AWS Systems Manager for SAP.

        • Id (string) --

          The ID of the application.

        • Type (string) --

          The type of the application.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the application.

        • Tags (dict) --

          The tags on the application.

          • (string) --
            • (string) --
class 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'
    }
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Components': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'ComponentType': 'HANA',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    • Components (list) --

      List of components registered with AWS System Manager for SAP.

      • (dict) --

        The summary of the component.

        • ApplicationId (string) --

          The ID of the application.

        • ComponentId (string) --

          The ID of the component.

        • ComponentType (string) --

          The type of the component.

        • Tags (dict) --

          The tags of the component.

          • (string) --
            • (string) --

class 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'
    }
)
Parameters
  • ApplicationId (string) -- The ID of the application.
  • ComponentId (string) -- The ID of the component.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Databases': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'DatabaseId': 'string',
            'DatabaseType': 'SYSTEM'|'TENANT',
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    • Databases (list) --

      The SAP HANA databases of an application.

      • (dict) --

        The summary of the database.

        • ApplicationId (string) --

          The ID of the application.

        • ComponentId (string) --

          The ID of the component.

        • DatabaseId (string) --

          The ID of the database.

        • DatabaseType (string) --

          The type of the database.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the database.

        • Tags (dict) --

          The tags of the database.

          • (string) --
            • (string) --

class SsmSap.Paginator.ListOperations
paginator = client.get_paginator('list_operations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SsmSap.Client.list_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationId='string',
    Filters=[
        {
            'Name': 'string',
            'Value': 'string',
            'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

    The ID of the application.

  • Filters (list) --

    The filters of an operation.

    • (dict) --

      A specific result obtained by specifying the name, value, and operator.

      • Name (string) -- [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Value (string) -- [REQUIRED]

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator (string) -- [REQUIRED]

        The operator for the filter.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Operations': [
        {
            '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

  • (dict) --

    • Operations (list) --

      List of operations performed by AWS Systems Manager for SAP.

      • (dict) --

        The operations performed by AWS Systems Manager for SAP.

        • Id (string) --

          The ID of the operation.

        • Type (string) --

          The type of the operation.

        • Status (string) --

          The status of the operation.

        • StatusMessage (string) --

          The status message of the operation.

        • Properties (dict) --

          The properties of the operation.

          • (string) --
            • (string) --
        • ResourceType (string) --

          The resource type of the operation.

        • ResourceId (string) --

          The resource ID of the operation.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the operation.

        • StartTime (datetime) --

          The start time of the operation.

        • EndTime (datetime) --

          The end time of the operation.

        • LastUpdatedTime (datetime) --

          The time at which the operation was last updated.