AWS API Changes

2024/08/19 - AWS Systems Manager for SAP - 3 updated api methods

Changes Add new attributes to the outputs of GetApplication and GetDatabase APIs.

GetApplication (updated)

Link ¶
Changes (response)

{'Application': {'AssociatedApplicationArns': ['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'|'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) --

GetDatabase (updated)

Link ¶
Changes (response)

{'Database': {'ConnectedComponentArns': ['string']}}

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

See also: AWS API Documentation

Request Syntax

client.get_database(
    ApplicationId='string',
    ComponentId='string',
    DatabaseId='string',
    DatabaseArn='string'
)

type ApplicationId

string

param ApplicationId

The ID of the application.

type ComponentId

string

param ComponentId

The ID of the component.

type DatabaseId

string

param DatabaseId

The ID of the database.

type DatabaseArn

string

param DatabaseArn

The Amazon Resource Name (ARN) of the database.

rtype

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

RegisterApplication (updated)

Link ¶
Changes (response)

{'Application': {'AssociatedApplicationArns': ['string']}}

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

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

type ApplicationId

string

param ApplicationId

[REQUIRED]

The ID of the application.

type ApplicationType

string

param ApplicationType

[REQUIRED]

The type of the application.

type Instances

list

param Instances

[REQUIRED]

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

(string) --

type SapInstanceNumber

string

param SapInstanceNumber

The SAP instance number of the application.

type Sid

string

param Sid

The System ID of the application.

type Tags

dict

param Tags

The tags to be attached to the SAP application.

(string) --
- (string) --

type Credentials

list

param Credentials

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.

type DatabaseArn

string

param DatabaseArn

The Amazon Resource Name of the SAP HANA database.

rtype

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.