Skip to content

describe_vpc_peering_connections

describe_vpc_peering_connections(
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    fleet_id: Optional[FleetId] = None,
) -> DescribeVpcPeeringConnectionsOutput

This API works with the following fleet types: EC2

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 Amazon Web Services account that is used to manage the Amazon GameLift Servers 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

Parameters:

  • fleet_id (Optional[FleetId], default: None ) –

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

Raises:

  • InternalServiceException –

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

  • InvalidRequestException –

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

  • NotFoundException –

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

  • UnauthorizedException –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_gamelift/_services/game_lift.py
def describe_vpc_peering_connections(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    fleet_id: Optional["capo_gamelift.types.fleet_id.FleetId"] = None,
) -> "capo_gamelift.types.describe_vpc_peering_connections_output.DescribeVpcPeeringConnectionsOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2</p> <p>Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. </p> <p>To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift Servers 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. </p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>

    Args:
        fleet_id: <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.not_found_exception.NotFoundException: <p>The requested resource was not found. The resource was either not created yet or deleted.</p>
        capo_gamelift.errors.unauthorized_exception.UnauthorizedException: <p>The client failed authentication. Clients should not retry such requests.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_gamelift.types.describe_vpc_peering_connections_input.DescribeVpcPeeringConnectionsInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.describe_vpc_peering_connections_output.DescribeVpcPeeringConnectionsOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_vpc_peering_connections

        output, http_response = (
            capo_gamelift._operations.game_lift.describe_vpc_peering_connections.describe_vpc_peering_connections(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVpcPeeringConnections")
    )
    input_: capo_gamelift.types.describe_vpc_peering_connections_input.DescribeVpcPeeringConnectionsInput = {}
    if fleet_id is not None:
        input_["fleet_id"] = fleet_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output