AWSComprehendEndpointProperties

Objective-C

@interface AWSComprehendEndpointProperties

Swift

class AWSComprehendEndpointProperties

Specifies information about the specified endpoint.

  • The creation date and time of the endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationTime;

    Swift

    var creationTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable currentInferenceUnits;

    Swift

    var currentInferenceUnits: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable desiredDataAccessRoleArn;

    Swift

    var desiredDataAccessRoleArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable desiredInferenceUnits;

    Swift

    var desiredInferenceUnits: NSNumber? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable desiredModelArn;

    Swift

    var desiredModelArn: String? { get set }

  • The Amazon Resource Number (ARN) of the endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable endpointArn;

    Swift

    var endpointArn: String? { get set }

  • The date and time that the endpoint was last modified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastModifiedTime;

    Swift

    var lastModifiedTime: Date? { get set }

  • Specifies a reason for failure in cases of Failed status.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable message;

    Swift

    var message: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable modelArn;

    Swift

    var modelArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendEndpointStatus status;

    Swift

    var status: AWSComprehendEndpointStatus { get set }