GetService - AWS Migration Hub Refactor Spaces

GetService

Gets an AWS Migration Hub Refactor Spaces service.

Request Syntax

GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/services/ServiceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The ID of the application.

Length Constraints: Fixed length of 14.

Pattern: ^app-[0-9A-Za-z]{10}$

Required: Yes

EnvironmentIdentifier

The ID of the environment.

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Required: Yes

ServiceIdentifier

The ID of the service.

Length Constraints: Fixed length of 14.

Pattern: ^svc-[0-9A-Za-z]{10}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Arn": "string", "CreatedByAccountId": "string", "CreatedTime": number, "Description": "string", "EndpointType": "string", "EnvironmentId": "string", "Error": { "AccountId": "string", "AdditionalDetails": { "string" : "string" }, "Code": "string", "Message": "string", "ResourceIdentifier": "string", "ResourceType": "string" }, "LambdaEndpoint": { "Arn": "string" }, "LastUpdatedTime": number, "Name": "string", "OwnerAccountId": "string", "ServiceId": "string", "State": "string", "Tags": { "string" : "string" }, "UrlEndpoint": { "HealthUrl": "string", "Url": "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.

ApplicationId

The ID of the application.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^app-[0-9A-Za-z]{10}$

Arn

The Amazon Resource Name (ARN) of the service.

Type: String

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

Pattern: ^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$

CreatedByAccountId

The AWS account ID of the service creator.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

CreatedTime

The timestamp of when the service is created.

Type: Timestamp

Description

The description of the service.

Type: String

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

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

EndpointType

The endpoint type of the service.

Type: String

Valid Values: LAMBDA | URL

EnvironmentId

The unique identifier of the environment.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Error

Any error associated with the service resource.

Type: ErrorResponse object

LambdaEndpoint

The configuration for the AWS Lambda endpoint type.

The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.

Type: LambdaEndpointConfig object

LastUpdatedTime

A timestamp that indicates when the service was last updated.

Type: Timestamp

Name

The name of the service.

Type: String

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

Pattern: ^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$

OwnerAccountId

The AWS account ID of the service owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

ServiceId

The unique identifier of the service.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^svc-[0-9A-Za-z]{10}$

State

The current state of the service.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED

Tags

The tags assigned to the service. A tag is a label that you assign to an AWS resource. Each tag consists of a key-value pair.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:).+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

UrlEndpoint

The configuration for the URL endpoint type.

The Url isthe URL of the endpoint type.

The HealthUrl is the health check URL of the endpoint type.

Type: UrlEndpointConfig object

VpcId

The ID of the virtual private cloud (VPC).

Type: String

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

Pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$

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

Request was denied because the request was throttled.

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: