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)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)
...# associate_website_authorization_provider method usage example with argument unpacking
kwargs: AssociateWebsiteAuthorizationProviderRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"AuthorizationProviderType": ...,
}
parent.associate_website_authorization_provider(**kwargs)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)
...# associate_website_certificate_authority method usage example with argument unpacking
kwargs: AssociateWebsiteCertificateAuthorityRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"Certificate": ...,
}
parent.associate_website_certificate_authority(**kwargs)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)
...# create_fleet method usage example with argument unpacking
kwargs: CreateFleetRequestRequestTypeDef = { # (1)
"FleetName": ...,
}
parent.create_fleet(**kwargs)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)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)
...# describe_audit_stream_configuration method usage example with argument unpacking
kwargs: DescribeAuditStreamConfigurationRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.describe_audit_stream_configuration(**kwargs)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)
...# describe_company_network_configuration method usage example with argument unpacking
kwargs: DescribeCompanyNetworkConfigurationRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.describe_company_network_configuration(**kwargs)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)
...# describe_device method usage example with argument unpacking
kwargs: DescribeDeviceRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"DeviceId": ...,
}
parent.describe_device(**kwargs)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)
...# describe_device_policy_configuration method usage example with argument unpacking
kwargs: DescribeDevicePolicyConfigurationRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.describe_device_policy_configuration(**kwargs)describe_domain#
Provides information about the domain.
Type annotations and code completion for boto3.client("worklink").describe_domain method.
boto3 documentation
# describe_domain method definition
def describe_domain(
self,
*,
FleetArn: str,
DomainName: str,
) -> DescribeDomainResponseTypeDef: # (1)
...# describe_domain method usage example with argument unpacking
kwargs: DescribeDomainRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"DomainName": ...,
}
parent.describe_domain(**kwargs)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
# describe_fleet_metadata method definition
def describe_fleet_metadata(
self,
*,
FleetArn: str,
) -> DescribeFleetMetadataResponseTypeDef: # (1)
...# describe_fleet_metadata method usage example with argument unpacking
kwargs: DescribeFleetMetadataRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.describe_fleet_metadata(**kwargs)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
# describe_identity_provider_configuration method definition
def describe_identity_provider_configuration(
self,
*,
FleetArn: str,
) -> DescribeIdentityProviderConfigurationResponseTypeDef: # (1)
...# describe_identity_provider_configuration method usage example with argument unpacking
kwargs: DescribeIdentityProviderConfigurationRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.describe_identity_provider_configuration(**kwargs)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
# describe_website_certificate_authority method definition
def describe_website_certificate_authority(
self,
*,
FleetArn: str,
WebsiteCaId: str,
) -> DescribeWebsiteCertificateAuthorityResponseTypeDef: # (1)
...# describe_website_certificate_authority method usage example with argument unpacking
kwargs: DescribeWebsiteCertificateAuthorityRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"WebsiteCaId": ...,
}
parent.describe_website_certificate_authority(**kwargs)disassociate_domain#
Disassociates a domain from Amazon WorkLink.
Type annotations and code completion for boto3.client("worklink").disassociate_domain method.
boto3 documentation
# disassociate_domain method definition
def disassociate_domain(
self,
*,
FleetArn: str,
DomainName: str,
) -> Dict[str, Any]:
...# disassociate_domain method usage example with argument unpacking
kwargs: DisassociateDomainRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"DomainName": ...,
}
parent.disassociate_domain(**kwargs)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
# disassociate_website_authorization_provider method definition
def disassociate_website_authorization_provider(
self,
*,
FleetArn: str,
AuthorizationProviderId: str,
) -> Dict[str, Any]:
...# disassociate_website_authorization_provider method usage example with argument unpacking
kwargs: DisassociateWebsiteAuthorizationProviderRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"AuthorizationProviderId": ...,
}
parent.disassociate_website_authorization_provider(**kwargs)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
# disassociate_website_certificate_authority method definition
def disassociate_website_certificate_authority(
self,
*,
FleetArn: str,
WebsiteCaId: str,
) -> Dict[str, Any]:
...# disassociate_website_certificate_authority method usage example with argument unpacking
kwargs: DisassociateWebsiteCertificateAuthorityRequestRequestTypeDef = { # (1)
"FleetArn": ...,
"WebsiteCaId": ...,
}
parent.disassociate_website_certificate_authority(**kwargs)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
# generate_presigned_url 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
# list_devices method definition
def list_devices(
self,
*,
FleetArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDevicesResponseTypeDef: # (1)
...# list_devices method usage example with argument unpacking
kwargs: ListDevicesRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.list_devices(**kwargs)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
# list_domains method definition
def list_domains(
self,
*,
FleetArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDomainsResponseTypeDef: # (1)
...# list_domains method usage example with argument unpacking
kwargs: ListDomainsRequestRequestTypeDef = { # (1)
"FleetArn": ...,
}
parent.list_domains(**kwargs)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.