Class: Aws::Bedrock::Types::ListCustomModelsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::ListCustomModelsRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #base_model_arn_equals ⇒ String

  Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

• #creation_time_after ⇒ Time

  Return custom models created after the specified time.

• #creation_time_before ⇒ Time

  Return custom models created before the specified time.

• #foundation_model_arn_equals ⇒ String

  Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

• #is_owned ⇒ Boolean

  Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

• #max_results ⇒ Integer

  The maximum number of results to return in the response.

• #model_status ⇒ String

  The status of them model to filter results by.

• #name_contains ⇒ String

  Return custom models only if the job name contains these characters.

• #next_token ⇒ String

  If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

• #sort_by ⇒ String

  The field to sort by in the returned list of models.

• #sort_order ⇒ String

  The sort order of the results.

Instance Attribute Details

#base_model_arn_equals ⇒ String

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time_after ⇒ Time

Return custom models created after the specified time.

Returns:

• (Time)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time_before ⇒ Time

Return custom models created before the specified time.

Returns:

• (Time)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#foundation_model_arn_equals ⇒ String

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#is_owned ⇒ Boolean

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

Returns:

• (Boolean)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

Returns:

• (Integer)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#model_status ⇒ String

The status of them model to filter results by. Possible values include:

• Creating - Include only models that are currently being created and validated.

• Active - Include only models that have been successfully created and are ready for use.

• Failed - Include only models where the creation process failed.

If you don't specify a status, the API returns models in all states.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#name_contains ⇒ String

Return custom models only if the job name contains these characters.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

The field to sort by in the returned list of models.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The sort order of the results.

Returns:

• (String)

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

class ListCustomModelsRequest < Struct.new(
  :creation_time_before,
  :creation_time_after,
  :name_contains,
  :base_model_arn_equals,
  :foundation_model_arn_equals,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order,
  :is_owned,
  :model_status)
  SENSITIVE = []
  include Aws::Structure
end