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. 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_operation_events * list_operations * list_tags_for_resource * put_resource_permission * register_application * start_application * start_application_refresh * stop_application * tag_resource * untag_resource * update_application_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications * ListComponents * ListDatabases * ListOperationEvents * ListOperations SsmSap / Paginator / ListOperations ListOperations ************** 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. SsmSap / Paginator / ListComponents ListComponents ************** 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'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS', 'Tags': { 'string': 'string' }, 'Arn': '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) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component summary. SsmSap / Paginator / ListOperationEvents ListOperationEvents ******************* class SsmSap.Paginator.ListOperationEvents paginator = client.get_paginator('list_operation_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "SsmSap.Client.list_operation_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( OperationId='string', Filters=[ { 'Name': 'string', 'Value': 'string', 'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **OperationId** (*string*) -- **[REQUIRED]** The ID of the operation. * **Filters** (*list*) -- Optionally specify filters to narrow the returned operation event items. Valid filter names include "status", "resourceID", and "resourceType". The valid operator for all three filters is "Equals". * *(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** { 'OperationEvents': [ { 'Description': 'string', 'Resource': { 'ResourceArn': 'string', 'ResourceType': 'string' }, 'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED', 'StatusMessage': 'string', 'Timestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **OperationEvents** *(list) --* A returned list of operation events that meet the filter criteria. * *(dict) --* An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress. Operation events contain: * Description string * Resource, including its ARN and type * Status * StatusMessage string * TimeStamp Operation event examples include StartApplication or StopApplication. * **Description** *(string) --* A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321". * **Resource** *(dict) --* The resource involved in the operations event. Contains "ResourceArn" ARN and "ResourceType". * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) of the source resource. Example of "ResourceArn": " "arn:aws:ec2:us- east-1:111111111111:instance/i-abcdefgh987654321"" * **ResourceType** *(string) --* The resource type. Example of "ResourceType": " "AWS::SystemsManagerSAP::Component"" or " "AWS::EC2::Instance"". * **Status** *(string) --* The status of the operation event. The possible statuses are: "IN_PROGRESS", "COMPLETED", and "FAILED". * **StatusMessage** *(string) --* The status message relating to a specific operation event. * **Timestamp** *(datetime) --* The timestamp of the specified operation event. SsmSap / Paginator / ListDatabases ListDatabases ************* 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) --* SsmSap / Paginator / ListApplications ListApplications **************** 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( Filters=[ { 'Name': 'string', 'Value': 'string', 'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- The filter of name, value, and operator. * *(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** { 'Applications': [ { 'Id': 'string', 'DiscoveryStatus': 'SUCCESS'|'REGISTRATION_FAILED'|'REFRESH_FAILED'|'REGISTERING'|'DELETING', 'Type': 'HANA'|'SAP_ABAP', '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. * **DiscoveryStatus** *(string) --* The status of the latest discovery. * **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) --* SsmSap / Client / start_application start_application ***************** SsmSap.Client.start_application(**kwargs) Request is an operation which starts an application. Parameter "ApplicationId" is required. See also: AWS API Documentation **Request Syntax** response = client.start_application( ApplicationId='string' ) Parameters: **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application. Return type: dict Returns: **Response Syntax** { 'OperationId': 'string' } **Response Structure** * *(dict) --* * **OperationId** *(string) --* The ID of the operation. **Exceptions** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / list_applications list_applications ***************** SsmSap.Client.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, Filters=[ { 'Name': 'string', 'Value': 'string', 'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals' }, ] ) 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. * **Filters** (*list*) -- The filter of name, value, and operator. * *(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** { 'Applications': [ { 'Id': 'string', 'DiscoveryStatus': 'SUCCESS'|'REGISTRATION_FAILED'|'REFRESH_FAILED'|'REGISTERING'|'DELETING', 'Type': 'HANA'|'SAP_ABAP', '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. * **DiscoveryStatus** *(string) --* The status of the latest discovery. * **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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_paginator get_paginator ************* SsmSap.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. SsmSap / Client / list_components list_components *************** SsmSap.Client.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'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS', 'Tags': { 'string': 'string' }, 'Arn': '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) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component summary. * **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** * "SsmSap.Client.exceptions.UnauthorizedException" * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_resource_permission get_resource_permission *********************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / can_paginate can_paginate ************ SsmSap.Client.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. SsmSap / Client / list_operations list_operations *************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / update_application_settings update_application_settings *************************** SsmSap.Client.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' }, ], Backint={ 'BackintMode': 'AWSBackup', 'EnsureNoBackupInProcess': True|False }, DatabaseArn='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. * **Backint** (*dict*) -- Installation of AWS Backint Agent for SAP HANA. * **BackintMode** *(string) --* **[REQUIRED]** AWS service for your database backup. * **EnsureNoBackupInProcess** *(boolean) --* **[REQUIRED]** * **DatabaseArn** (*string*) -- The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP 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** * "SsmSap.Client.exceptions.UnauthorizedException" * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / delete_resource_permission delete_resource_permission ************************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / list_operation_events list_operation_events ********************* SsmSap.Client.list_operation_events(**kwargs) Returns a list of operations events. Available parameters include "OperationID", as well as optional parameters "MaxResults", "NextToken", and "Filters". See also: AWS API Documentation **Request Syntax** response = client.list_operation_events( OperationId='string', MaxResults=123, NextToken='string', Filters=[ { 'Name': 'string', 'Value': 'string', 'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals' }, ] ) Parameters: * **OperationId** (*string*) -- **[REQUIRED]** The ID of the operation. * **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 to use to retrieve the next page of results. This value is null when there are no more results to return. * **Filters** (*list*) -- Optionally specify filters to narrow the returned operation event items. Valid filter names include "status", "resourceID", and "resourceType". The valid operator for all three filters is "Equals". * *(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** { 'OperationEvents': [ { 'Description': 'string', 'Resource': { 'ResourceArn': 'string', 'ResourceType': 'string' }, 'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED', 'StatusMessage': 'string', 'Timestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **OperationEvents** *(list) --* A returned list of operation events that meet the filter criteria. * *(dict) --* An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress. Operation events contain: * Description string * Resource, including its ARN and type * Status * StatusMessage string * TimeStamp Operation event examples include StartApplication or StopApplication. * **Description** *(string) --* A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321". * **Resource** *(dict) --* The resource involved in the operations event. Contains "ResourceArn" ARN and "ResourceType". * **ResourceArn** *(string) --* The Amazon Resource Name (ARN) of the source resource. Example of "ResourceArn": " "arn:aws:ec2:us- east-1:111111111111:instance/i-abcdefgh987654321"" * **ResourceType** *(string) --* The resource type. Example of "ResourceType": " "AWS::SystemsManagerSAP::Component"" or " "AWS::EC2::Instance"". * **Status** *(string) --* The status of the operation event. The possible statuses are: "IN_PROGRESS", "COMPLETED", and "FAILED". * **StatusMessage** *(string) --* The status message relating to a specific operation event. * **Timestamp** *(datetime) --* The timestamp of the specified operation event. * **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** * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / deregister_application deregister_application ********************** SsmSap.Client.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** * "SsmSap.Client.exceptions.UnauthorizedException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / start_application_refresh start_application_refresh ************************* SsmSap.Client.start_application_refresh(**kwargs) Refreshes a registered application. See also: AWS API Documentation **Request Syntax** response = client.start_application_refresh( ApplicationId='string' ) Parameters: **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application. Return type: dict Returns: **Response Syntax** { 'OperationId': 'string' } **Response Structure** * *(dict) --* * **OperationId** *(string) --* The ID of the operation. **Exceptions** * "SsmSap.Client.exceptions.UnauthorizedException" * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / list_tags_for_resource list_tags_for_resource ********************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" SsmSap / Client / untag_resource untag_resource ************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" SsmSap / Client / get_waiter get_waiter ********** SsmSap.Client.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" SsmSap / Client / list_databases list_databases ************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / put_resource_permission put_resource_permission *********************** SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_component get_component ************* SsmSap.Client.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', 'Sid': 'string', 'SystemNumber': 'string', 'ParentComponent': 'string', 'ChildComponents': [ 'string', ], 'ApplicationId': 'string', 'ComponentType': 'HANA'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS', 'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'RUNNING'|'RUNNING_WITH_ERROR'|'UNDEFINED', 'SapHostname': 'string', 'SapFeature': 'string', 'SapKernelVersion': 'string', 'HdbVersion': 'string', 'Resilience': { 'HsrTier': 'string', 'HsrReplicationMode': 'PRIMARY'|'NONE'|'SYNC'|'SYNCMEM'|'ASYNC', 'HsrOperationMode': 'PRIMARY'|'LOGREPLAY'|'DELTA_DATASHIPPING'|'LOGREPLAY_READACCESS'|'NONE', 'ClusterStatus': 'ONLINE'|'STANDBY'|'MAINTENANCE'|'OFFLINE'|'NONE', 'EnqueueReplication': True|False }, 'AssociatedHost': { 'Hostname': 'string', 'Ec2InstanceId': 'string', 'IpAddresses': [ { 'IpAddress': 'string', 'Primary': True|False, 'AllocationType': 'VPC_SUBNET'|'ELASTIC_IP'|'OVERLAY'|'UNKNOWN' }, ], 'OsVersion': 'string' }, 'Databases': [ 'string', ], 'Hosts': [ { 'HostName': 'string', 'HostIp': 'string', 'EC2InstanceId': 'string', 'InstanceId': 'string', 'HostRole': 'LEADER'|'WORKER'|'STANDBY'|'UNKNOWN', 'OsVersion': 'string' }, ], 'PrimaryHost': 'string', 'DatabaseConnection': { 'DatabaseConnectionMethod': 'DIRECT'|'OVERLAY', 'DatabaseArn': 'string', 'ConnectionIp': 'string' }, 'LastUpdated': datetime(2015, 1, 1), 'Arn': 'string' }, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Component** *(dict) --* The component of an application registered with AWS Systems Manager for SAP. * **ComponentId** *(string) --* The ID of the component. * **Sid** *(string) --* The SAP System Identifier of the application component. * **SystemNumber** *(string) --* The SAP system number of the application component. * **ParentComponent** *(string) --* The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components. * **ChildComponents** *(list) --* The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances. * *(string) --* * **ApplicationId** *(string) --* The ID of the application. * **ComponentType** *(string) --* The type of the component. * **Status** *(string) --* The status of the component. * ACTIVATED - this status has been deprecated. * STARTING - the component is in the process of being started. * STOPPED - the component is not running. * STOPPING - the component is in the process of being stopped. * RUNNING - the component is running. * RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component. * UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application. * **SapHostname** *(string) --* The hostname of the component. * **SapFeature** *(string) --* The SAP feature of the component. * **SapKernelVersion** *(string) --* The kernel version of the component. * **HdbVersion** *(string) --* The SAP HANA version of the component. * **Resilience** *(dict) --* Details of the SAP HANA system replication for the component. * **HsrTier** *(string) --* The tier of the component. * **HsrReplicationMode** *(string) --* The replication mode of the component. * **HsrOperationMode** *(string) --* The operation mode of the component. * **ClusterStatus** *(string) --* The cluster status of the component. * **EnqueueReplication** *(boolean) --* Indicates if or not enqueue replication is enabled for the ASCS component. * **AssociatedHost** *(dict) --* The associated host of the component. * **Hostname** *(string) --* The name of the host. * **Ec2InstanceId** *(string) --* The ID of the Amazon EC2 instance. * **IpAddresses** *(list) --* The IP addresses of the associated host. * *(dict) --* Provides information of the IP address. * **IpAddress** *(string) --* The IP address. * **Primary** *(boolean) --* The primary IP address. * **AllocationType** *(string) --* The type of allocation for the IP address. * **OsVersion** *(string) --* The version of the operating system. * **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. * **HostIp** *(string) --* The IP address of the Dedicated Host. * **EC2InstanceId** *(string) --* The ID of Amazon EC2 instance. * **InstanceId** *(string) --* The instance ID of the instance on the Dedicated Host. * **HostRole** *(string) --* The role of the Dedicated Host. * **OsVersion** *(string) --* The version of the operating system. * **PrimaryHost** *(string) --* The primary host of the component. * **DatabaseConnection** *(dict) --* The connection specifications for the database of the component. * **DatabaseConnectionMethod** *(string) --* The method of connection. * **DatabaseArn** *(string) --* The Amazon Resource Name of the connected SAP HANA database. * **ConnectionIp** *(string) --* The IP address for connection. * **LastUpdated** *(datetime) --* The time at which the component was last updated. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Tags** *(dict) --* The tags of a component. * *(string) --* * *(string) --* **Exceptions** * "SsmSap.Client.exceptions.UnauthorizedException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / close close ***** SsmSap.Client.close() Closes underlying endpoint connections. SsmSap / Client / stop_application stop_application **************** SsmSap.Client.stop_application(**kwargs) Request is an operation to stop an application. Parameter "ApplicationId" is required. Parameters "StopConnectedEntity" and "IncludeEc2InstanceShutdown" are optional. See also: AWS API Documentation **Request Syntax** response = client.stop_application( ApplicationId='string', StopConnectedEntity='DBMS', IncludeEc2InstanceShutdown=True|False ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The ID of the application. * **StopConnectedEntity** (*string*) -- Specify the "ConnectedEntityType". Accepted type is "DBMS". If this parameter is included, the connected DBMS (Database Management System) will be stopped. * **IncludeEc2InstanceShutdown** (*boolean*) -- Boolean. If included and if set to "True", the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application. Return type: dict Returns: **Response Syntax** { 'OperationId': 'string' } **Response Structure** * *(dict) --* * **OperationId** *(string) --* The ID of the operation. **Exceptions** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_database get_database ************ SsmSap.Client.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'|'ERROR', 'PrimaryHost': 'string', 'SQLPort': 123, 'LastUpdated': datetime(2015, 1, 1), 'ConnectedComponentArns': [ 'string', ] }, '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. * **ConnectedComponentArns** *(list) --* The Amazon Resource Names of the connected AWS Systems Manager for SAP components. * *(string) --* * **Tags** *(dict) --* The tags of a database. * *(string) --* * *(string) --* **Exceptions** * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_operation get_operation ************* SsmSap.Client.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** * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / tag_resource tag_resource ************ SsmSap.Client.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** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" SsmSap / Client / register_application register_application ******************** SsmSap.Client.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'|'SAP_ABAP', Instances=[ 'string', ], SapInstanceNumber='string', Sid='string', Tags={ 'string': 'string' }, Credentials=[ { 'DatabaseName': 'string', 'CredentialType': 'ADMIN', 'SecretId': 'string' }, ], DatabaseArn='string', ComponentsInfo=[ { 'ComponentType': 'HANA'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS', 'Sid': 'string', 'Ec2InstanceId': '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*) -- 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. * **DatabaseArn** (*string*) -- The Amazon Resource Name of the SAP HANA database. * **ComponentsInfo** (*list*) -- This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher. This is an array of ApplicationComponent objects. You may input 0 to 5 items. * *(dict) --* This is information about the component of your SAP application, such as Web Dispatcher. * **ComponentType** *(string) --* **[REQUIRED]** This string is the type of the component. Accepted value is "WD". * **Sid** *(string) --* **[REQUIRED]** This string is the SAP System ID of the component. Accepted values are alphanumeric. * **Ec2InstanceId** *(string) --* **[REQUIRED]** This is the Amazon EC2 instance on which your SAP component is running. Accepted values are alphanumeric. Return type: dict Returns: **Response Syntax** { 'Application': { 'Id': 'string', 'Type': 'HANA'|'SAP_ABAP', 'Arn': 'string', 'AppRegistryArn': 'string', 'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'FAILED'|'REGISTERING'|'DELETING'|'UNKNOWN', 'DiscoveryStatus': 'SUCCESS'|'REGISTRATION_FAILED'|'REFRESH_FAILED'|'REGISTERING'|'DELETING', 'Components': [ 'string', ], 'LastUpdated': datetime(2015, 1, 1), 'StatusMessage': 'string', 'AssociatedApplicationArns': [ '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. * **DiscoveryStatus** *(string) --* The latest discovery result for 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. * **AssociatedApplicationArns** *(list) --* The Amazon Resource Names of the associated AWS Systems Manager for SAP applications. * *(string) --* * **OperationId** *(string) --* The ID of the operation. **Exceptions** * "SsmSap.Client.exceptions.ResourceNotFoundException" * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.ConflictException" * "SsmSap.Client.exceptions.InternalServerException" SsmSap / Client / get_application get_application *************** SsmSap.Client.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'|'SAP_ABAP', 'Arn': 'string', 'AppRegistryArn': 'string', 'Status': 'ACTIVATED'|'STARTING'|'STOPPED'|'STOPPING'|'FAILED'|'REGISTERING'|'DELETING'|'UNKNOWN', 'DiscoveryStatus': 'SUCCESS'|'REGISTRATION_FAILED'|'REFRESH_FAILED'|'REGISTERING'|'DELETING', 'Components': [ 'string', ], 'LastUpdated': datetime(2015, 1, 1), 'StatusMessage': 'string', 'AssociatedApplicationArns': [ '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. * **DiscoveryStatus** *(string) --* The latest discovery result for 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. * **AssociatedApplicationArns** *(list) --* The Amazon Resource Names of the associated AWS Systems Manager for SAP applications. * *(string) --* * **Tags** *(dict) --* The tags of a registered application. * *(string) --* * *(string) --* **Exceptions** * "SsmSap.Client.exceptions.ValidationException" * "SsmSap.Client.exceptions.InternalServerException"