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

GetServiceNetwork

Retrieves information about the specified service network.

Request Syntax


GET /servicenetworks/serviceNetworkIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkIdentifier

The ID or ARN of the service network.

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

Pattern: ((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[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

{
   "arn": "string",
   "authType": "string",
   "createdAt": "string",
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "numberOfAssociatedServices": number,
   "numberOfAssociatedVPCs": number,
   "sharingConfig": { 
      "enabled": boolean
   }
}

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 service network.

Type: String

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

Pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}

authType

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

createdAt

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

Type: Timestamp

id

The ID of the service network.

Type: String

Length Constraints: Fixed length of 20.

Pattern: sn-[0-9a-z]{17}

lastUpdatedAt

The date and time of the last update, in ISO-8601 format.

Type: Timestamp

name

The name of the service network.

Type: String

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

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

numberOfAssociatedServices

The number of services associated with the service network.

Type: Long

numberOfAssociatedVPCs

The number of VPCs associated with the service network.

Type: Long

sharingConfig

Specifies if the service network is enabled for sharing.

Type: SharingConfig object

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.

retryAfterSeconds: The number of seconds to wait before retrying.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 404

ThrottlingException

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

quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The number of seconds to wait before retrying.
serviceCode: The service code.

HTTP Status Code: 429

ValidationException

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

fieldList: The fields that failed validation.
reason: The reason.

HTTP Status Code: 400