Class: Aws::BedrockAgentCoreControl::Types::SchemaDefinition

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::SchemaDefinition

Defined in:

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

Overview

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the schema definition.

• #items ⇒ Types::SchemaDefinition

  The items in the schema definition.

• #properties ⇒ Hash<String,Types::SchemaDefinition>

  The properties of the schema definition.

• #required ⇒ Array<String>

  The required fields in the schema definition.

• #type ⇒ String

  The type of the schema definition.

Instance Attribute Details

#description ⇒ String

The description of the schema definition. This description provides information about the purpose and usage of the schema.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 8122

class SchemaDefinition < Struct.new(
  :type,
  :properties,
  :required,
  :items,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#items ⇒ Types::SchemaDefinition

The items in the schema definition. This field is used for array types to define the structure of the array elements.

Returns:

• (Types::SchemaDefinition)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 8122

class SchemaDefinition < Struct.new(
  :type,
  :properties,
  :required,
  :items,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ Hash<String,Types::SchemaDefinition>

The properties of the schema definition. These properties define the fields in the schema.

Returns:

• (Hash<String,Types::SchemaDefinition>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 8122

class SchemaDefinition < Struct.new(
  :type,
  :properties,
  :required,
  :items,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Array<String>

The required fields in the schema definition. These fields must be provided when using the schema.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 8122

class SchemaDefinition < Struct.new(
  :type,
  :properties,
  :required,
  :items,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the schema definition. This field specifies the data type of the schema.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 8122

class SchemaDefinition < Struct.new(
  :type,
  :properties,
  :required,
  :items,
  :description)
  SENSITIVE = []
  include Aws::Structure
end