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

GetComponent

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

Request Syntax


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

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

Pattern: [\w\d]{1,50}

Required: Yes

ComponentId

The ID of the component.

Type: String

Pattern: [\w\d-]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Component": { 
      "ApplicationId": "string",
      "Arn": "string",
      "AssociatedHost": { 
         "Ec2InstanceId": "string",
         "Hostname": "string",
         "IpAddresses": [ 
            { 
               "AllocationType": "string",
               "IpAddress": "string",
               "Primary": boolean
            }
         ],
         "OsVersion": "string"
      },
      "ChildComponents": [ "string" ],
      "ComponentId": "string",
      "ComponentType": "string",
      "DatabaseConnection": { 
         "ConnectionIp": "string",
         "DatabaseArn": "string",
         "DatabaseConnectionMethod": "string"
      },
      "Databases": [ "string" ],
      "HdbVersion": "string",
      "Hosts": [ 
         { 
            "EC2InstanceId": "string",
            "HostIp": "string",
            "HostName": "string",
            "HostRole": "string",
            "InstanceId": "string",
            "OsVersion": "string"
         }
      ],
      "LastUpdated": number,
      "ParentComponent": "string",
      "PrimaryHost": "string",
      "Resilience": { 
         "ClusterStatus": "string",
         "EnqueueReplication": boolean,
         "HsrOperationMode": "string",
         "HsrReplicationMode": "string",
         "HsrTier": "string"
      },
      "SapFeature": "string",
      "SapHostname": "string",
      "SapKernelVersion": "string",
      "Sid": "string",
      "Status": "string",
      "SystemNumber": "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.

Component

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

Type: Component object

Tags

The tags of a component.

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

UnauthorizedException

The request is not authorized.

HTTP Status Code: 401

ValidationException

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

HTTP Status Code: 400