Skip to content

CreateEndpointRequest

Source code in docs_src/capo_comprehend/types/create_endpoint_request.py
class CreateEndpointRequest(TypedDict, closed=True):
    endpoint_name: (
        "capo_comprehend.types.comprehend_endpoint_name.ComprehendEndpointName"
    )
    """<p>This is the descriptive suffix that becomes part of the <code>EndpointArn</code> used for all subsequent requests to this resource. </p>"""
    model_arn: NotRequired[
        "capo_comprehend.types.comprehend_model_arn.ComprehendModelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.</p>"""
    desired_inference_units: (
        "capo_comprehend.types.inference_units_integer.InferenceUnitsInteger"
    )
    """<p> 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.</p>"""
    client_request_token: NotRequired[
        "capo_comprehend.types.client_request_token_string.ClientRequestTokenString"
    ]
    """<p>An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a <code>ResourceInUseException</code>. </p>"""
    tags: NotRequired["capo_comprehend.types.tag_list.TagList"]
    """<p>Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department. </p>"""
    data_access_role_arn: NotRequired["capo_comprehend.types.iam_role_arn.IamRoleArn"]
    """<p>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).</p>"""
    flywheel_arn: NotRequired[
        "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestTokenString]

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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

desired_inference_units instance-attribute

desired_inference_units: InferenceUnitsInteger

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.

endpoint_name instance-attribute

endpoint_name: ComprehendEndpointName

This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

flywheel_arn instance-attribute

flywheel_arn: NotRequired[ComprehendFlywheelArn]

The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.

model_arn instance-attribute

model_arn: NotRequired[ComprehendModelArn]

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

tags instance-attribute

tags: NotRequired[TagList]

Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.