View a markdown version of this page

UpdateConnectionsBillingMode - Direct Connect

UpdateConnectionsBillingMode

Updates the billing mode for the specified Direct Connect connections. You can update the billing mode for up to 200 connections in a single request.

Request Syntax

{ "billingMode": "string", "connectionIds": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

billingMode

The billing mode to apply to the specified connections. The valid values are PayAsYouGo, FlatRateTier1, FlatRateTier2, FlatRateTier3, FlatRateTier4, and FlatRateTier5.

Type: String

Valid Values: PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | FlatRateTier4 | FlatRateTier5

Required: Yes

connectionIds

The IDs of the connections to update. You can specify from 1 to 200 connections.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: Yes

Response Syntax

{ "billingMode": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "awsLogicalDeviceId": "string", "bandwidth": "string", "billingMode": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "encryptionMode": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "macSecCapable": boolean, "macSecKeys": [ { "ckn": "string", "secretARN": "string", "startOn": "string", "state": "string" } ], "ownerAccount": "string", "partnerInterconnectMacSecCapable": boolean, "partnerName": "string", "portEncryptionStatus": "string", "prefixPoolSizeIpv4": number, "prefixPoolSizeIpv6": number, "prefixPoolUnallocatedCountIpv4": number, "prefixPoolUnallocatedCountIpv6": number, "providerName": "string", "rateLimiterStatus": { "inUse": number, "maxAllowed": number, "remaining": number, "totalBandwidth": "string" }, "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number } ] }

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.

billingMode

The billing mode applied to the connections.

Type: String

Valid Values: PayAsYouGo | FlatRateTier1 | FlatRateTier2 | FlatRateTier3 | FlatRateTier4 | FlatRateTier5 | PortPairFlatRateTier1 | PortPairFlatRateTier2 | PortPairFlatRateTier3 | PortPairFlatRateTier4 | PortPairFlatRateTier5

connections

The connections with the updated billing mode.

Type: Array of Connection objects

Errors

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

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See Also

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