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

GetResourceConfiguration

Retrieves information about the specified resource configuration.

Request Syntax


GET /resourceconfigurations/resourceConfigurationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceConfigurationIdentifier

The ID of the resource configuration.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "allowAssociationToShareableServiceNetwork": boolean,
   "amazonManaged": boolean,
   "arn": "string",
   "createdAt": "string",
   "customDomainName": "string",
   "failureReason": "string",
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "portRanges": [ "string" ],
   "protocol": "string",
   "resourceConfigurationDefinition": { ... },
   "resourceConfigurationGroupId": "string",
   "resourceGatewayId": "string",
   "status": "string",
   "type": "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.

allowAssociationToShareableServiceNetwork

Specifies whether the resource configuration is associated with a sharable service network.

Type: Boolean

amazonManaged

Indicates whether the resource configuration was created and is managed by Amazon.

Type: Boolean

arn

The Amazon Resource Name (ARN) of the resource configuration.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$

createdAt

The date and time that the resource configuration was created, in ISO-8601 format.

Type: Timestamp

customDomainName

The custom domain name of the resource configuration.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

failureReason

The reason the create-resource-configuration request failed.

Type: String

id

The ID of the resource configuration.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^rcfg-[0-9a-z]{17}$

lastUpdatedAt

The most recent date and time that the resource configuration was updated, in ISO-8601 format.

Type: Timestamp

name

The name of the resource configuration.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!rcfg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

portRanges

The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30

Type: Array of strings

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

Pattern: ^((\d{1,5}\-\d{1,5})|(\d+))$

protocol

The TCP protocol accepted by the specified resource configuration.

Type: String

Valid Values: TCP

resourceConfigurationDefinition

The resource configuration.

Type: ResourceConfigurationDefinition object

Note: This object is a Union. Only one member of this object can be specified or returned.

resourceConfigurationGroupId

The ID of the group resource configuration.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^rcfg-[0-9a-z]{17}$

resourceGatewayId

The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^rgw-[0-9a-z]{17}$

status

The status of the resource configuration.

Type: String

type

The type of resource configuration.

SINGLE - A single resource.
GROUP - A group of resources.
CHILD - A single resource that is part of a group resource configuration.
ARN - An AWS resource.

Type: String

Valid Values: GROUP | CHILD | SINGLE | ARN

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400