Class: Aws::Comprehend::Types::EndpointProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::EndpointProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
The creation date and time of the endpoint.
-
#current_inference_units ⇒ Integer
The number of inference units currently used by the model using this endpoint.
-
#data_access_role_arn ⇒ String
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).
-
#desired_data_access_role_arn ⇒ String
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
-
#desired_inference_units ⇒ Integer
The desired number of inference units to be used by the model using this endpoint.
-
#desired_model_arn ⇒ String
ARN of the new model to use for updating an existing endpoint.
-
#endpoint_arn ⇒ String
The Amazon Resource Number (ARN) of the endpoint.
-
#last_modified_time ⇒ Time
The date and time that the endpoint was last modified.
-
#message ⇒ String
Specifies a reason for failure in cases of
Failed
status. -
#model_arn ⇒ String
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
-
#status ⇒ String
Specifies the status of the endpoint.
Instance Attribute Details
#creation_time ⇒ Time
The creation date and time of the endpoint.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#current_inference_units ⇒ Integer
The number of inference units currently used by the model using this endpoint.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#data_access_role_arn ⇒ String
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).
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#desired_data_access_role_arn ⇒ String
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#desired_inference_units ⇒ Integer
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.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#desired_model_arn ⇒ String
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
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#endpoint_arn ⇒ String
The Amazon Resource Number (ARN) of the endpoint.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#last_modified_time ⇒ Time
The date and time that the endpoint was last modified.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#message ⇒ String
Specifies a reason for failure in cases of Failed
status.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#model_arn ⇒ String
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
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.
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2941 class EndpointProperties < Struct.new( :endpoint_arn, :status, :message, :model_arn, :desired_model_arn, :desired_inference_units, :current_inference_units, :creation_time, :last_modified_time, :data_access_role_arn, :desired_data_access_role_arn) SENSITIVE = [] include Aws::Structure end |