1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. comprehend
  6. EntityRecognizerEndpoint

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.82.0
published on Monday, Oct 5, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.82.0
published on Monday, Oct 5, 2026 by Pulumi

    An Amazon Comprehend endpoint that hosts a custom entity recognizer model for real-time inference.

    Create EntityRecognizerEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EntityRecognizerEndpoint(name: string, args: EntityRecognizerEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def EntityRecognizerEndpoint(resource_name: str,
                                 args: EntityRecognizerEndpointArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntityRecognizerEndpoint(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 desired_inference_units: Optional[int] = None,
                                 data_access_role_arn: Optional[str] = None,
                                 endpoint_name: Optional[str] = None,
                                 flywheel_arn: Optional[str] = None,
                                 model_arn: Optional[str] = None,
                                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewEntityRecognizerEndpoint(ctx *Context, name string, args EntityRecognizerEndpointArgs, opts ...ResourceOption) (*EntityRecognizerEndpoint, error)
    public EntityRecognizerEndpoint(string name, EntityRecognizerEndpointArgs args, CustomResourceOptions? opts = null)
    public EntityRecognizerEndpoint(String name, EntityRecognizerEndpointArgs args)
    public EntityRecognizerEndpoint(String name, EntityRecognizerEndpointArgs args, CustomResourceOptions options)
    
    type: aws-native:comprehend:EntityRecognizerEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_comprehend_entity_recognizer_endpoint" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EntityRecognizerEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntityRecognizerEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntityRecognizerEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityRecognizerEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityRecognizerEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EntityRecognizerEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EntityRecognizerEndpoint resource accepts the following input properties:

    DesiredInferenceUnits int
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    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).
    EndpointName string
    The name of the endpoint. The name must be unique within the AWS Region and account.
    FlywheelArn string
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    ModelArn string
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags associated with the endpoint being created.
    DesiredInferenceUnits int
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    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).
    EndpointName string
    The name of the endpoint. The name must be unique within the AWS Region and account.
    FlywheelArn string
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    ModelArn string
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    Tags TagArgs
    Tags associated with the endpoint being created.
    desired_inference_units number
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    data_access_role_arn 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).
    endpoint_name string
    The name of the endpoint. The name must be unique within the AWS Region and account.
    flywheel_arn string
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    model_arn string
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    tags list(object)
    Tags associated with the endpoint being created.
    desiredInferenceUnits Integer
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    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).
    endpointName String
    The name of the endpoint. The name must be unique within the AWS Region and account.
    flywheelArn String
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    modelArn String
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    tags List<Tag>
    Tags associated with the endpoint being created.
    desiredInferenceUnits number
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    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).
    endpointName string
    The name of the endpoint. The name must be unique within the AWS Region and account.
    flywheelArn string
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    modelArn string
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    tags Tag[]
    Tags associated with the endpoint being created.
    desired_inference_units int
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    data_access_role_arn str
    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).
    endpoint_name str
    The name of the endpoint. The name must be unique within the AWS Region and account.
    flywheel_arn str
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    model_arn str
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    tags Sequence[TagArgs]
    Tags associated with the endpoint being created.
    desiredInferenceUnits Number
    The desired number of inference units to be used by the model. Each inference unit represents throughput of 100 characters per second.
    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).
    endpointName String
    The name of the endpoint. The name must be unique within the AWS Region and account.
    flywheelArn String
    The Amazon Resource Name (ARN) of the flywheel to which the endpoint is attached.
    modelArn String
    The Amazon Resource Name (ARN) of the entity recognizer model to which the endpoint is attached.
    tags List<Property Map>
    Tags associated with the endpoint being created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EntityRecognizerEndpoint resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    CreationTime string
    The creation date and time of the endpoint.
    CurrentInferenceUnits int
    The number of inference units currently used by the model using this endpoint.
    EndpointStatus Pulumi.AwsNative.Comprehend.EntityRecognizerEndpointEndpointStatus
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time that the endpoint was last modified.
    Arn string
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    CreationTime string
    The creation date and time of the endpoint.
    CurrentInferenceUnits int
    The number of inference units currently used by the model using this endpoint.
    EndpointStatus EntityRecognizerEndpointEndpointStatus
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time that the endpoint was last modified.
    arn string
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    creation_time string
    The creation date and time of the endpoint.
    current_inference_units number
    The number of inference units currently used by the model using this endpoint.
    endpoint_status "CREATING" | "DELETING" | "FAILED" | "IN_SERVICE" | "UPDATING"
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_time string
    The date and time that the endpoint was last modified.
    arn String
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    creationTime String
    The creation date and time of the endpoint.
    currentInferenceUnits Integer
    The number of inference units currently used by the model using this endpoint.
    endpointStatus EntityRecognizerEndpointEndpointStatus
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time that the endpoint was last modified.
    arn string
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    creationTime string
    The creation date and time of the endpoint.
    currentInferenceUnits number
    The number of inference units currently used by the model using this endpoint.
    endpointStatus EntityRecognizerEndpointEndpointStatus
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The date and time that the endpoint was last modified.
    arn str
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    creation_time str
    The creation date and time of the endpoint.
    current_inference_units int
    The number of inference units currently used by the model using this endpoint.
    endpoint_status EntityRecognizerEndpointEndpointStatus
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    The date and time that the endpoint was last modified.
    arn String
    The Amazon Resource Name (ARN) of the entity recognizer endpoint.
    creationTime String
    The creation date and time of the endpoint.
    currentInferenceUnits Number
    The number of inference units currently used by the model using this endpoint.
    endpointStatus "CREATING" | "DELETING" | "FAILED" | "IN_SERVICE" | "UPDATING"
    The current status of the endpoint. Because the endpoint updates and creation are asynchronous, wait for the endpoint to be IN_SERVICE before making inference requests.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time that the endpoint was last modified.

    Supporting Types

    EntityRecognizerEndpointEndpointStatus, EntityRecognizerEndpointEndpointStatusArgs

    Creating
    CREATING
    Deleting
    DELETING
    Failed
    FAILED
    InService
    IN_SERVICE
    Updating
    UPDATING
    EntityRecognizerEndpointEndpointStatusCreating
    CREATING
    EntityRecognizerEndpointEndpointStatusDeleting
    DELETING
    EntityRecognizerEndpointEndpointStatusFailed
    FAILED
    EntityRecognizerEndpointEndpointStatusInService
    IN_SERVICE
    EntityRecognizerEndpointEndpointStatusUpdating
    UPDATING
    "CREATING"
    CREATING
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "IN_SERVICE"
    IN_SERVICE
    "UPDATING"
    UPDATING
    Creating
    CREATING
    Deleting
    DELETING
    Failed
    FAILED
    InService
    IN_SERVICE
    Updating
    UPDATING
    Creating
    CREATING
    Deleting
    DELETING
    Failed
    FAILED
    InService
    IN_SERVICE
    Updating
    UPDATING
    CREATING
    CREATING
    DELETING
    DELETING
    FAILED
    FAILED
    IN_SERVICE
    IN_SERVICE
    UPDATING
    UPDATING
    "CREATING"
    CREATING
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "IN_SERVICE"
    IN_SERVICE
    "UPDATING"
    UPDATING

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.82.0
    published on Monday, Oct 5, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial