WorkLink / Client / describe_domain

describe_domain#

WorkLink.Client.describe_domain(**kwargs)#

Provides information about the domain.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain(
    FleetArn='string',
    DomainName='string'
)

Parameters:

FleetArn (string) –
[REQUIRED]

The ARN of the fleet.
DomainName (string) –
[REQUIRED]

The name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'DomainName': 'string',
    'DisplayName': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'DomainStatus': 'PENDING_VALIDATION'|'ASSOCIATING'|'ACTIVE'|'INACTIVE'|'DISASSOCIATING'|'DISASSOCIATED'|'FAILED_TO_ASSOCIATE'|'FAILED_TO_DISASSOCIATE',
    'AcmCertificateArn': 'string'
}

Response Structure

(dict) –
- DomainName (string) –
  
  The name of the domain.
- DisplayName (string) –
  
  The name to display.
- CreatedTime (datetime) –
  
  The time that the domain was added.
- DomainStatus (string) –
  
  The current state for the domain.
- AcmCertificateArn (string) –
  
  The ARN of an issued ACM certificate that is valid for the domain being associated.

Exceptions

WorkLink.Client.exceptions.UnauthorizedException
WorkLink.Client.exceptions.InternalServerErrorException
WorkLink.Client.exceptions.InvalidRequestException
WorkLink.Client.exceptions.ResourceNotFoundException
WorkLink.Client.exceptions.TooManyRequestsException