AWS Systems Manager for SAP

2023/01/24 - AWS Systems Manager for SAP - 1 new 1 updated api methods

Changes  This release provides updates to documentation and support for listing operations performed by AWS Systems Manager for SAP.

ListOperations (new) Link ¶

Lists the operations performed by AWS Systems Manager for SAP.

See also: AWS API Documentation

Request Syntax

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

string

param ApplicationId

[REQUIRED]

The ID of the application.

type MaxResults

integer

param MaxResults

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.

type NextToken

string

param NextToken

The token for the next page of results.

type Filters

list

param Filters

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.

rtype

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.

GetApplication (updated) Link ¶
Changes (request)
{'AppRegistryArn': 'string'}

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

client.get_application(
    ApplicationId='string',
    ApplicationArn='string',
    AppRegistryArn='string'
)
type ApplicationId

string

param ApplicationId

The ID of the application.

type ApplicationArn

string

param ApplicationArn

The Amazon Resource Name (ARN) of the application.

type AppRegistryArn

string

param AppRegistryArn

The Amazon Resource Name (ARN) of the application registry.

rtype

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) --