Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteGatewayTarget

Deletes a Gateway Target.

Request Syntax


DELETE /gateways/gatewayIdentifier/targets/targetId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

gatewayIdentifier

The unique identifier of the Gateway associated with the target.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

targetId

The unique identifier of the Gateway Target to delete.

Pattern: [0-9a-zA-Z]{10}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "gatewayArn": "string",
   "status": "string",
   "statusReasons": [ "string" ],
   "targetId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

gatewayArn

The Amazon Resource Name (ARN) of the Gateway.

Type: String

Pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/[0-9a-zA-Z]{10}

status

The current status of the Gateway Target deletion.

Type: String

statusReasons

The reasons for the current status of the Gateway Target deletion.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 0. Maximum length of 2048.

targetId

The unique identifier of the deleted Gateway Target.

Type: String

Pattern: [0-9a-zA-Z]{10}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400