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

ListDatabases

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

Request Syntax


POST /list-databases HTTP/1.1
Content-type: application/json

{
   "ApplicationId": "string",
   "ComponentId": "string",
   "MaxResults": number,
   "NextToken": "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

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: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The token for the next page of results.

Type: String

Pattern: .{16,1024}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Databases": [ 
      { 
         "ApplicationId": "string",
         "Arn": "string",
         "ComponentId": "string",
         "DatabaseId": "string",
         "DatabaseType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "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.

Databases

The SAP HANA databases of an application.

Type: Array of DatabaseSummary objects

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Pattern: .{16,1024}

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

ResourceNotFoundException

The resource is not available.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400