| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Comprehend.CreateEndpoint
Description
Creates a model-specific endpoint for synchronous inference for a previously trained custom model
Synopsis
- data CreateEndpoint = CreateEndpoint' {}
- newCreateEndpoint :: Text -> Text -> Natural -> CreateEndpoint
- createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (Maybe Text)
- createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text)
- createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag])
- createEndpoint_endpointName :: Lens' CreateEndpoint Text
- createEndpoint_modelArn :: Lens' CreateEndpoint Text
- createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint Natural
- data CreateEndpointResponse = CreateEndpointResponse' {
- endpointArn :: Maybe Text
- httpStatus :: Int
- newCreateEndpointResponse :: Int -> CreateEndpointResponse
- createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text)
- createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int
Creating a Request
data CreateEndpoint Source #
See: newCreateEndpoint smart constructor.
Constructors
| CreateEndpoint' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Natural | |
| -> CreateEndpoint |
Create a value of CreateEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataAccessRoleArn:CreateEndpoint', createEndpoint_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to trained custom
models encrypted with a customer managed key (ModelKmsKeyId).
$sel:clientRequestToken:CreateEndpoint', createEndpoint_clientRequestToken - An idempotency token provided by the customer. If this token matches a
previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException.
$sel:tags:CreateEndpoint', createEndpoint_tags - Tags associated with the endpoint being created. 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.
$sel:endpointName:CreateEndpoint', createEndpoint_endpointName - This is the descriptive suffix that becomes part of the EndpointArn
used for all subsequent requests to this resource.
$sel:modelArn:CreateEndpoint', createEndpoint_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint will
be attached.
$sel:desiredInferenceUnits:CreateEndpoint', createEndpoint_desiredInferenceUnits - 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.
Request Lenses
createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text) Source #
An idempotency token provided by the customer. If this token matches a
previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException.
createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) Source #
Tags associated with the endpoint being created. 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.
createEndpoint_endpointName :: Lens' CreateEndpoint Text Source #
This is the descriptive suffix that becomes part of the EndpointArn
used for all subsequent requests to this resource.
createEndpoint_modelArn :: Lens' CreateEndpoint Text Source #
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint Natural Source #
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.
Destructuring the Response
data CreateEndpointResponse Source #
See: newCreateEndpointResponse smart constructor.
Constructors
| CreateEndpointResponse' | |
Fields
| |
Instances
newCreateEndpointResponse Source #
Create a value of CreateEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointArn:CreateEndpointResponse', createEndpointResponse_endpointArn - The Amazon Resource Number (ARN) of the endpoint being created.
$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.
Response Lenses
createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text) Source #
The Amazon Resource Number (ARN) of the endpoint being created.
createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #
The response's http status code.