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