Class: Aws::Bedrock::Types::CreateModelInvocationJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::CreateModelInvocationJobRequest

Defined in:

gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #input_data_config ⇒ Types::ModelInvocationJobInputDataConfig

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

• #job_name ⇒ String

  A name to give the batch inference job.

• #model_id ⇒ String

  The unique identifier of the foundation model to use for the batch inference job.

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

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference.

• #tags ⇒ Array<Types::Tag>

  Any tags to associate with the batch inference job.

• #timeout_duration_in_hours ⇒ Integer

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

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  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 4009

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

A name to give the batch inference job.

Returns:

• (String)

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

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#model_id ⇒ String

The unique identifier of the foundation model to use for the batch inference job.

Returns:

• (String)

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

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  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 4009

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  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 4009

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  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 4009

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

Returns:

• (Array<Types::Tag>)

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

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_duration_in_hours ⇒ Integer

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

Returns:

• (Integer)

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

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  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 4009

class CreateModelInvocationJobRequest < Struct.new(
  :job_name,
  :role_arn,
  :client_request_token,
  :model_id,
  :input_data_config,
  :output_data_config,
  :vpc_config,
  :timeout_duration_in_hours,
  :tags,
  :model_invocation_type)
  SENSITIVE = []
  include Aws::Structure
end