Amazonka.Comprehend.Types.EndpointProperties

Documentation

data EndpointProperties

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

See: newEndpointProperties smart constructor.

Constructors

EndpointProperties'

Fields

• creationTime :: Maybe POSIX

  The creation date and time of the endpoint.

• currentInferenceUnits :: Maybe Natural

  The number of inference units currently used by the model using this endpoint.

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

• desiredDataAccessRoleArn :: Maybe Text

  Data access role ARN to use in case the new model is encrypted with a customer KMS key.

• desiredInferenceUnits :: Maybe 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.

• desiredModelArn :: Maybe Text

  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

• endpointArn :: Maybe Text

  The Amazon Resource Number (ARN) of the endpoint.

• lastModifiedTime :: Maybe POSIX

  The date and time that the endpoint was last modified.

• message :: Maybe Text

  Specifies a reason for failure in cases of Failed status.

• modelArn :: Maybe Text

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

• status :: Maybe EndpointStatus

  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.

Instances

FromJSON EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

parseJSON :: Value -> Parser EndpointProperties

parseJSONList :: Value -> Parser [EndpointProperties]

Generic EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Associated Types

type Rep EndpointProperties :: Type -> Type

Methods

from :: EndpointProperties -> Rep EndpointProperties x

to :: Rep EndpointProperties x -> EndpointProperties

Read EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

readsPrec :: Int -> ReadS EndpointProperties

readList :: ReadS [EndpointProperties]

readPrec :: ReadPrec EndpointProperties

readListPrec :: ReadPrec [EndpointProperties]

Show EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

showsPrec :: Int -> EndpointProperties -> ShowS

show :: EndpointProperties -> String

showList :: [EndpointProperties] -> ShowS

NFData EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

rnf :: EndpointProperties -> ()

Eq EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

(==) :: EndpointProperties -> EndpointProperties -> Bool

(/=) :: EndpointProperties -> EndpointProperties -> Bool

Hashable EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

Methods

hashWithSalt :: Int -> EndpointProperties -> Int

hash :: EndpointProperties -> Int

type Rep EndpointProperties

Defined in Amazonka.Comprehend.Types.EndpointProperties

type Rep EndpointProperties = D1 ('MetaData "EndpointProperties" "Amazonka.Comprehend.Types.EndpointProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "EndpointProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "currentInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "desiredDataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "desiredInferenceUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "desiredModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointStatus)))))))

newEndpointProperties :: EndpointProperties

Create a value of EndpointProperties 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:creationTime:EndpointProperties', endpointProperties_creationTime - The creation date and time of the endpoint.

$sel:currentInferenceUnits:EndpointProperties', endpointProperties_currentInferenceUnits - The number of inference units currently used by the model using this endpoint.

$sel:dataAccessRoleArn:EndpointProperties', endpointProperties_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:desiredDataAccessRoleArn:EndpointProperties', endpointProperties_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a customer KMS key.

$sel:desiredInferenceUnits:EndpointProperties', endpointProperties_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.

$sel:desiredModelArn:EndpointProperties', endpointProperties_desiredModelArn - 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

$sel:endpointArn:EndpointProperties', endpointProperties_endpointArn - The Amazon Resource Number (ARN) of the endpoint.

$sel:lastModifiedTime:EndpointProperties', endpointProperties_lastModifiedTime - The date and time that the endpoint was last modified.

$sel:message:EndpointProperties', endpointProperties_message - Specifies a reason for failure in cases of Failed status.

$sel:modelArn:EndpointProperties', endpointProperties_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

$sel:status:EndpointProperties', endpointProperties_status - 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.

endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime)

The creation date and time of the endpoint.

endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural)

The number of inference units currently used by the model using this endpoint.

endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (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).

endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text)

Data access role ARN to use in case the new model is encrypted with a customer KMS key.

endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe 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.

endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text)

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

endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text)

The Amazon Resource Number (ARN) of the endpoint.

endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime)

The date and time that the endpoint was last modified.

endpointProperties_message :: Lens' EndpointProperties (Maybe Text)

Specifies a reason for failure in cases of Failed status.

endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text)

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

endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus)

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.