GetService
Retrieves information about the specified service.
Request Syntax
GET /services/serviceIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- serviceIdentifier
-
The ID or Amazon Resource Name (ARN) of the service.
Length Constraints: Minimum length of 17. Maximum length of 2048.
Pattern:
^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[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",
"certificateArn": "string",
"createdAt": "string",
"customDomainName": "string",
"dnsEntry": {
"domainName": "string",
"hostedZoneId": "string"
},
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "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 service.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$ - authType
-
The type of IAM policy.
Type: String
Valid Values:
NONE | AWS_IAM - certificateArn
-
The Amazon Resource Name (ARN) of the certificate.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$ - createdAt
-
The date and time that the service was created, specified in ISO-8601 format.
Type: Timestamp
- customDomainName
-
The custom domain name of the service.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
- dnsEntry
-
The DNS name of the service.
Type: DnsEntry object
- failureCode
-
The failure code.
Type: String
- failureMessage
-
The failure message.
Type: String
- id
-
The ID of the service.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
^svc-[0-9a-z]{17}$ - lastUpdatedAt
-
The date and time that the service was last updated, specified in ISO-8601 format.
Type: Timestamp
- name
-
The name of the service.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 40.
Pattern:
^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ - status
-
The status of the service.
Type: String
Valid Values:
ACTIVE | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
