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

UpdateDirectConnectGatewayAttachment

Updates the edge locations associated with an AWS Direct Connect gateway attachment.

Request Syntax


PATCH /direct-connect-gateway-attachments/attachmentId HTTP/1.1
Content-type: application/json

{
   "EdgeLocations": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

attachmentId

The ID of the Direct Connect gateway attachment for the updated edge locations.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

EdgeLocations

One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations is only used for Direct Connect gateway attachments. Do

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [\s\S]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DirectConnectGatewayAttachment": { 
      "Attachment": { 
         "AttachmentId": "string",
         "AttachmentPolicyRuleNumber": number,
         "AttachmentType": "string",
         "CoreNetworkArn": "string",
         "CoreNetworkId": "string",
         "CreatedAt": number,
         "EdgeLocation": "string",
         "EdgeLocations": [ "string" ],
         "LastModificationErrors": [ 
            { 
               "Code": "string",
               "Message": "string",
               "RequestId": "string",
               "ResourceArn": "string"
            }
         ],
         "NetworkFunctionGroupName": "string",
         "OwnerAccountId": "string",
         "ProposedNetworkFunctionGroupChange": { 
            "AttachmentPolicyRuleNumber": number,
            "NetworkFunctionGroupName": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "ProposedSegmentChange": { 
            "AttachmentPolicyRuleNumber": number,
            "SegmentName": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "ResourceArn": "string",
         "SegmentName": "string",
         "State": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "UpdatedAt": number
      },
      "DirectConnectGatewayArn": "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.

DirectConnectGatewayAttachment

Returns details of the Direct Connect gateway attachment with the updated edge locations.

Type: DirectConnectGatewayAttachment object

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.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400