Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Comprehend.CreateEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.

Synopsis

data CreateEndpoint = CreateEndpoint' {
- clientRequestToken :: Maybe Text
- dataAccessRoleArn :: Maybe Text
- tags :: Maybe [Tag]
- endpointName :: Text
- modelArn :: Text
- desiredInferenceUnits :: Natural
}
newCreateEndpoint :: Text -> Text -> Natural -> CreateEndpoint
createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text)
createEndpoint_dataAccessRoleArn :: 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

clientRequestToken :: Maybe Text
An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
dataAccessRoleArn :: Maybe Text
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).
tags :: Maybe [Tag]
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.
endpointName :: Text
This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
modelArn :: Text
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
desiredInferenceUnits :: Natural
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.

Instances

Instances details

ToJSON CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods toJSON :: CreateEndpoint -> Value # toEncoding :: CreateEndpoint -> Encoding # toJSONList :: [CreateEndpoint] -> Value # toEncodingList :: [CreateEndpoint] -> Encoding #
ToHeaders CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods toHeaders :: CreateEndpoint -> [Header] #
ToPath CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods toPath :: CreateEndpoint -> ByteString #
ToQuery CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods toQuery :: CreateEndpoint -> QueryString #
AWSRequest CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Associated Types type AWSResponse CreateEndpoint # Methods request :: (Service -> Service) -> CreateEndpoint -> Request CreateEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEndpoint))) #
Generic CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Associated Types type Rep CreateEndpoint :: Type -> Type # Methods from :: CreateEndpoint -> Rep CreateEndpoint x # to :: Rep CreateEndpoint x -> CreateEndpoint #
Read CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpoint # readList :: ReadS [CreateEndpoint] # readPrec :: ReadPrec CreateEndpoint # readListPrec :: ReadPrec [CreateEndpoint] #
Show CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods showsPrec :: Int -> CreateEndpoint -> ShowS # show :: CreateEndpoint -> String # showList :: [CreateEndpoint] -> ShowS #
NFData CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods rnf :: CreateEndpoint -> () #
Eq CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods (==) :: CreateEndpoint -> CreateEndpoint -> Bool # (/=) :: CreateEndpoint -> CreateEndpoint -> Bool #
Hashable CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods hashWithSalt :: Int -> CreateEndpoint -> Int # hash :: CreateEndpoint -> Int #
type AWSResponse CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint type AWSResponse CreateEndpoint = CreateEndpointResponse
type Rep CreateEndpoint Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.Comprehend.CreateEndpoint" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "CreateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "desiredInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newCreateEndpoint Source #

Arguments

:: Text	`$sel:endpointName:CreateEndpoint'`
-> Text	`CreateEndpoint`
-> Natural	`CreateEndpoint`
-> 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: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.

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

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

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_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_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_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 endpointArn :: Maybe Text The Amazon Resource Number (ARN) of the endpoint being created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Associated Types type Rep CreateEndpointResponse :: Type -> Type # Methods from :: CreateEndpointResponse -> Rep CreateEndpointResponse x # to :: Rep CreateEndpointResponse x -> CreateEndpointResponse #
Read CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpointResponse # readList :: ReadS [CreateEndpointResponse] # readPrec :: ReadPrec CreateEndpointResponse # readListPrec :: ReadPrec [CreateEndpointResponse] #
Show CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods showsPrec :: Int -> CreateEndpointResponse -> ShowS # show :: CreateEndpointResponse -> String # showList :: [CreateEndpointResponse] -> ShowS #
NFData CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods rnf :: CreateEndpointResponse -> () #
Eq CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint Methods (==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool # (/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool #
type Rep CreateEndpointResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEndpoint type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.Comprehend.CreateEndpoint" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "CreateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEndpointResponse'`
-> CreateEndpointResponse

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:

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.