Amazon WorkLink

2019/04/18 - Amazon WorkLink - 7 new api methods

Changes  Amazon WorkLink is a fully managed, cloud-based service that enables secure, one-click access to internal websites and web apps from mobile phones. This release introduces new APIs to link and manage internal websites and web apps with Amazon WorkLink fleets.

DisassociateDomain (new) Link ¶

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

See also: AWS API Documentation

Request Syntax

client.disassociate_domain(
    FleetArn='string',
    DomainName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

RestoreDomainAccess (new) Link ¶

Moves a domain to ACTIVE status if it was in the INACTIVE status.

See also: AWS API Documentation

Request Syntax

client.restore_domain_access(
    FleetArn='string',
    DomainName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeDomain (new) Link ¶

Provides information about the domain.

See also: AWS API Documentation

Request Syntax

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

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • DisplayName (string) --

      The name to display.

    • CreatedTime (datetime) --

      The time that the domain was added.

    • DomainStatus (string) --

      The current state for the domain.

AssociateDomain (new) Link ¶

Specifies a domain to be associated to Amazon WorkLink.

See also: AWS API Documentation

Request Syntax

client.associate_domain(
    FleetArn='string',
    DomainName='string',
    AcmCertificateArn='string',
    DisplayName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The fully qualified domain name (FQDN).

type AcmCertificateArn

string

param AcmCertificateArn

[REQUIRED]

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

type DisplayName

string

param DisplayName

The name to display.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UpdateDomainMetadata (new) Link ¶

Updates domain metadata, such as DisplayName.

See also: AWS API Documentation

Request Syntax

client.update_domain_metadata(
    FleetArn='string',
    DomainName='string',
    DisplayName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type DisplayName

string

param DisplayName

The name to display.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListDomains (new) Link ¶

Retrieves a list of domains associated to a specified fleet.

See also: AWS API Documentation

Request Syntax

client.list_domains(
    FleetArn='string',
    NextToken='string',
    MaxResults=123
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type NextToken

string

param NextToken

The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

type MaxResults

integer

param MaxResults

The maximum number of results to be included in the next page.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • Domains (list) --

      Information about the domains.

      • (dict) --

        The summary of the domain.

        • DomainName (string) --

          The name of the domain.

        • CreatedTime (datetime) --

          The time that the domain was created.

        • DomainStatus (string) --

          The status of the domain.

        • DisplayName (string) --

          The name to display.

    • NextToken (string) --

      The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

RevokeDomainAccess (new) Link ¶

Moves a domain to INACTIVE status if it was in the ACTIVE status.

See also: AWS API Documentation

Request Syntax

client.revoke_domain_access(
    FleetArn='string',
    DomainName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --