SsmSap / Client / list_components

list_components#

SsmSap.Client.list_components(**kwargs)#

Lists all the components registered with AWS Systems Manager for SAP.

Request Syntax

response = client.list_components(
    ApplicationId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

ApplicationId (string) – The ID of the application.
NextToken (string) – The token for the next page of results.
MaxResults (integer) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'Components': [
        {
            'ApplicationId': 'string',
            'ComponentId': 'string',
            'ComponentType': 'HANA'|'HANA_NODE'|'ABAP'|'ASCS'|'DIALOG'|'WEBDISP'|'WD'|'ERS',
            'Tags': {
                'string': 'string'
            },
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Components (list) –
  
  List of components registered with AWS System Manager for SAP.
  - (dict) –
    
    The summary of the component.
    - ApplicationId (string) –
      
      The ID of the application.
    - ComponentId (string) –
      
      The ID of the component.
    - ComponentType (string) –
      
      The type of the component.
    - Tags (dict) –
      
      The tags of the component.
      - (string) –
        
        (string) –
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the component summary.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

SsmSap.Client.exceptions.UnauthorizedException
SsmSap.Client.exceptions.ResourceNotFoundException
SsmSap.Client.exceptions.ValidationException
SsmSap.Client.exceptions.InternalServerException