2019/05/22 - Amazon WorkLink - 3 new1 updated api methods
Changes Update worklink client to latest version
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 )
string
[REQUIRED]
The ARN of the fleet.
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.
integer
The maximum number of results to be included in the next page.
dict
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.
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' )
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
A unique identifier for the authorization provider.
dict
Response Syntax
{}
Response Structure
(dict) --
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' )
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The authorization provider type.
string
The domain name of the authorization provider. This applies only to SAML-based authorization providers.
dict
Response Syntax
{ 'AuthorizationProviderId': 'string' }
Response Structure
(dict) --
AuthorizationProviderId (string) --
A unique identifier for the authorization provider.
{'AcmCertificateArn': 'string', 'DomainName': 'string'}
Provides information about the domain.
See also: AWS API Documentation
Request Syntax
client.describe_domain( FleetArn='string', DomainName='string' )
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The name of the domain.
dict
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.