Comprehend / Client / describe_endpoint

describe_endpoint#

Comprehend.Client.describe_endpoint(**kwargs)#

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoint(
    EndpointArn='string'
)
Parameters:

EndpointArn (string) –

[REQUIRED]

The Amazon Resource Number (ARN) of the endpoint being described.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointProperties': {
        'EndpointArn': 'string',
        'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
        'Message': 'string',
        'ModelArn': 'string',
        'DesiredModelArn': 'string',
        'DesiredInferenceUnits': 123,
        'CurrentInferenceUnits': 123,
        'CreationTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'DataAccessRoleArn': 'string',
        'DesiredDataAccessRoleArn': 'string',
        'FlywheelArn': 'string'
    }
}

Response Structure

  • (dict) –

    • EndpointProperties (dict) –

      Describes information associated with the specific endpoint.

      • EndpointArn (string) –

        The Amazon Resource Number (ARN) of the endpoint.

      • Status (string) –

        Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

      • Message (string) –

        Specifies a reason for failure in cases of Failed status.

      • ModelArn (string) –

        The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

      • DesiredModelArn (string) –

        ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

      • DesiredInferenceUnits (integer) –

        The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

      • CurrentInferenceUnits (integer) –

        The number of inference units currently used by the model using this endpoint.

      • CreationTime (datetime) –

        The creation date and time of the endpoint.

      • LastModifiedTime (datetime) –

        The date and time that the endpoint was last modified.

      • DataAccessRoleArn (string) –

        The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

      • DesiredDataAccessRoleArn (string) –

        Data access role ARN to use in case the new model is encrypted with a customer KMS key.

      • FlywheelArn (string) –

        The Amazon Resource Number (ARN) of the flywheel

Exceptions