BedrockAgentCoreControl / Client / list_harness_endpoints

list_harness_endpoints¶

BedrockAgentCoreControl.Client.list_harness_endpoints(**kwargs)¶

Operation to list the endpoints of a harness.

Request Syntax

response = client.list_harness_endpoints(
    harnessId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

harnessId (string) –
[REQUIRED]

The ID of the harness whose endpoints are listed.
maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – The token for the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'endpoints': [
        {
            'harnessId': 'string',
            'harnessName': 'string',
            'endpointName': 'string',
            'arn': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'liveVersion': 'string',
            'targetVersion': 'string',
            'description': 'string',
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- endpoints (list) –
  
  The list of harness endpoints.
  - (dict) –
    
    Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.
    - harnessId (string) –
      
      The ID of the harness that the endpoint belongs to.
    - harnessName (string) –
      
      The name of the harness that the endpoint belongs to.
    - endpointName (string) –
      
      The name of the endpoint.
    - arn (string) –
      
      The ARN of the endpoint.
    - status (string) –
      
      The status of the endpoint.
    - createdAt (datetime) –
      
      The timestamp when the endpoint was created.
    - updatedAt (datetime) –
      
      The timestamp when the endpoint was last updated.
    - liveVersion (string) –
      
      The harness version that the endpoint is currently serving.
    - targetVersion (string) –
      
      The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.
    - description (string) –
      
      The description of the endpoint.
    - failureReason (string) –
      
      The reason the endpoint’s last create or update operation failed.
- nextToken (string) –
  
  The token for the next set of results.

Exceptions

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