BedrockAgentCoreControl / Client / list_gateway_targets

list_gateway_targets¶

BedrockAgentCoreControl.Client.list_gateway_targets(**kwargs)¶

Lists all targets for a specific gateway.

Request Syntax

response = client.list_gateway_targets(
    gatewayIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

gatewayIdentifier (string) –
[REQUIRED]

The identifier of the gateway to list targets for.
maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'targetId': 'string',
            'name': 'string',
            'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of gateway target summaries.
  - (dict) –
    
    Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.
    - targetId (string) –
      
      The unique identifier of the target.
    - name (string) –
      
      The name of the target.
    - status (string) –
      
      The current status of the target.
    - description (string) –
      
      The description of the target.
    - createdAt (datetime) –
      
      The timestamp when the target was created.
    - updatedAt (datetime) –
      
      The timestamp when the target was last updated.
- nextToken (string) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException