Class: Aws::Bedrock::Types::ModelInvocationJobSummary

Inherits:

Struct

Object
Struct
Aws::Bedrock::Types::ModelInvocationJobSummary

show all

Defined in:: gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb

Overview

A summary of a batch inference job.

Constant Summary collapse

SENSITIVE =

[:message]

Instance Attribute Summary collapse

#client_request_token ⇒ String
A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
#end_time ⇒ Time
The time at which the batch inference job ended.
#error_record_count ⇒ Integer
The number of records that failed to process in the batch inference job.
#input_data_config ⇒ Types::ModelInvocationJobInputDataConfig
Details about the location of the input to the batch inference job.
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the batch inference job.
#job_expiration_time ⇒ Time
The time at which the batch inference job times or timed out.
#job_name ⇒ String
The name of the batch inference job.
#last_modified_time ⇒ Time
The time at which the batch inference job was last modified.
#message ⇒ String
If the batch inference job failed, this field contains a message describing why the job failed.
#model_id ⇒ String
The unique identifier of the foundation model used for model inference.
#model_invocation_type ⇒ String
The invocation endpoint for ModelInvocationJob.
#output_data_config ⇒ Types::ModelInvocationJobOutputDataConfig
Details about the location of the output of the batch inference job.
#processed_record_count ⇒ Integer
The number of records that have been processed in the batch inference job.
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference.
#status ⇒ String
The status of the batch inference job.
#submit_time ⇒ Time
The time at which the batch inference job was submitted.
#success_record_count ⇒ Integer
The number of records that were successfully processed in the batch inference job.
#timeout_duration_in_hours ⇒ Integer
The number of hours after which the batch inference job was set to time out.
#total_record_count ⇒ Integer
The total number of records in the batch inference job.
#vpc_config ⇒ Types::VpcConfig
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job.

Instance Attribute Details

#client_request_token ⇒ `String`

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#end_time ⇒ `Time`

The time at which the batch inference job ended.

Returns:

(Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#error_record_count ⇒ `Integer`

The number of records that failed to process in the batch inference job.

Returns:

(Integer)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#input_data_config ⇒ `Types::ModelInvocationJobInputDataConfig`

Details about the location of the input to the batch inference job.

Returns:

(Types::ModelInvocationJobInputDataConfig)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#job_arn ⇒ `String`

The Amazon Resource Name (ARN) of the batch inference job.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#job_expiration_time ⇒ `Time`

The time at which the batch inference job times or timed out.

Returns:

(Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#job_name ⇒ `String`

The name of the batch inference job.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#last_modified_time ⇒ `Time`

The time at which the batch inference job was last modified.

Returns:

(Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#message ⇒ `String`

If the batch inference job failed, this field contains a message describing why the job failed.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#model_id ⇒ `String`

The unique identifier of the foundation model used for model inference.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#model_invocation_type ⇒ `String`

The invocation endpoint for ModelInvocationJob

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#output_data_config ⇒ `Types::ModelInvocationJobOutputDataConfig`

Details about the location of the output of the batch inference job.

Returns:

(Types::ModelInvocationJobOutputDataConfig)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#processed_record_count ⇒ `Integer`

The number of records that have been processed in the batch inference job.

Returns:

(Integer)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#status ⇒ `String`

The status of the batch inference job.

The following statuses are possible:

Submitted – This job has been submitted to a queue for validation.
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
- Your IAM service role has access to the Amazon S3 buckets containing your files.
- Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.
- Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
InProgress – This job has begun. You can start viewing the results in the output S3 location.
Completed – This job has successfully completed. View the output files in the output S3 location.
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.
Stopped – This job was stopped by a user.
Stopping – This job is being stopped by a user.

Returns:

(String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#submit_time ⇒ `Time`

The time at which the batch inference job was submitted.

Returns:

(Time)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#success_record_count ⇒ `Integer`

The number of records that were successfully processed in the batch inference job.

Returns:

(Integer)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#timeout_duration_in_hours ⇒ `Integer`

The number of hours after which the batch inference job was set to time out.

Returns:

(Integer)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#total_record_count ⇒ `Integer`

The total number of records in the batch inference job.

Returns:

(Integer)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

#vpc_config ⇒ `Types::VpcConfig`

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

Returns:

(Types::VpcConfig)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 11659

class ModelInvocationJobSummary < Struct.new(
  :job_arn,
  :job_name,
  :model_id,
  :client_request_token,
  :role_arn,
  :status,
  :message,
  :submit_time,
  :last_modified_time,
  :end_time,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :job_expiration_time,
  :model_invocation_type,
  :total_record_count,
  :processed_record_count,
  :success_record_count,
  :error_record_count)
  SENSITIVE = [:message]
  include Aws::Structure
end

Class: Aws::Bedrock::Types::ModelInvocationJobSummary

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

#end_time ⇒ Time

#error_record_count ⇒ Integer

#input_data_config ⇒ Types::ModelInvocationJobInputDataConfig

#job_arn ⇒ String

#job_expiration_time ⇒ Time

#job_name ⇒ String

#last_modified_time ⇒ Time

#message ⇒ String

#model_id ⇒ String

#model_invocation_type ⇒ String

#output_data_config ⇒ Types::ModelInvocationJobOutputDataConfig

#processed_record_count ⇒ Integer

#role_arn ⇒ String

#status ⇒ String

#submit_time ⇒ Time

#success_record_count ⇒ Integer

#timeout_duration_in_hours ⇒ Integer

#total_record_count ⇒ Integer

#vpc_config ⇒ Types::VpcConfig

#client_request_token ⇒ `String`

#end_time ⇒ `Time`

#error_record_count ⇒ `Integer`

#input_data_config ⇒ `Types::ModelInvocationJobInputDataConfig`

#job_arn ⇒ `String`

#job_expiration_time ⇒ `Time`

#job_name ⇒ `String`

#last_modified_time ⇒ `Time`

#message ⇒ `String`

#model_id ⇒ `String`

#model_invocation_type ⇒ `String`

#output_data_config ⇒ `Types::ModelInvocationJobOutputDataConfig`

#processed_record_count ⇒ `Integer`

#role_arn ⇒ `String`

#status ⇒ `String`

#submit_time ⇒ `Time`

#success_record_count ⇒ `Integer`

#timeout_duration_in_hours ⇒ `Integer`

#total_record_count ⇒ `Integer`

#vpc_config ⇒ `Types::VpcConfig`