Class: Aws::Comprehend::Types::EndpointProperties

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#creation_timeTime

The creation date and time of the endpoint.

Returns:

  • (Time)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_unitsInteger

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

Returns:

  • (Integer)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_arnString

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

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_arnString

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

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_unitsInteger

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.

Returns:

  • (Integer)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_arnString

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

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_arnString

The Amazon Resource Number (ARN) of the endpoint.

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_timeTime

The date and time that the endpoint was last modified.

Returns:

  • (Time)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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

#messageString

Specifies a reason for failure in cases of Failed status.

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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_arnString

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

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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

#statusString

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.

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2907

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