[ aws . bedrock-agentcore-control ]
update-gateway-target¶
Synopsis¶
update-gateway-target
--gateway-identifier <value>
--target-id <value>
--name <value>
[--description <value>]
--target-configuration <value>
--credential-provider-configurations <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--gateway-identifier (string)
The unique identifier of the Gateway associated with the target.
--target-id (string)
The unique identifier of the Gateway Target to update.
--name (string)
The updated name for the Gateway Target.
--description (string)
The updated description for the Gateway Target.
--target-configuration (tagged union structure)
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:mcp.mcp -> (tagged union structure)
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:openApiSchema,smithyModel,lambda.openApiSchema -> (tagged union structure)
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (string)
The inline payload containing the API schema definition.smithyModel -> (tagged union structure)
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (string)
The inline payload containing the API schema definition.lambda -> (structure)
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn -> (string)
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.toolSchema -> (tagged union structure)
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (list)
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(structure)
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name -> (string)
The name of the tool. This name identifies the tool in the Model Context Protocol.description -> (string)
The description of the tool. This description provides information about the purpose and usage of the tool.inputSchema -> (structure)
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
value -> (structure)
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
items -> (structure)
The items in the schema definition. This field is used for array types to define the structure of the array elements.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.outputSchema -> (structure)
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
value -> (structure)
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
items -> (structure)
The items in the schema definition. This field is used for array types to define the structure of the array elements.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.
JSON Syntax:
{
"mcp": {
"openApiSchema": {
"s3": {
"uri": "string",
"bucketOwnerAccountId": "string"
},
"inlinePayload": "string"
},
"smithyModel": {
"s3": {
"uri": "string",
"bucketOwnerAccountId": "string"
},
"inlinePayload": "string"
},
"lambda": {
"lambdaArn": "string",
"toolSchema": {
"s3": {
"uri": "string",
"bucketOwnerAccountId": "string"
},
"inlinePayload": [
{
"name": "string",
"description": "string",
"inputSchema": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": { ... recursive ... }
...},
"required": ["string", ...],
"items": { ... recursive ... },
"description": "string"
}
...},
"required": ["string", ...],
"items": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": { ... recursive ... }
...},
"required": ["string", ...],
"items": { ... recursive ... },
"description": "string"
},
"description": "string"
},
"outputSchema": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": { ... recursive ... }
...},
"required": ["string", ...],
"items": { ... recursive ... },
"description": "string"
}
...},
"required": ["string", ...],
"items": {
"type": "string"|"number"|"object"|"array"|"boolean"|"integer",
"properties": {"string": { ... recursive ... }
...},
"required": ["string", ...],
"items": { ... recursive ... },
"description": "string"
},
"description": "string"
}
}
...
]
}
}
}
}
--credential-provider-configurations (list)
The updated credential provider configurations for the Gateway Target.
(structure)
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType -> (string)
The type of credential provider. This field specifies which authentication method the gateway uses.credentialProvider -> (tagged union structure)
The credential provider. This field contains the specific configuration for the credential provider type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:oauthCredentialProvider,apiKeyCredentialProvider.oauthCredentialProvider -> (structure)
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn -> (string)
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.scopes -> (list)
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string)
customParameters -> (map)
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
key -> (string)
value -> (string)
apiKeyCredentialProvider -> (structure)
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn -> (string)
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.credentialParameterName -> (string)
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.credentialPrefix -> (string)
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.credentialLocation -> (string)
The location of the API key credential. This field specifies where in the request the API key should be placed.
JSON Syntax:
[
{
"credentialProviderType": "GATEWAY_IAM_ROLE"|"OAUTH"|"API_KEY",
"credentialProvider": {
"oauthCredentialProvider": {
"providerArn": "string",
"scopes": ["string", ...],
"customParameters": {"string": "string"
...}
},
"apiKeyCredentialProvider": {
"providerArn": "string",
"credentialParameterName": "string",
"credentialPrefix": "string",
"credentialLocation": "HEADER"|"QUERY_PARAMETER"
}
}
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
gatewayArn -> (string)
The Amazon Resource Name (ARN) of the Gateway.
targetId -> (string)
The unique identifier of the updated Gateway Target.
createdAt -> (timestamp)
The timestamp when the Gateway Target was created.
updatedAt -> (timestamp)
The timestamp when the Gateway Target was last updated.
status -> (string)
The current status of the updated Gateway Target.
statusReasons -> (list)
The reasons for the current status of the updated Gateway Target.
(string)
name -> (string)
The updated name of the Gateway Target.
description -> (string)
The updated description of the Gateway Target.
targetConfiguration -> (tagged union structure)
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:mcp.mcp -> (tagged union structure)
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:openApiSchema,smithyModel,lambda.openApiSchema -> (tagged union structure)
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (string)
The inline payload containing the API schema definition.smithyModel -> (tagged union structure)
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (string)
The inline payload containing the API schema definition.lambda -> (structure)
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn -> (string)
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.toolSchema -> (tagged union structure)
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:s3,inlinePayload.s3 -> (structure)
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri -> (string)
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.bucketOwnerAccountId -> (string)
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.inlinePayload -> (list)
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(structure)
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name -> (string)
The name of the tool. This name identifies the tool in the Model Context Protocol.description -> (string)
The description of the tool. This description provides information about the purpose and usage of the tool.inputSchema -> (structure)
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
value -> (structure)
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
items -> (structure)
The items in the schema definition. This field is used for array types to define the structure of the array elements.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.outputSchema -> (structure)
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
value -> (structure)
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
items -> (structure)
The items in the schema definition. This field is used for array types to define the structure of the array elements.
type -> (string)
The type of the schema definition. This field specifies the data type of the schema.properties -> (map)
The properties of the schema definition. These properties define the fields in the schema.
key -> (string)
( … recursive … )
required -> (list)
The required fields in the schema definition. These fields must be provided when using the schema.
(string)
( … recursive … )description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.description -> (string)
The description of the schema definition. This description provides information about the purpose and usage of the schema.
credentialProviderConfigurations -> (list)
The updated credential provider configurations for the Gateway Target.
(structure)
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType -> (string)
The type of credential provider. This field specifies which authentication method the gateway uses.credentialProvider -> (tagged union structure)
The credential provider. This field contains the specific configuration for the credential provider type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:oauthCredentialProvider,apiKeyCredentialProvider.oauthCredentialProvider -> (structure)
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn -> (string)
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.scopes -> (list)
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string)
customParameters -> (map)
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
key -> (string)
value -> (string)
apiKeyCredentialProvider -> (structure)
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn -> (string)
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.credentialParameterName -> (string)
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.credentialPrefix -> (string)
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.credentialLocation -> (string)
The location of the API key credential. This field specifies where in the request the API key should be placed.