Table of Contents
A low-level client representing Amazon WorkLink:
import boto3
client = boto3.client('worklink')
These are the available methods:
Specifies a domain to be associated to Amazon WorkLink.
See also: AWS API Documentation
Request Syntax
response = client.associate_domain(
FleetArn='string',
DomainName='string',
DisplayName='string',
AcmCertificateArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
[REQUIRED]
The fully qualified domain name (FQDN).
[REQUIRED]
The ARN of an issued ACM certificate that is valid for the domain being associated.
dict
Response Syntax
{}
Response Structure
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
response = client.associate_website_authorization_provider(
FleetArn='string',
AuthorizationProviderType='SAML',
DomainName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The authorization provider type.
dict
Response Syntax
{
'AuthorizationProviderId': 'string'
}
Response Structure
(dict) --
AuthorizationProviderId (string) --
A unique identifier for the authorization provider.
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
See also: AWS API Documentation
Request Syntax
response = client.associate_website_certificate_authority(
FleetArn='string',
Certificate='string',
DisplayName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The root certificate of the CA.
dict
Response Syntax
{
'WebsiteCaId': 'string'
}
Response Structure
(dict) --
WebsiteCaId (string) --
A unique identifier for the CA.
Check if an operation can be paginated.
Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.
See also: AWS API Documentation
Request Syntax
response = client.create_fleet(
FleetName='string',
DisplayName='string',
OptimizeForEndUserLocation=True|False
)
[REQUIRED]
A unique name for the fleet.
dict
Response Syntax
{
'FleetArn': 'string'
}
Response Structure
(dict) --
FleetArn (string) --
The ARN of the fleet.
Deletes a fleet. Prevents users from accessing previously associated websites.
See also: AWS API Documentation
Request Syntax
response = client.delete_fleet(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{}
Response Structure
Describes the configuration for delivering audit streams to the customer account.
See also: AWS API Documentation
Request Syntax
response = client.describe_audit_stream_configuration(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{
'AuditStreamArn': 'string'
}
Response Structure
The ARN of the Amazon Kinesis data stream that will receive the audit events.
Describes the networking configuration to access the internal websites associated with the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_company_network_configuration(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
}
Response Structure
The VPC with connectivity to associated websites.
The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
The security groups associated with access to the provided subnets.
Provides information about a user's device.
See also: AWS API Documentation
Request Syntax
response = client.describe_device(
FleetArn='string',
DeviceId='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
A unique identifier for a registered user's device.
dict
Response Syntax
{
'Status': 'ACTIVE'|'SIGNED_OUT',
'Model': 'string',
'Manufacturer': 'string',
'OperatingSystem': 'string',
'OperatingSystemVersion': 'string',
'PatchLevel': 'string',
'FirstAccessedTime': datetime(2015, 1, 1),
'LastAccessedTime': datetime(2015, 1, 1),
'Username': 'string'
}
Response Structure
(dict) --
Status (string) --
The current state of the device.
Model (string) --
The model of the device.
Manufacturer (string) --
The manufacturer of the device.
OperatingSystem (string) --
The operating system of the device.
OperatingSystemVersion (string) --
The operating system version of the device.
PatchLevel (string) --
The operating system patch level of the device.
FirstAccessedTime (datetime) --
The date that the device first signed in to Amazon WorkLink.
LastAccessedTime (datetime) --
The date that the device last accessed Amazon WorkLink.
Username (string) --
The user name associated with the device.
Describes the device policy configuration for the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_device_policy_configuration(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{
'DeviceCaCertificate': 'string'
}
Response Structure
The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
Provides information about the domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain(
FleetArn='string',
DomainName='string'
)
[REQUIRED]
The ARN of the fleet.
[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.
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_metadata(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'FleetName': 'string',
'DisplayName': 'string',
'OptimizeForEndUserLocation': True|False,
'CompanyCode': 'string',
'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE'
}
Response Structure
The time that the fleet was created.
The time that the fleet was last updated.
The name of the fleet.
The name to display.
The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
The identifier used by users to sign in to the Amazon WorkLink app.
The current state of the fleet.
Describes the identity provider configuration of the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_identity_provider_configuration(
FleetArn='string'
)
[REQUIRED]
The ARN of the fleet.
{
'IdentityProviderType': 'SAML',
'ServiceProviderSamlMetadata': 'string',
'IdentityProviderSamlMetadata': 'string'
}
Response Structure
The type of identity provider.
The SAML metadata document uploaded to the user’s identity provider.
The SAML metadata document provided by the user’s identity provider.
Provides information about the certificate authority.
See also: AWS API Documentation
Request Syntax
response = client.describe_website_certificate_authority(
FleetArn='string',
WebsiteCaId='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
A unique identifier for the certificate authority.
dict
Response Syntax
{
'Certificate': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DisplayName': 'string'
}
Response Structure
(dict) --
Certificate (string) --
The root certificate of the certificate authority.
CreatedTime (datetime) --
The time that the certificate authority was added.
DisplayName (string) --
The certificate name to display.
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
response = client.disassociate_domain(
FleetArn='string',
DomainName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{}
Response Structure
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
response = client.disassociate_website_authorization_provider(
FleetArn='string',
AuthorizationProviderId='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
A unique identifier for the authorization provider.
dict
Response Syntax
{}
Response Structure
Removes a certificate authority (CA).
See also: AWS API Documentation
Request Syntax
response = client.disassociate_website_certificate_authority(
FleetArn='string',
WebsiteCaId='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
A unique identifier for the CA.
dict
Response Syntax
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves a list of devices registered with the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.list_devices(
FleetArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'Devices': [
{
'DeviceId': 'string',
'DeviceStatus': 'ACTIVE'|'SIGNED_OUT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Devices (list) --
Information about the devices.
(dict) --
The summary of devices.
DeviceId (string) --
The ID of the device.
DeviceStatus (string) --
The status of the device.
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.
Retrieves a list of domains associated to a specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.list_domains(
FleetArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'Domains': [
{
'DomainName': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DomainStatus': 'PENDING_VALIDATION'|'ASSOCIATING'|'ACTIVE'|'INACTIVE'|'DISASSOCIATING'|'DISASSOCIATED'|'FAILED_TO_ASSOCIATE'|'FAILED_TO_DISASSOCIATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Domains (list) --
Information about the domains.
(dict) --
The summary of the domain.
DomainName (string) --
The name of the domain.
DisplayName (string) --
The name to display.
CreatedTime (datetime) --
The time that the domain was created.
DomainStatus (string) --
The status of the domain.
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.
Retrieves a list of fleets for the current account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_fleets(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'FleetSummaryList': [
{
'FleetArn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'FleetName': 'string',
'DisplayName': 'string',
'CompanyCode': 'string',
'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetSummaryList (list) --
The summary list of the fleets.
(dict) --
The summary of the fleet.
FleetArn (string) --
The ARN of the fleet.
CreatedTime (datetime) --
The time when the fleet was created.
LastUpdatedTime (datetime) --
The time when the fleet was last updated.
FleetName (string) --
The name of the fleet.
DisplayName (string) --
The name to display.
CompanyCode (string) --
The identifier used by users to sign into the Amazon WorkLink app.
FleetStatus (string) --
The status of the fleet.
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.
Retrieves a list of website authorization providers associated with a specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.list_website_authorization_providers(
FleetArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of the fleet.
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.
Retrieves a list of certificate authorities added for the current account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_website_certificate_authorities(
FleetArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'WebsiteCertificateAuthorities': [
{
'WebsiteCaId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DisplayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WebsiteCertificateAuthorities (list) --
Information about the certificates.
(dict) --
The summary of the certificate authority (CA).
WebsiteCaId (string) --
A unique identifier for the CA.
CreatedTime (datetime) --
The time when the CA was added.
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.
Moves a domain to ACTIVE status if it was in the INACTIVE status.
See also: AWS API Documentation
Request Syntax
response = client.restore_domain_access(
FleetArn='string',
DomainName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{}
Response Structure
Moves a domain to INACTIVE status if it was in the ACTIVE status.
See also: AWS API Documentation
Request Syntax
response = client.revoke_domain_access(
FleetArn='string',
DomainName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{}
Response Structure
Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
See also: AWS API Documentation
Request Syntax
response = client.sign_out_user(
FleetArn='string',
Username='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The name of the user.
dict
Response Syntax
{}
Response Structure
Updates the audit stream configuration for the fleet.
See also: AWS API Documentation
Request Syntax
response = client.update_audit_stream_configuration(
FleetArn='string',
AuditStreamArn='string'
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{}
Response Structure
Updates the company network configuration for the fleet.
See also: AWS API Documentation
Request Syntax
response = client.update_company_network_configuration(
FleetArn='string',
VpcId='string',
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
]
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The VPC with connectivity to associated websites.
[REQUIRED]
The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
[REQUIRED]
The security groups associated with access to the provided subnets.
dict
Response Syntax
{}
Response Structure
Updates the device policy configuration for the fleet.
See also: AWS API Documentation
Request Syntax
response = client.update_device_policy_configuration(
FleetArn='string',
DeviceCaCertificate='string'
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{}
Response Structure
Updates domain metadata, such as DisplayName.
See also: AWS API Documentation
Request Syntax
response = client.update_domain_metadata(
FleetArn='string',
DomainName='string',
DisplayName='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The name of the domain.
dict
Response Syntax
{}
Response Structure
Updates fleet metadata, such as DisplayName.
See also: AWS API Documentation
Request Syntax
response = client.update_fleet_metadata(
FleetArn='string',
DisplayName='string',
OptimizeForEndUserLocation=True|False
)
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{}
Response Structure
Updates the identity provider configuration for the fleet.
See also: AWS API Documentation
Request Syntax
response = client.update_identity_provider_configuration(
FleetArn='string',
IdentityProviderType='SAML',
IdentityProviderSamlMetadata='string'
)
[REQUIRED]
The ARN of the fleet.
[REQUIRED]
The type of identity provider.
dict
Response Syntax
{}
Response Structure
The available paginators are: