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

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.

Usage example

client = boto3.client("worklink")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalServerErrorException,
    client.InvalidRequestException,
    client.ResourceAlreadyExistsException,
    client.ResourceNotFoundException,
    client.TooManyRequestsException,
    client.UnauthorizedException,
) as e:
    print(e)

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

Method definition

def associate_domain(
    self,
    *,
    FleetArn: str,
    DomainName: str,
    AcmCertificateArn: str,
    DisplayName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def associate_website_authorization_provider(
    self,
    *,
    FleetArn: str,
    AuthorizationProviderType: AuthorizationProviderTypeType,  # (1)
    DomainName: str = ...,
) -> AssociateWebsiteAuthorizationProviderResponseTypeDef:  # (2)
    ...

1. See AuthorizationProviderTypeType
2. See AssociateWebsiteAuthorizationProviderResponseTypeDef

Usage example with kwargs

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

Method definition

def associate_website_certificate_authority(
    self,
    *,
    FleetArn: str,
    Certificate: str,
    DisplayName: str = ...,
) -> AssociateWebsiteCertificateAuthorityResponseTypeDef:  # (1)
    ...

1. See AssociateWebsiteCertificateAuthorityResponseTypeDef

Usage example with kwargs

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

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

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

Method definition

def create_fleet(
    self,
    *,
    FleetName: str,
    DisplayName: str = ...,
    OptimizeForEndUserLocation: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateFleetResponseTypeDef:  # (1)
    ...

1. See CreateFleetResponseTypeDef

Usage example with kwargs

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

Method definition

def delete_fleet(
    self,
    *,
    FleetArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def describe_audit_stream_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeAuditStreamConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeAuditStreamConfigurationResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_company_network_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeCompanyNetworkConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeCompanyNetworkConfigurationResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_device(
    self,
    *,
    FleetArn: str,
    DeviceId: str,
) -> DescribeDeviceResponseTypeDef:  # (1)
    ...

1. See DescribeDeviceResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See DescribeDevicePolicyConfigurationResponseTypeDef

Usage example with kwargs

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

parent.describe_device_policy_configuration(**kwargs)

1. See DescribeDevicePolicyConfigurationRequestRequestTypeDef

describe_domain

Provides information about the domain.

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

Method definition

def describe_domain(
    self,
    *,
    FleetArn: str,
    DomainName: str,
) -> DescribeDomainResponseTypeDef:  # (1)
    ...

1. See DescribeDomainResponseTypeDef

Usage example with kwargs

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

parent.describe_domain(**kwargs)

1. See DescribeDomainRequestRequestTypeDef

describe_fleet_metadata

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

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

Method definition

def describe_fleet_metadata(
    self,
    *,
    FleetArn: str,
) -> DescribeFleetMetadataResponseTypeDef:  # (1)
    ...

1. See DescribeFleetMetadataResponseTypeDef

Usage example with kwargs

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

parent.describe_fleet_metadata(**kwargs)

1. See DescribeFleetMetadataRequestRequestTypeDef

describe_identity_provider_configuration

Describes the identity provider configuration of the specified fleet.

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

Method definition

def describe_identity_provider_configuration(
    self,
    *,
    FleetArn: str,
) -> DescribeIdentityProviderConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeIdentityProviderConfigurationResponseTypeDef

Usage example with kwargs

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

parent.describe_identity_provider_configuration(**kwargs)

1. See DescribeIdentityProviderConfigurationRequestRequestTypeDef

describe_website_certificate_authority

Provides information about the certificate authority.

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

Method definition

def describe_website_certificate_authority(
    self,
    *,
    FleetArn: str,
    WebsiteCaId: str,
) -> DescribeWebsiteCertificateAuthorityResponseTypeDef:  # (1)
    ...

1. See DescribeWebsiteCertificateAuthorityResponseTypeDef

Usage example with kwargs

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

parent.describe_website_certificate_authority(**kwargs)

1. See DescribeWebsiteCertificateAuthorityRequestRequestTypeDef

disassociate_domain

Disassociates a domain from Amazon WorkLink.

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

Method definition

def disassociate_domain(
    self,
    *,
    FleetArn: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_domain(**kwargs)

1. See DisassociateDomainRequestRequestTypeDef

disassociate_website_authorization_provider

Disassociates a website authorization provider from a specified fleet.

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

Method definition

def disassociate_website_authorization_provider(
    self,
    *,
    FleetArn: str,
    AuthorizationProviderId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_website_authorization_provider(**kwargs)

1. See DisassociateWebsiteAuthorizationProviderRequestRequestTypeDef

disassociate_website_certificate_authority

Removes a certificate authority (CA).

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

Method definition

def disassociate_website_certificate_authority(
    self,
    *,
    FleetArn: str,
    WebsiteCaId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_website_certificate_authority(**kwargs)

1. See DisassociateWebsiteCertificateAuthorityRequestRequestTypeDef

generate_presigned_url

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

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_devices

Retrieves a list of devices registered with the specified fleet.

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

Method definition

def list_devices(
    self,
    *,
    FleetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...

1. See ListDevicesResponseTypeDef

Usage example with kwargs

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

parent.list_devices(**kwargs)

1. See ListDevicesRequestRequestTypeDef

list_domains

Retrieves a list of domains associated to a specified fleet.

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

Method definition

def list_domains(
    self,
    *,
    FleetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...

1. See ListDomainsResponseTypeDef

Usage example with kwargs

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

parent.list_domains(**kwargs)

1. See ListDomainsRequestRequestTypeDef

list_fleets

Retrieves a list of fleets for the current account and Region.

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

Method definition

def list_fleets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFleetsResponseTypeDef:  # (1)
    ...

1. See ListFleetsResponseTypeDef

Usage example with kwargs

kwargs: ListFleetsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_fleets(**kwargs)

1. See ListFleetsRequestRequestTypeDef

list_tags_for_resource

Retrieves a list of tags for the specified resource.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_website_authorization_providers

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

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

Method definition

def list_website_authorization_providers(
    self,
    *,
    FleetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWebsiteAuthorizationProvidersResponseTypeDef:  # (1)
    ...

1. See ListWebsiteAuthorizationProvidersResponseTypeDef

Usage example with kwargs

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

parent.list_website_authorization_providers(**kwargs)

1. See ListWebsiteAuthorizationProvidersRequestRequestTypeDef

list_website_certificate_authorities

Retrieves a list of certificate authorities added for the current account and Region.

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

Method definition

def list_website_certificate_authorities(
    self,
    *,
    FleetArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWebsiteCertificateAuthoritiesResponseTypeDef:  # (1)
    ...

1. See ListWebsiteCertificateAuthoritiesResponseTypeDef

Usage example with kwargs

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

parent.list_website_certificate_authorities(**kwargs)

1. See ListWebsiteCertificateAuthoritiesRequestRequestTypeDef

restore_domain_access

Moves a domain to ACTIVE status if it was in the INACTIVE status.

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

Method definition

def restore_domain_access(
    self,
    *,
    FleetArn: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.restore_domain_access(**kwargs)

1. See RestoreDomainAccessRequestRequestTypeDef

revoke_domain_access

Moves a domain to INACTIVE status if it was in the ACTIVE status.

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

Method definition

def revoke_domain_access(
    self,
    *,
    FleetArn: str,
    DomainName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.revoke_domain_access(**kwargs)

1. See RevokeDomainAccessRequestRequestTypeDef

sign_out_user

Signs the user out from all of their devices.

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

Method definition

def sign_out_user(
    self,
    *,
    FleetArn: str,
    Username: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.sign_out_user(**kwargs)

1. See SignOutUserRequestRequestTypeDef

tag_resource

Adds or overwrites one or more tags for the specified resource, such as a fleet.

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

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from the specified resource.

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_audit_stream_configuration

Updates the audit stream configuration for the fleet.

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

Method definition

def update_audit_stream_configuration(
    self,
    *,
    FleetArn: str,
    AuditStreamArn: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_audit_stream_configuration(**kwargs)

1. See UpdateAuditStreamConfigurationRequestRequestTypeDef

update_company_network_configuration

Updates the company network configuration for the fleet.

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

Method definition

def update_company_network_configuration(
    self,
    *,
    FleetArn: str,
    VpcId: str,
    SubnetIds: Sequence[str],
    SecurityGroupIds: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateCompanyNetworkConfigurationRequestRequestTypeDef = {  # (1)
    "FleetArn": ...,
    "VpcId": ...,
    "SubnetIds": ...,
    "SecurityGroupIds": ...,
}

parent.update_company_network_configuration(**kwargs)

1. See UpdateCompanyNetworkConfigurationRequestRequestTypeDef

update_device_policy_configuration

Updates the device policy configuration for the fleet.

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

Method definition

def update_device_policy_configuration(
    self,
    *,
    FleetArn: str,
    DeviceCaCertificate: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_device_policy_configuration(**kwargs)

1. See UpdateDevicePolicyConfigurationRequestRequestTypeDef

update_domain_metadata

Updates domain metadata, such as DisplayName.

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

Method definition

def update_domain_metadata(
    self,
    *,
    FleetArn: str,
    DomainName: str,
    DisplayName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_domain_metadata(**kwargs)

1. See UpdateDomainMetadataRequestRequestTypeDef

update_fleet_metadata

Updates fleet metadata, such as DisplayName.

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

Method definition

def update_fleet_metadata(
    self,
    *,
    FleetArn: str,
    DisplayName: str = ...,
    OptimizeForEndUserLocation: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_fleet_metadata(**kwargs)

1. See UpdateFleetMetadataRequestRequestTypeDef

update_identity_provider_configuration

Updates the identity provider configuration for the fleet.

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

Method definition

def update_identity_provider_configuration(
    self,
    *,
    FleetArn: str,
    IdentityProviderType: IdentityProviderTypeType,  # (1)
    IdentityProviderSamlMetadata: str = ...,
) -> Dict[str, Any]:
    ...

1. See IdentityProviderTypeType

Usage example with kwargs

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

parent.update_identity_provider_configuration(**kwargs)

1. See UpdateIdentityProviderConfigurationRequestRequestTypeDef