PutAttachmentRoutingPolicyLabel - AWS Global Networks for Transit Gateways

PutAttachmentRoutingPolicyLabel

Applies a routing policy label to an attachment for traffic routing decisions.

Request Syntax

POST /routing-policy-label HTTP/1.1 Content-type: application/json { "AttachmentId": "string", "ClientToken": "string", "CoreNetworkId": "string", "RoutingPolicyLabel": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AttachmentId

The ID of the attachment to apply the routing policy label to.

Type: String

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

Pattern: ^attachment-([0-9a-f]{8,17})$

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: [\s\S]*

Required: No

CoreNetworkId

The ID of the core network containing the attachment.

Type: String

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

Pattern: ^core-network-([0-9a-f]{8,17})$

Required: Yes

RoutingPolicyLabel

The routing policy label to apply to the attachment.

Type: String

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

Pattern: [\s\S]*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AttachmentId": "string", "CoreNetworkId": "string", "RoutingPolicyLabel": "string" }

Response Elements

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

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

AttachmentId

The ID of the attachment that received the routing policy label.

Type: String

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

Pattern: ^attachment-([0-9a-f]{8,17})$

CoreNetworkId

The ID of the core network containing the attachment.

Type: String

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

Pattern: ^core-network-([0-9a-f]{8,17})$

RoutingPolicyLabel

The routing policy label that was applied to the attachment.

Type: String

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

Pattern: [\s\S]*

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ResourceId

The ID of the resource.

ResourceType

The resource type.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

RetryAfterSeconds

Indicates when to retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

Context

The specified resource could not be found.

ResourceId

The ID of the resource.

ResourceType

The resource type.

HTTP Status Code: 404

ServiceQuotaExceededException

A service limit was exceeded.

LimitCode

The limit code.

Message

The error message.

ResourceId

The ID of the resource.

ResourceType

The resource type.

ServiceCode

The service code.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds

Indicates when to retry the request.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

Fields

The fields that caused the error, if applicable.

Reason

The reason for the error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: