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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DomainSummary

The summary of the domain.

Contents

CreatedTime

The time that the domain was created.

Type: Timestamp

Required: Yes

DisplayName

The name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

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

DomainStatus

The status of the domain.

Type: String

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

Required: Yes

See Also

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

On this page: