@aws-sdk/client-bedrock-agentcore-control 3.1051.0 → 3.1052.0

package/dist-types/models/models_2.d.ts

@@ -0,0 +1,775 @@
+import type { SchemaType, TargetProtocolType, TargetStatus } from "./enums";
+import type { ApiGatewayTargetConfiguration, ApiSchemaConfiguration, AuthorizationData, CredentialProviderConfiguration, HttpTargetConfiguration, ManagedResourceDetails, McpServerTargetConfiguration, MetadataConfiguration, PrivateEndpoint, S3Configuration } from "./models_0";
+/**
+ * <p>Contains information about a workload identity.</p>
+ * @public
+ */
+export interface WorkloadIdentityType {
+    /**
+     * <p>The name of the workload identity.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the workload identity.</p>
+     * @public
+     */
+    workloadIdentityArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkloadIdentitiesResponse {
+    /**
+     * <p>The list of workload identities.</p>
+     * @public
+     */
+    workloadIdentities: WorkloadIdentityType[] | undefined;
+    /**
+     * <p>Pagination token for the next page of results.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateWorkloadIdentityRequest {
+    /**
+     * <p>The name of the workload identity to update.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.</p>
+     * @public
+     */
+    allowedResourceOauth2ReturnUrls?: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateWorkloadIdentityResponse {
+    /**
+     * <p>The name of the workload identity.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the workload identity.</p>
+     * @public
+     */
+    workloadIdentityArn: string | undefined;
+    /**
+     * <p>The list of allowed OAuth2 return URLs for resources associated with this workload identity.</p>
+     * @public
+     */
+    allowedResourceOauth2ReturnUrls?: string[] | undefined;
+    /**
+     * <p>The timestamp when the workload identity was created.</p>
+     * @public
+     */
+    createdTime: Date | undefined;
+    /**
+     * <p>The timestamp when the workload identity was last updated.</p>
+     * @public
+     */
+    lastUpdatedTime: Date | undefined;
+}
+/**
+ * <p>A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.</p>
+ * @public
+ */
+export interface SchemaDefinition {
+    /**
+     * <p>The type of the schema definition. This field specifies the data type of the schema.</p>
+     * @public
+     */
+    type: SchemaType | undefined;
+    /**
+     * <p>The properties of the schema definition. These properties define the fields in the schema.</p>
+     * @public
+     */
+    properties?: Record<string, SchemaDefinition> | undefined;
+    /**
+     * <p>The required fields in the schema definition. These fields must be provided when using the schema.</p>
+     * @public
+     */
+    required?: string[] | undefined;
+    /**
+     * <p>The items in the schema definition. This field is used for array types to define the structure of the array elements.</p>
+     * @public
+     */
+    items?: SchemaDefinition | undefined;
+    /**
+     * <p>The description of the schema definition. This description provides information about the purpose and usage of the schema.</p>
+     * @public
+     */
+    description?: string | undefined;
+}
+/**
+ * <p>A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.</p>
+ * @public
+ */
+export interface ToolDefinition {
+    /**
+     * <p>The name of the tool. This name identifies the tool in the Model Context Protocol.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description of the tool. This description provides information about the purpose and usage of the tool.</p>
+     * @public
+     */
+    description: string | undefined;
+    /**
+     * <p>The input schema for the tool. This schema defines the structure of the input that the tool accepts.</p>
+     * @public
+     */
+    inputSchema: SchemaDefinition | undefined;
+    /**
+     * <p>The output schema for the tool. This schema defines the structure of the output that the tool produces.</p>
+     * @public
+     */
+    outputSchema?: SchemaDefinition | undefined;
+}
+/**
+ * <p>A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.</p>
+ * @public
+ */
+export type ToolSchema = ToolSchema.InlinePayloadMember | ToolSchema.S3Member | ToolSchema.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolSchema {
+    /**
+     * <p>The Amazon S3 location of the tool schema. This location contains the schema definition file.</p>
+     * @public
+     */
+    interface S3Member {
+        s3: S3Configuration;
+        inlinePayload?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The inline payload of the tool schema. This payload contains the schema definition directly in the request.</p>
+     * @public
+     */
+    interface InlinePayloadMember {
+        s3?: never;
+        inlinePayload: ToolDefinition[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        s3?: never;
+        inlinePayload?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        s3: (value: S3Configuration) => T;
+        inlinePayload: (value: ToolDefinition[]) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * <p>The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target.</p>
+ * @public
+ */
+export interface McpLambdaTargetConfiguration {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.</p>
+     * @public
+     */
+    lambdaArn: string | undefined;
+    /**
+     * <p>The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.</p>
+     * @public
+     */
+    toolSchema: ToolSchema | undefined;
+}
+/**
+ * <p>The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target.</p>
+ * @public
+ */
+export type McpTargetConfiguration = McpTargetConfiguration.ApiGatewayMember | McpTargetConfiguration.LambdaMember | McpTargetConfiguration.McpServerMember | McpTargetConfiguration.OpenApiSchemaMember | McpTargetConfiguration.SmithyModelMember | McpTargetConfiguration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace McpTargetConfiguration {
+    /**
+     * <p>The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.</p>
+     * @public
+     */
+    interface OpenApiSchemaMember {
+        openApiSchema: ApiSchemaConfiguration;
+        smithyModel?: never;
+        lambda?: never;
+        mcpServer?: never;
+        apiGateway?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.</p>
+     * @public
+     */
+    interface SmithyModelMember {
+        openApiSchema?: never;
+        smithyModel: ApiSchemaConfiguration;
+        lambda?: never;
+        mcpServer?: never;
+        apiGateway?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.</p>
+     * @public
+     */
+    interface LambdaMember {
+        openApiSchema?: never;
+        smithyModel?: never;
+        lambda: McpLambdaTargetConfiguration;
+        mcpServer?: never;
+        apiGateway?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The MCP server specified as the gateway target.</p>
+     * @public
+     */
+    interface McpServerMember {
+        openApiSchema?: never;
+        smithyModel?: never;
+        lambda?: never;
+        mcpServer: McpServerTargetConfiguration;
+        apiGateway?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The configuration for an Amazon API Gateway target.</p>
+     * @public
+     */
+    interface ApiGatewayMember {
+        openApiSchema?: never;
+        smithyModel?: never;
+        lambda?: never;
+        mcpServer?: never;
+        apiGateway: ApiGatewayTargetConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        openApiSchema?: never;
+        smithyModel?: never;
+        lambda?: never;
+        mcpServer?: never;
+        apiGateway?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        openApiSchema: (value: ApiSchemaConfiguration) => T;
+        smithyModel: (value: ApiSchemaConfiguration) => T;
+        lambda: (value: McpLambdaTargetConfiguration) => T;
+        mcpServer: (value: McpServerTargetConfiguration) => T;
+        apiGateway: (value: ApiGatewayTargetConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * <p>The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.</p>
+ * @public
+ */
+export type TargetConfiguration = TargetConfiguration.HttpMember | TargetConfiguration.McpMember | TargetConfiguration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace TargetConfiguration {
+    /**
+     * <p>The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.</p>
+     * @public
+     */
+    interface McpMember {
+        mcp: McpTargetConfiguration;
+        http?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime.</p>
+     * @public
+     */
+    interface HttpMember {
+        mcp?: never;
+        http: HttpTargetConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        mcp?: never;
+        http?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        mcp: (value: McpTargetConfiguration) => T;
+        http: (value: HttpTargetConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * @public
+ */
+export interface CreateGatewayTargetRequest {
+    /**
+     * <p>The identifier of the gateway to create a target for.</p>
+     * @public
+     */
+    gatewayIdentifier: string | undefined;
+    /**
+     * <p>The name of the gateway target. The name must be unique within the gateway.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description of the gateway target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The configuration settings for the target, including endpoint information and schema definitions.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.</p>
+     * @public
+     */
+    credentialProviderConfigurations?: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>Optional configuration for HTTP header and query parameter propagation to and from the gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateGatewayTargetResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the gateway.</p>
+     * @public
+     */
+    gatewayArn: string | undefined;
+    /**
+     * <p>The unique identifier of the created target.</p>
+     * @public
+     */
+    targetId: string | undefined;
+    /**
+     * <p>The timestamp when the target was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The timestamp when the target was last updated.</p>
+     * @public
+     */
+    updatedAt: Date | undefined;
+    /**
+     * <p>The current status of the target.</p>
+     * @public
+     */
+    status: TargetStatus | undefined;
+    /**
+     * <p>The reasons for the current status of the target.</p>
+     * @public
+     */
+    statusReasons?: string[] | undefined;
+    /**
+     * <p>The name of the target.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description of the target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The configuration settings for the target.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The credential provider configurations for the target.</p>
+     * @public
+     */
+    credentialProviderConfigurations: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>The last synchronization of the target.</p>
+     * @public
+     */
+    lastSynchronizedAt?: Date | undefined;
+    /**
+     * <p>The metadata configuration that was applied to the created gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for the gateway target.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+    /**
+     * <p>The managed resources created by the gateway for private endpoint connectivity.</p>
+     * @public
+     */
+    privateEndpointManagedResources?: ManagedResourceDetails[] | undefined;
+    /**
+     * <p>OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.</p>
+     * @public
+     */
+    authorizationData?: AuthorizationData | undefined;
+    /**
+     * <p>The protocol type of the created gateway target.</p>
+     * @public
+     */
+    protocolType?: TargetProtocolType | undefined;
+}
+/**
+ * <p>The gateway target.</p>
+ * @public
+ */
+export interface GatewayTarget {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the gateway target.</p>
+     * @public
+     */
+    gatewayArn: string | undefined;
+    /**
+     * <p>The target ID.</p>
+     * @public
+     */
+    targetId: string | undefined;
+    /**
+     * <p>The date and time at which the target was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The date and time at which the target was updated.</p>
+     * @public
+     */
+    updatedAt: Date | undefined;
+    /**
+     * <p>The status of the gateway target.</p>
+     * @public
+     */
+    status: TargetStatus | undefined;
+    /**
+     * <p>The status reasons for the target status.</p>
+     * @public
+     */
+    statusReasons?: string[] | undefined;
+    /**
+     * <p>The name of the gateway target.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description for the gateway target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The provider configurations.</p>
+     * @public
+     */
+    credentialProviderConfigurations: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>The last synchronization time.</p>
+     * @public
+     */
+    lastSynchronizedAt?: Date | undefined;
+    /**
+     * <p>The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+    /**
+     * <p>A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.</p>
+     * @public
+     */
+    privateEndpointManagedResources?: ManagedResourceDetails[] | undefined;
+    /**
+     * <p>OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.</p>
+     * @public
+     */
+    authorizationData?: AuthorizationData | undefined;
+    /**
+     * <p>The protocol type of the gateway target.</p>
+     * @public
+     */
+    protocolType?: TargetProtocolType | undefined;
+}
+/**
+ * @public
+ */
+export interface GetGatewayTargetResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the gateway.</p>
+     * @public
+     */
+    gatewayArn: string | undefined;
+    /**
+     * <p>The unique identifier of the gateway target.</p>
+     * @public
+     */
+    targetId: string | undefined;
+    /**
+     * <p>The timestamp when the gateway target was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The timestamp when the gateway target was last updated.</p>
+     * @public
+     */
+    updatedAt: Date | undefined;
+    /**
+     * <p>The current status of the gateway target.</p>
+     * @public
+     */
+    status: TargetStatus | undefined;
+    /**
+     * <p>The reasons for the current status of the gateway target.</p>
+     * @public
+     */
+    statusReasons?: string[] | undefined;
+    /**
+     * <p>The name of the gateway target.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description of the gateway target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The credential provider configurations for the gateway target.</p>
+     * @public
+     */
+    credentialProviderConfigurations: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>The last synchronization of the target.</p>
+     * @public
+     */
+    lastSynchronizedAt?: Date | undefined;
+    /**
+     * <p>The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for the gateway target.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+    /**
+     * <p>The managed resources created by the gateway for private endpoint connectivity.</p>
+     * @public
+     */
+    privateEndpointManagedResources?: ManagedResourceDetails[] | undefined;
+    /**
+     * <p>OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.</p>
+     * @public
+     */
+    authorizationData?: AuthorizationData | undefined;
+    /**
+     * <p>The protocol type of the gateway target.</p>
+     * @public
+     */
+    protocolType?: TargetProtocolType | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateGatewayTargetRequest {
+    /**
+     * <p>The unique identifier of the gateway associated with the target.</p>
+     * @public
+     */
+    gatewayIdentifier: string | undefined;
+    /**
+     * <p>The unique identifier of the gateway target to update.</p>
+     * @public
+     */
+    targetId: string | undefined;
+    /**
+     * <p>The updated name for the gateway target.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The updated description for the gateway target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The updated credential provider configurations for the gateway target.</p>
+     * @public
+     */
+    credentialProviderConfigurations?: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>Configuration for HTTP header and query parameter propagation to the gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateGatewayTargetResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the gateway.</p>
+     * @public
+     */
+    gatewayArn: string | undefined;
+    /**
+     * <p>The unique identifier of the updated gateway target.</p>
+     * @public
+     */
+    targetId: string | undefined;
+    /**
+     * <p>The timestamp when the gateway target was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The timestamp when the gateway target was last updated.</p>
+     * @public
+     */
+    updatedAt: Date | undefined;
+    /**
+     * <p>The current status of the updated gateway target.</p>
+     * @public
+     */
+    status: TargetStatus | undefined;
+    /**
+     * <p>The reasons for the current status of the updated gateway target.</p>
+     * @public
+     */
+    statusReasons?: string[] | undefined;
+    /**
+     * <p>The updated name of the gateway target.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The updated description of the gateway target.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.</p>
+     * @public
+     */
+    targetConfiguration: TargetConfiguration | undefined;
+    /**
+     * <p>The updated credential provider configurations for the gateway target.</p>
+     * @public
+     */
+    credentialProviderConfigurations: CredentialProviderConfiguration[] | undefined;
+    /**
+     * <p>The date and time at which the targets were last synchronized.</p>
+     * @public
+     */
+    lastSynchronizedAt?: Date | undefined;
+    /**
+     * <p>The metadata configuration that was applied to the gateway target.</p>
+     * @public
+     */
+    metadataConfiguration?: MetadataConfiguration | undefined;
+    /**
+     * <p>The private endpoint configuration for the gateway target.</p>
+     * @public
+     */
+    privateEndpoint?: PrivateEndpoint | undefined;
+    /**
+     * <p>The managed resources created by the gateway for private endpoint connectivity.</p>
+     * @public
+     */
+    privateEndpointManagedResources?: ManagedResourceDetails[] | undefined;
+    /**
+     * <p>OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.</p>
+     * @public
+     */
+    authorizationData?: AuthorizationData | undefined;
+    /**
+     * <p>The protocol type of the updated gateway target.</p>
+     * @public
+     */
+    protocolType?: TargetProtocolType | undefined;
+}
+/**
+ * @public
+ */
+export interface SynchronizeGatewayTargetsResponse {
+    /**
+     * <p>The gateway targets for synchronization.</p>
+     * @public
+     */
+    targets?: GatewayTarget[] | undefined;
+}