Comprehend / Client / list_endpoints

list_endpoints#

Comprehend.Client.list_endpoints(**kwargs)#

Gets a list of all existing endpoints that you’ve created. For information about endpoints, see Managing endpoints.

See also: AWS API Documentation

Request Syntax

response = client.list_endpoints(
    Filter={
        'ModelArn': 'string',
        'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
        'CreationTimeBefore': datetime(2015, 1, 1),
        'CreationTimeAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Filter (dict) –

    Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

    • ModelArn (string) –

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

    • Status (string) –

      Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.

    • CreationTimeBefore (datetime) –

      Specifies a date before which the returned endpoint or endpoints were created.

    • CreationTimeAfter (datetime) –

      Specifies a date after which the returned endpoint or endpoints were created.

  • NextToken (string) – Identifies the next page of results to return.

  • MaxResults (integer) – The maximum number of results to return in each page. The default is 100.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointPropertiesList': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • EndpointPropertiesList (list) –

      Displays a list of endpoint properties being retrieved by the service in response to the request.

      • (dict) –

        Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.

        • 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

    • NextToken (string) –

      Identifies the next page of results to return.

Exceptions