Amazon WorkLink
API Reference (API Version 2018-09-25)

DescribeDomain

Provides information about the domain.

Request Syntax

POST /describeDomain HTTP/1.1 Content-type: application/json { "DomainName": "string", "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DomainName

The name of the domain.

Type: String

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

Pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$

Required: Yes

FleetArn

The ARN of the fleet.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AcmCertificateArn": "string", "CreatedTime": number, "DisplayName": "string", "DomainName": "string", "DomainStatus": "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.

AcmCertificateArn

The ARN of an issued ACM certificate that is valid for the domain being associated.

Type: String

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=/,.@-]+)*

CreatedTime

The time that the domain was added.

Type: Timestamp

DisplayName

The name to display.

Type: String

Length Constraints: Maximum length of 100.

DomainName

The name of the domain.

Type: String

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

Pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$

DomainStatus

The current state for the domain.

Type: String

Valid Values: PENDING_VALIDATION | ASSOCIATING | ACTIVE | INACTIVE | DISASSOCIATING | DISASSOCIATED | FAILED_TO_ASSOCIATE | FAILED_TO_DISASSOCIATE

Errors

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

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: