Skip to content

WorkLinkClient#

Index > WorkLink > WorkLinkClient

Auto-generated documentation for WorkLink type annotations stubs module mypy-boto3-worklink.

WorkLinkClient#

Type annotations and code completion for boto3.client("worklink"). boto3 documentation

# WorkLinkClient usage example

from boto3.session import Session
from mypy_boto3_worklink.client import WorkLinkClient

def get_worklink_client() -> WorkLinkClient:
    return Session().client("worklink")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("worklink").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("worklink")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerErrorException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_worklink.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

associate_domain#

Specifies a domain to be associated to Amazon WorkLink.

Type annotations and code completion for boto3.client("worklink").associate_domain method. boto3 documentation

# associate_domain method definition

def associate_domain(
    self,
    *,
    FleetArn: str,
    DomainName: str,
    AcmCertificateArn: str,
    DisplayName: str = ...,
) -> Dict[str, Any]:
    ...
# associate_domain method usage example with argument unpacking

kwargs: AssociateDomainRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
    "DomainName": ...,
    "AcmCertificateArn": ...,
}

parent.associate_domain(**kwargs)
  1. See AssociateDomainRequestRequestTypeDef

associate_website_authorization_provider#

Associates a website authorization provider with a specified fleet.

Type annotations and code completion for boto3.client("worklink").associate_website_authorization_provider method. boto3 documentation

# associate_website_authorization_provider method definition

def associate_website_authorization_provider(
    self,
    *,
    FleetArn: str,
    AuthorizationProviderType: AuthorizationProviderTypeType,  # (1)
    DomainName: str = ...,
) -> AssociateWebsiteAuthorizationProviderResponseTypeDef:  # (2)
    ...
  1. See AuthorizationProviderTypeType
  2. See AssociateWebsiteAuthorizationProviderResponseTypeDef
# associate_website_authorization_provider method usage example with argument unpacking

kwargs: AssociateWebsiteAuthorizationProviderRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
    "AuthorizationProviderType": ...,
}

parent.associate_website_authorization_provider(**kwargs)
  1. See AssociateWebsiteAuthorizationProviderRequestRequestTypeDef

associate_website_certificate_authority#

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

Type annotations and code completion for boto3.client("worklink").associate_website_certificate_authority method. boto3 documentation

# associate_website_certificate_authority method definition

def associate_website_certificate_authority(
    self,
    *,
    FleetArn: str,
    Certificate: str,
    DisplayName: str = ...,
) -> AssociateWebsiteCertificateAuthorityResponseTypeDef:  # (1)
    ...
  1. See AssociateWebsiteCertificateAuthorityResponseTypeDef
# associate_website_certificate_authority method usage example with argument unpacking

kwargs: AssociateWebsiteCertificateAuthorityRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
    "Certificate": ...,
}

parent.associate_website_certificate_authority(**kwargs)
  1. See AssociateWebsiteCertificateAuthorityRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("worklink").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("worklink").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_fleet#

Creates a fleet.

Type annotations and code completion for boto3.client("worklink").create_fleet method. boto3 documentation

# create_fleet method definition

def create_fleet(
    self,
    *,
    FleetName: str,
    DisplayName: str = ...,
    OptimizeForEndUserLocation: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateFleetResponseTypeDef:  # (1)
    ...
  1. See CreateFleetResponseTypeDef
# create_fleet method usage example with argument unpacking

kwargs: CreateFleetRequestRequestTypeDef = {  # (1)
    "FleetName": ...,
}

parent.create_fleet(**kwargs)
  1. See CreateFleetRequestRequestTypeDef

delete_fleet#

Deletes a fleet.

Type annotations and code completion for boto3.client("worklink").delete_fleet method. boto3 documentation

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    FleetArn: str,
) -> Dict[str, Any]:
    ...
# delete_fleet method usage example with argument unpacking

kwargs: DeleteFleetRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
}

parent.delete_fleet(**kwargs)
  1. See DeleteFleetRequestRequestTypeDef

describe_audit_stream_configuration#

Describes the configuration for delivering audit streams to the customer account.

Type annotations and code completion for boto3.client("worklink").describe_audit_stream_configuration method. boto3 documentation

# describe_audit_stream_configuration method definition

def describe_audit_stream_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeAuditStreamConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeAuditStreamConfigurationResponseTypeDef
# describe_audit_stream_configuration method usage example with argument unpacking

kwargs: DescribeAuditStreamConfigurationRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
}

parent.describe_audit_stream_configuration(**kwargs)
  1. See DescribeAuditStreamConfigurationRequestRequestTypeDef

describe_company_network_configuration#

Describes the networking configuration to access the internal websites associated with the specified fleet.

Type annotations and code completion for boto3.client("worklink").describe_company_network_configuration method. boto3 documentation

# describe_company_network_configuration method definition

def describe_company_network_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeCompanyNetworkConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeCompanyNetworkConfigurationResponseTypeDef
# describe_company_network_configuration method usage example with argument unpacking

kwargs: DescribeCompanyNetworkConfigurationRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
}

parent.describe_company_network_configuration(**kwargs)
  1. See DescribeCompanyNetworkConfigurationRequestRequestTypeDef

describe_device#

Provides information about a user's device.

Type annotations and code completion for boto3.client("worklink").describe_device method. boto3 documentation

# describe_device method definition

def describe_device(
    self,
    *,
    FleetArn: str,
    DeviceId: str,
) -> DescribeDeviceResponseTypeDef:  # (1)
    ...
  1. See DescribeDeviceResponseTypeDef
# describe_device method usage example with argument unpacking

kwargs: DescribeDeviceRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
    "DeviceId": ...,
}

parent.describe_device(**kwargs)
  1. See DescribeDeviceRequestRequestTypeDef

describe_device_policy_configuration#

Describes the device policy configuration for the specified fleet.

Type annotations and code completion for boto3.client("worklink").describe_device_policy_configuration method. boto3 documentation

# describe_device_policy_configuration method definition

def describe_device_policy_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeDevicePolicyConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeDevicePolicyConfigurationResponseTypeDef
  2. <