BedrockAgentCoreControl / Paginator / ListHarnessEndpoints

ListHarnessEndpoints

class BedrockAgentCoreControl.Paginator.ListHarnessEndpoints

paginator = client.get_paginator('list_harness_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_harness_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    harnessId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• harnessId (string) –

  [REQUIRED]

  The ID of the harness whose endpoints are listed.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.