Amazon WorkLink

2019/05/22 - Amazon WorkLink - 3 new 1 updated 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 associate and manage website authorization providers with Amazon WorkLink fleets.

AssociateWebsiteAuthorizationProvider (new) Link ¶

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

See also: AWS API Documentation

Request Syntax

client.associate_website_authorization_provider(
    FleetArn='string',
    AuthorizationProviderType='SAML',
    DomainName='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type AuthorizationProviderType

string

param AuthorizationProviderType

[REQUIRED]

The authorization provider type.

type DomainName

string

param DomainName

The domain name of the authorization provider. This applies only to SAML-based authorization providers.

rtype

dict

returns

Response Syntax

{
    'AuthorizationProviderId': 'string'
}

Response Structure

  • (dict) --

    • AuthorizationProviderId (string) --

      A unique identifier for the authorization provider.

ListWebsiteAuthorizationProviders (new) Link ¶

Retrieves a list of website authorization providers associated with a specified fleet.

See also: AWS API Documentation

Request Syntax

client.list_website_authorization_providers(
    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 to use 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

{
    'WebsiteAuthorizationProviders': [
        {
            'AuthorizationProviderId': 'string',
            'AuthorizationProviderType': 'SAML',
            'DomainName': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • WebsiteAuthorizationProviders (list) --

      The website authorization providers.

      • (dict) --

        The summary of the website authorization provider.

        • AuthorizationProviderId (string) --

          A unique identifier for the authorization provider.

        • AuthorizationProviderType (string) --

          The authorization provider type.

        • DomainName (string) --

          The domain name of the authorization provider. This applies only to SAML-based authorization providers.

        • CreatedTime (datetime) --

          The time of creation.

    • NextToken (string) --

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

DisassociateWebsiteAuthorizationProvider (new) Link ¶

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

See also: AWS API Documentation

Request Syntax

client.disassociate_website_authorization_provider(
    FleetArn='string',
    AuthorizationProviderId='string'
)
type FleetArn

string

param FleetArn

[REQUIRED]

The ARN of the fleet.

type AuthorizationProviderId

string

param AuthorizationProviderId

[REQUIRED]

A unique identifier for the authorization provider.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeDomain (updated) Link ¶
Changes (response) 
{'AcmCertificateArn': 'string', 'DomainName': 'string'}

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

{
    '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.