Bedrock Agent Runtime  >  Unions  >  APISchema

APISchema

Union Type

APISchema module-attribute

APISchema = Union[APISchemaS3 | APISchemaPayload | APISchemaUnknown]

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

Union Member Types

APISchemaS3 dataclass

Contains details about the S3 object containing the OpenAPI schema for the action group.

Attributes

value instance-attribute

value: S3Identifier

APISchemaPayload dataclass

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

Attributes

value instance-attribute

value: str

APISchemaUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute

tag: str