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

GetServiceNetworkResourceAssociation

Retrieves information about the specified association between a service network and a resource configuration.

Request Syntax


GET /servicenetworkresourceassociations/serviceNetworkResourceAssociationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkResourceAssociationIdentifier

The ID of the association.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": "string",
   "createdBy": "string",
   "dnsEntry": { 
      "domainName": "string",
      "hostedZoneId": "string"
   },
   "failureCode": "string",
   "failureReason": "string",
   "id": "string",
   "isManagedAssociation": boolean,
   "lastUpdatedAt": "string",
   "privateDnsEntry": { 
      "domainName": "string",
      "hostedZoneId": "string"
   },
   "resourceConfigurationArn": "string",
   "resourceConfigurationId": "string",
   "resourceConfigurationName": "string",
   "serviceNetworkArn": "string",
   "serviceNetworkId": "string",
   "serviceNetworkName": "string",
   "status": "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.

arn

The Amazon Resource Name (ARN) of the association.

Type: String

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

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

createdAt

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

Type: Timestamp

createdBy

The account that created the association.

Type: String

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

Pattern: ^[0-9]{12}$

dnsEntry

The DNS entry for the service.

Type: DnsEntry object

failureCode

The failure code.

Type: String

failureReason

The reason the association request failed.

Type: String

id

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snra-[0-9a-f]{17}$

isManagedAssociation

Indicates whether the association is managed by Amazon.

Type: Boolean

lastUpdatedAt

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

Type: Timestamp

privateDnsEntry

The private DNS entry for the service.

Type: DnsEntry object

resourceConfigurationArn

The Amazon Resource Name (ARN) of the association.

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}$

resourceConfigurationId

The ID of the resource configuration that is associated with the service network.

Type: String

Length Constraints: Fixed length of 22.

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

resourceConfigurationName

The name of the resource configuration that is associated with the service network.

Type: String

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

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

serviceNetworkArn

The Amazon Resource Name (ARN) of the service network that is associated with the resource configuration.

Type: String

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

serviceNetworkId

The ID of the service network that is associated with the resource configuration.

Type: String

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

serviceNetworkName

The name of the service network that is associated with the resource configuration.

Type: String

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

status

The status of the association.

Type: String

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