Navigation

  • index
  • modules |
  • next |
  • previous |
  • Boto3 Docs 1.18.5 documentation »
  • Available services »
Boto3 Docs 1.18.5 documentation

Table Of Contents

  • Quickstart
  • A sample tutorial
  • Code examples
  • Developer guide
  • Security
  • Available services
    • AccessAnalyzer
    • ACM
    • ACMPCA
    • AlexaForBusiness
    • PrometheusService
    • Amplify
    • AmplifyBackend
    • APIGateway
    • ApiGatewayManagementApi
    • ApiGatewayV2
    • AppConfig
    • Appflow
    • AppIntegrationsService
    • ApplicationAutoScaling
    • ApplicationInsights
    • ApplicationCostProfiler
    • AppMesh
    • AppRunner
    • AppStream
    • AppSync
    • Athena
    • AuditManager
    • AutoScaling
    • AutoScalingPlans
    • Backup
    • Batch
    • Braket
    • Budgets
    • CostExplorer
    • Chime
    • Cloud9
    • CloudDirectory
    • CloudFormation
    • CloudFront
    • CloudHSM
    • CloudHSMV2
    • CloudSearch
    • CloudSearchDomain
    • CloudTrail
    • CloudWatch
    • CodeArtifact
    • CodeBuild
    • CodeCommit
    • CodeDeploy
    • CodeGuruReviewer
    • CodeGuruProfiler
    • CodePipeline
    • CodeStar
    • CodeStarconnections
    • CodeStarNotifications
    • CognitoIdentity
    • CognitoIdentityProvider
    • CognitoSync
    • Comprehend
    • ComprehendMedical
    • ComputeOptimizer
    • ConfigService
    • Connect
    • ConnectContactLens
    • ConnectParticipant
    • CostandUsageReportService
    • CustomerProfiles
    • GlueDataBrew
    • DataExchange
    • DataPipeline
    • DataSync
    • DAX
    • Detective
    • DeviceFarm
    • DevOpsGuru
    • DirectConnect
    • ApplicationDiscoveryService
    • DLM
    • DatabaseMigrationService
    • DocDB
    • DirectoryService
    • DynamoDB
    • DynamoDBStreams
    • EBS
    • EC2
    • EC2InstanceConnect
    • ECR
    • ECRPublic
    • ECS
    • EFS
    • EKS
    • ElasticInference
    • ElastiCache
    • ElasticBeanstalk
    • ElasticTranscoder
    • ElasticLoadBalancing
    • ElasticLoadBalancingv2
    • EMR
    • EMRContainers
    • ElasticsearchService
    • EventBridge
    • finspace
    • FinSpaceData
    • Firehose
    • FIS
    • FMS
    • ForecastService
    • ForecastQueryService
    • FraudDetector
    • FSx
    • GameLift
    • Glacier
    • GlobalAccelerator
    • Glue
    • Greengrass
    • GreengrassV2
    • GroundStation
    • GuardDuty
    • Health
    • HealthLake
    • Honeycode
    • IAM
    • IdentityStore
    • imagebuilder
    • ImportExport
    • Inspector
    • IoT
    • IoTDataPlane
    • IoTJobsDataPlane
    • IoT1ClickDevicesService
    • IoT1ClickProjects
    • IoTAnalytics
    • IoTDeviceAdvisor
    • IoTEvents
    • IoTEventsData
    • IoTFleetHub
    • IoTSecureTunneling
    • IoTSiteWise
    • IoTThingsGraph
    • IoTWireless
    • IVS
    • Kafka
    • kendra
    • Kinesis
    • KinesisVideoArchivedMedia
    • KinesisVideoMedia
    • KinesisVideoSignalingChannels
    • KinesisAnalytics
    • KinesisAnalyticsV2
    • KinesisVideo
    • KMS
    • LakeFormation
    • Lambda
    • LexModelBuildingService
    • LexRuntimeService
    • LexModelsV2
    • LexRuntimeV2
    • LicenseManager
    • Lightsail
    • LocationService
    • CloudWatchLogs
    • LookoutEquipment
    • LookoutMetrics
    • LookoutforVision
    • MachineLearning
    • Macie
    • Macie2
    • ManagedBlockchain
    • MarketplaceCatalog
    • MarketplaceEntitlementService
    • MarketplaceCommerceAnalytics
    • MediaConnect
    • MediaConvert
    • MediaLive
    • MediaPackage
    • MediaPackageVod
    • MediaStore
    • MediaStoreData
    • MediaTailor
    • MarketplaceMetering
    • MigrationHub
    • mgn
    • MigrationHubConfig
    • Mobile
    • MQ
    • MTurk
    • MWAA
    • Neptune
    • NetworkFirewall
    • NetworkManager
    • NimbleStudio
    • OpsWorks
    • OpsWorksCM
    • Organizations
    • Outposts
    • Personalize
    • PersonalizeEvents
    • PersonalizeRuntime
    • PI
    • Pinpoint
    • PinpointEmail
    • PinpointSMSVoice
    • Polly
    • Pricing
    • Proton
    • QLDB
    • QLDBSession
    • QuickSight
    • RAM
    • RDS
    • RDSDataService
    • Redshift
    • RedshiftDataAPIService
    • Rekognition
    • ResourceGroups
    • ResourceGroupsTaggingAPI
    • RoboMaker
    • Route53
    • Route53Domains
    • Route53Resolver
    • S3
    • S3Control
    • S3Outposts
    • SageMaker
    • AugmentedAIRuntime
    • SagemakerEdgeManager
    • SageMakerFeatureStoreRuntime
    • SageMakerRuntime
    • SavingsPlans
    • Schemas
    • SimpleDB
    • SecretsManager
    • SecurityHub
    • ServerlessApplicationRepository
    • ServiceQuotas
    • ServiceCatalog
    • AppRegistry
    • ServiceDiscovery
    • SES
    • SESV2
    • Shield
    • signer
    • SMS
    • PinpointSMSVoice
    • Snowball
    • SNS
    • SQS
    • SSM
    • SSMContacts
    • SSMIncidents
    • SSO
    • SSOAdmin
    • SSOOIDC
    • SFN
    • StorageGateway
    • STS
    • Support
    • SWF
    • Synthetics
    • Textract
    • TimestreamQuery
    • TimestreamWrite
    • TranscribeService
    • Transfer
    • Translate
    • WAF
    • WAFRegional
    • WAFV2
    • WellArchitected
    • WorkDocs
    • WorkLink
      • Client
      • Paginators
    • WorkMail
    • WorkMailMessageFlow
    • WorkSpaces
    • XRay
  • Core references
  • Customization references
  1. Docs
  2. Available services
  3. WorkLink

WorkLink¶

Table of Contents

  • WorkLink
    • Client
    • Paginators

Client¶

class WorkLink.Client¶

A low-level client representing Amazon WorkLink

Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.

import boto3

client = boto3.client('worklink')

These are the available methods:

associate_domain(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the fleet.

  • DomainName (string) --

    [REQUIRED]

    The fully qualified domain name (FQDN).

  • DisplayName (string) -- The name to display.
  • AcmCertificateArn (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.ResourceAlreadyExistsException
  • WorkLink.Client.exceptions.TooManyRequestsException
associate_website_authorization_provider(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • AuthorizationProviderType (string) --

    [REQUIRED]

    The authorization provider type.

  • DomainName (string) -- The domain name of the authorization provider. This applies only to SAML-based authorization providers.
Return type

dict

Returns

Response Syntax

{
    'AuthorizationProviderId': 'string'
}

Response Structure

  • (dict) --

    • AuthorizationProviderId (string) --

      A unique identifier for the authorization provider.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.ResourceAlreadyExistsException
  • WorkLink.Client.exceptions.TooManyRequestsException
associate_website_certificate_authority(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • Certificate (string) --

    [REQUIRED]

    The root certificate of the CA.

  • DisplayName (string) -- The certificate name to display.
Return type

dict

Returns

Response Syntax

{
    'WebsiteCaId': 'string'
}

Response Structure

  • (dict) --

    • WebsiteCaId (string) --

      A unique identifier for the CA.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.ResourceAlreadyExistsException
  • WorkLink.Client.exceptions.TooManyRequestsException
can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_fleet(**kwargs)¶

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,
    Tags={
        'string': 'string'
    }
)
Parameters
  • FleetName (string) --

    [REQUIRED]

    A unique name for the fleet.

  • DisplayName (string) -- The fleet name to display.
  • OptimizeForEndUserLocation (boolean) -- 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.
  • Tags (dict) --

    The tags to add to the resource. A tag is a key-value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'FleetArn': 'string'
}

Response Structure

  • (dict) --

    • FleetArn (string) --

      The Amazon Resource Name (ARN) of the fleet.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.ResourceAlreadyExistsException
  • WorkLink.Client.exceptions.TooManyRequestsException
delete_fleet(**kwargs)¶

Deletes a fleet. Prevents users from accessing previously associated websites.

See also: AWS API Documentation

Request Syntax

response = client.delete_fleet(
    FleetArn='string'
)
Parameters
FleetArn (string) --

[REQUIRED]

The ARN of the fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_audit_stream_configuration(**kwargs)¶

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'
)
Parameters
FleetArn (string) --

[REQUIRED]

The ARN of the fleet.

Return type
dict
Returns
Response Syntax
{
    'AuditStreamArn': 'string'
}

Response Structure

  • (dict) --
    • AuditStreamArn (string) --

      The ARN of the Amazon Kinesis data stream that will receive the audit events.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_company_network_configuration(**kwargs)¶

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'
)
Parameters
FleetArn (string) --

[REQUIRED]

The ARN of the fleet.

Return type
dict
Returns
Response Syntax
{
    'VpcId': 'string',
    'SubnetIds': [
        'string',
    ],
    'SecurityGroupIds': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • VpcId (string) --

      The VPC with connectivity to associated websites.

    • SubnetIds (list) --

      The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

      • (string) --
    • SecurityGroupIds (list) --

      The security groups associated with access to the provided subnets.

      • (string) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_device(**kwargs)¶

Provides information about a user's device.

See also: AWS API Documentation

Request Syntax

response = client.describe_device(
    FleetArn='string',
    DeviceId='string'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DeviceId (string) --

    [REQUIRED]

    A unique identifier for a registered user's device.

Return type

dict

Returns

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_device_policy_configuration(**kwargs)¶

Describes the device policy configuration for the specified fleet.

See also: AWS API Documentation

Request Syntax

response = client.describe_device_policy_configuration(
    FleetArn='string'
)
Parameters
FleetArn (string) --

[REQUIRED]

The ARN of the fleet.

Return type
dict
Returns
Response Syntax
{
    'DeviceCaCertificate': 'string'
}

Response Structure

  • (dict) --
    • DeviceCaCertificate (string) --

      The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_domain(**kwargs)¶

Provides information about the domain.

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
describe_fleet_metadata(**kwargs)¶

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'
)
Parameters
FleetArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type
dict
Returns
Response Syntax
{
    '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',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • CreatedTime (datetime) --

      The time that the fleet was created.

    • LastUpdatedTime (datetime) --

      The time that the fleet was last updated.

    • FleetName (string) --

      The name of the fleet.

    • DisplayName (string) --

      The name to display.

    • OptimizeForEndUserLocation (boolean) --

      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.

    • CompanyCode (string) --

      The identifier used by users to sign in to the Amazon WorkLink app.

    • FleetStatus (string) --

      The current state of the fleet.

    • Tags (dict) --

      The tags attached to the resource. A tag is a key-value pair.

      • (string) --
        • (string) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_identity_provider_configuration(**kwargs)¶

Describes the identity provider configuration of the specified fleet.

See also: AWS API Documentation

Request Syntax

response = client.describe_identity_provider_configuration(
    FleetArn='string'
)
Parameters
FleetArn (string) --

[REQUIRED]

The ARN of the fleet.

Return type
dict
Returns
Response Syntax
{
    'IdentityProviderType': 'SAML',
    'ServiceProviderSamlMetadata': 'string',
    'IdentityProviderSamlMetadata': 'string'
}

Response Structure

  • (dict) --
    • IdentityProviderType (string) --

      The type of identity provider.

    • ServiceProviderSamlMetadata (string) --

      The SAML metadata document uploaded to the user’s identity provider.

    • IdentityProviderSamlMetadata (string) --

      The SAML metadata document provided by the user’s identity provider.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
describe_website_certificate_authority(**kwargs)¶

Provides information about the certificate authority.

See also: AWS API Documentation

Request Syntax

response = client.describe_website_certificate_authority(
    FleetArn='string',
    WebsiteCaId='string'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • WebsiteCaId (string) --

    [REQUIRED]

    A unique identifier for the certificate authority.

Return type

dict

Returns

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
disassociate_domain(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
disassociate_website_authorization_provider(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • AuthorizationProviderId (string) --

    [REQUIRED]

    A unique identifier for the authorization provider.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.ResourceAlreadyExistsException
  • WorkLink.Client.exceptions.TooManyRequestsException
disassociate_website_certificate_authority(**kwargs)¶

Removes a certificate authority (CA).

See also: AWS API Documentation

Request Syntax

response = client.disassociate_website_certificate_authority(
    FleetArn='string',
    WebsiteCaId='string'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • WebsiteCaId (string) --

    [REQUIRED]

    A unique identifier for the CA.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_devices(**kwargs)¶

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
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • NextToken (string) -- The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • MaxResults (integer) -- The maximum number of results to be included in the next page.
Return type

dict

Returns

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
list_domains(**kwargs)¶

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
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • NextToken (string) -- The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • MaxResults (integer) -- The maximum number of results to be included in the next page.
Return type

dict

Returns

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
list_fleets(**kwargs)¶

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
)
Parameters
  • NextToken (string) -- The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  • MaxResults (integer) -- The maximum number of results to be included in the next page.
Return type

dict

Returns

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',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • FleetSummaryList (list) --

      The summary list of the fleets.

      • (dict) --

        The summary of the fleet.

        • FleetArn (string) --

          The Amazon Resource Name (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 of the fleet to display.

        • CompanyCode (string) --

          The identifier used by users to sign into the Amazon WorkLink app.

        • FleetStatus (string) --

          The status of the fleet.

        • Tags (dict) --

          The tags attached to the resource. A tag is a key-value pair.

          • (string) --
            • (string) --
    • 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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.TooManyRequestsException
list_tags_for_resource(**kwargs)¶

Retrieves a list of tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The tags attached to the resource. A tag is a key-value pair.

      • (string) --
        • (string) --

Exceptions

  • WorkLink.Client.exceptions.InvalidRequestException
list_website_authorization_providers(**kwargs)¶

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
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • 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.
  • MaxResults (integer) -- The maximum number of results to be included in the next page.
Return type

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
list_website_certificate_authorities(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • MaxResults (integer) -- The maximum number of results to be included in the next page.
  • NextToken (string) -- The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Return type

dict

Returns

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.

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.TooManyRequestsException
restore_domain_access(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
revoke_domain_access(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
sign_out_user(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • Username (string) --

    [REQUIRED]

    The name of the user.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
tag_resource(**kwargs)¶

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the fleet.

  • Tags (dict) --

    [REQUIRED]

    The tags to add to the resource. A tag is a key-value pair.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.InvalidRequestException
untag_resource(**kwargs)¶

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the fleet.

  • TagKeys (list) --

    [REQUIRED]

    The list of tag keys to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.InvalidRequestException
update_audit_stream_configuration(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • AuditStreamArn (string) -- The ARN of the Amazon Kinesis data stream that receives the audit events.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
update_company_network_configuration(**kwargs)¶

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',
    ]
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • VpcId (string) --

    [REQUIRED]

    The VPC with connectivity to associated websites.

  • SubnetIds (list) --

    [REQUIRED]

    The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

    • (string) --
  • SecurityGroupIds (list) --

    [REQUIRED]

    The security groups associated with access to the provided subnets.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
update_device_policy_configuration(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DeviceCaCertificate (string) -- The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
update_domain_metadata(**kwargs)¶

Updates domain metadata, such as DisplayName.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_metadata(
    FleetArn='string',
    DomainName='string',
    DisplayName='string'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DomainName (string) --

    [REQUIRED]

    The name of the domain.

  • DisplayName (string) -- The name to display.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
update_fleet_metadata(**kwargs)¶

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
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DisplayName (string) -- The fleet name to display. The existing DisplayName is unset if null is passed.
  • OptimizeForEndUserLocation (boolean) -- 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException
update_identity_provider_configuration(**kwargs)¶

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'
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • IdentityProviderType (string) --

    [REQUIRED]

    The type of identity provider.

  • IdentityProviderSamlMetadata (string) -- The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

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

Paginators¶

The available paginators are:

WorkDocs
WorkMail

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Boto3 Docs 1.18.5 documentation »
  • Available services »
Privacy | Site Terms | Cookie preferences | © Copyright 2021, Amazon Web Services, Inc. Created using Sphinx.