Accepts ownership of a private virtual interface created by another AWS account.
After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.
Request Syntax
{
"directConnectGatewayId": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "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.
- directConnectGatewayId
-
The ID of the Direct Connect gateway.
Type: String
Required: No
- virtualGatewayId
-
The ID of the virtual private gateway.
Type: String
Required: No
- virtualInterfaceId
-
The ID of the virtual interface.
Type: String
Required: Yes
Response Syntax
{
"virtualInterfaceState": "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.
- virtualInterfaceState
-
The state of the virtual interface. The following are the possible values:
-
confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available: A virtual interface that is able to forward traffic. -
down: A virtual interface that is BGP down. -
testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test. -
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. -
deleted: A virtual interface that cannot forward traffic. -
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirmingstate is deleted by the virtual interface owner, the virtual interface enters theRejectedstate. -
unknown: The state of the virtual interface is not available.
Type: String
Valid Values:
confirming | verifying | pending | available | down | deleting | deleted | rejected | unknown -
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
