Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeVpcPeeringConnections

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

Related actions

All APIs by task

Request Syntax


{
   "FleetId": "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.

Note

In the following list, the required parameters are described first.

FleetId

A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Type: String

Pattern: ^fleet-\S+

Required: No

Response Syntax


{
   "VpcPeeringConnections": [ 
      { 
         "FleetArn": "string",
         "FleetId": "string",
         "GameLiftVpcId": "string",
         "IpV4CidrBlock": "string",
         "PeerVpcId": "string",
         "Status": { 
            "Code": "string",
            "Message": "string"
         },
         "VpcPeeringConnectionId": "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.

VpcPeeringConnections

A collection of VPC peering connection records that match the request.

Type: Array of VpcPeeringConnection objects

Errors

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

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400