Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDatabase

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

Request Syntax


POST /get-database HTTP/1.1
Content-type: application/json

{
   "ApplicationId": "string",
   "ComponentId": "string",
   "DatabaseArn": "string",
   "DatabaseId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ApplicationId

The ID of the application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: [\w\d\.-]+

Required: No

ComponentId

The ID of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\w\d-]+

Required: No

DatabaseArn

The Amazon Resource Name (ARN) of the database.

Type: String

Pattern: arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\/.+

Required: No

DatabaseId

The ID of the database.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: .*[\w\d]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Database": { 
      "ApplicationId": "string",
      "Arn": "string",
      "ComponentId": "string",
      "ConnectedComponentArns": [ "string" ],
      "Credentials": [ 
         { 
            "CredentialType": "string",
            "DatabaseName": "string",
            "SecretId": "string"
         }
      ],
      "DatabaseId": "string",
      "DatabaseName": "string",
      "DatabaseType": "string",
      "LastUpdated": number,
      "PrimaryHost": "string",
      "SQLPort": number,
      "Status": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Database

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

Type: Database object

Tags

The tags of a database.

Type: String to string map

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ValidationException

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

HTTP Status Code: 400