ApiSchema

class aws_cdk.aws_bedrockagentcore.ApiSchema(s3_file=None, bucket_owner_account_id=None, inline_schema=None)

Bases: object

Represents the concept of an API Schema for a Gateway Target.

ExampleMetadata:

fixture=default infused

Example:

gateway = agentcore.Gateway(self, "MyGateway",
    gateway_name="my-gateway"
)

smithy_schema = agentcore.ApiSchema.from_local_asset(
    path.join(__dirname, "models", "smithy-model.json"))
smithy_schema.bind(self)

# Create a gateway target with Smithy Model and OAuth
target = agentcore.GatewayTarget.for_smithy(self, "MySmithyTarget",
    gateway_target_name="my-smithy-target",
    description="Target for Smithy model integration",
    gateway=gateway,
    smithy_model=smithy_schema
)
Parameters:

  • s3_file (Union[Location, Dict[str, Any], None])

  • bucket_owner_account_id (Optional[str])

  • inline_schema (Optional[str])

Methods

abstractmethod bind(scope)

Bind the schema to a construct.

Parameters:

scope (Construct)

Return type:

None

abstractmethod grant_permissions_to_role(role)

Grant permissions to the role.

Parameters:

role (IRole)

Return type:

None

Attributes

bucket_owner_account_id

The account ID of the S3 bucket owner for cross-account access.

inline_schema

The inline OpenAPI schema definition as a string, if using an inline schema.

Can be in JSON or YAML format.

s3_file

The S3 location of the API schema file, if using an S3-based schema.

Contains the bucket name and object key information.

Static Methods

classmethod from_inline(schema)

Creates an API Schema from an inline string.

Parameters:

schema (str) –

  • the JSON or YAML payload defining the schema (OpenAPI or Smithy).

Return type:

InlineApiSchema

classmethod from_local_asset(path)

Creates an API Schema from a local file.

Parameters:

path (str) –

  • the path to the local file containing the OpenAPI schema for the action group.

Return type:

AssetApiSchema

classmethod from_s3_file(bucket, object_key, bucket_owner_account_id=None)

Creates an API Schema from an S3 File.

Parameters:

  • bucket (IBucket) –

    • the bucket containing the local file containing the OpenAPI schema for the action group.

  • object_key (str) –

    • object key in the bucket.

  • bucket_owner_account_id (Optional[str]) –

    • optional The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

Return type:

S3ApiSchema