BedrockAgentCoreControl / Client / get_harness_endpoint

get_harness_endpoint¶

BedrockAgentCoreControl.Client.get_harness_endpoint(**kwargs)¶

Operation to get a single harness endpoint.

Request Syntax

response = client.get_harness_endpoint(
    harnessId='string',
    endpointName='string'
)

Parameters:

harnessId (string) –
[REQUIRED]

The ID of the harness that the endpoint belongs to.
endpointName (string) –
[REQUIRED]

The name of the endpoint to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'endpoint': {
        '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'
    }
}

Response Structure

(dict) –
- endpoint (dict) –
  
  The endpoint resource.
  - 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.

Exceptions

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