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

GetPrivateConnectivityConfig

Gets the private connectivity configuration for the specified Outpost.

Request Syntax


GET /outposts/OutpostId/privateConnectivity HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

OutpostId

The ID or ARN of the Outpost.

Note

Despite the parameter name, you can make the request with an ARN. The parameter name is OutpostId for backward compatibility.

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

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PrivateConnectivityConfig": { 
      "PrivateConnectivityStatus": "string",
      "ProvisioningRoleArn": "string",
      "RoleArn": "string",
      "VpcInformationList": [ 
         { 
            "SubnetIds": [ "string" ],
            "VpcEndpointId": "string",
            "VpcId": "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.

PrivateConnectivityConfig

The private connectivity configuration for the Outpost.

Type: PrivateConnectivityConfig object

Errors

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

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ValidationException

A parameter is not valid.

HTTP Status Code: 400

Examples

Example

This example gets the private connectivity configuration for the specified Outpost.

Sample Request


aws outposts get-private-connectivity-config --outpost-id op-1234567890example

Sample Response


{
  "PrivateConnectivityConfig": {
    "RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/outposts.amazonaws.com/AWSServiceRoleForOutposts_op-1234567890example",
    "PrivateConnectivityStatus": "ENABLED",
    "VpcInformationList": [
      {
        "VpcId": "vpc-0abcd1234example",
        "SubnetIds": [
          "subnet-0abcd1234example"
        ],
        "VpcEndpointId": "vpce-0ab1234cd5678ef90"
      }
    ],
    "ProvisioningRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSOutpostsProvisioningRole_op-1234567890example"
  }
}