@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkLinkClient extends AmazonWebServiceClient implements AmazonWorkLink
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonWorkLinkClientBuilder builder()
@Deprecated public AssociateDomainResult associateDomain(AssociateDomainRequest request)
Specifies a domain to be associated to Amazon WorkLink.
associateDomain in interface AmazonWorkLinkassociateDomainRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.ResourceAlreadyExistsException - The resource already exists.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public AssociateWebsiteAuthorizationProviderResult associateWebsiteAuthorizationProvider(AssociateWebsiteAuthorizationProviderRequest request)
Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
associateWebsiteAuthorizationProvider in interface AmazonWorkLinkassociateWebsiteAuthorizationProviderRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.ResourceAlreadyExistsException - The resource already exists.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public AssociateWebsiteCertificateAuthorityResult associateWebsiteCertificateAuthority(AssociateWebsiteCertificateAuthorityRequest request)
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
associateWebsiteCertificateAuthority in interface AmazonWorkLinkassociateWebsiteCertificateAuthorityRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.ResourceAlreadyExistsException - The resource already exists.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public CreateFleetResult createFleet(CreateFleetRequest request)
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.
createFleet in interface AmazonWorkLinkcreateFleetRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.ResourceAlreadyExistsException - The resource already exists.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
Deletes a fleet. Prevents users from accessing previously associated websites.
deleteFleet in interface AmazonWorkLinkdeleteFleetRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeAuditStreamConfigurationResult describeAuditStreamConfiguration(DescribeAuditStreamConfigurationRequest request)
Describes the configuration for delivering audit streams to the customer account.
describeAuditStreamConfiguration in interface AmazonWorkLinkdescribeAuditStreamConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeCompanyNetworkConfigurationResult describeCompanyNetworkConfiguration(DescribeCompanyNetworkConfigurationRequest request)
Describes the networking configuration to access the internal websites associated with the specified fleet.
describeCompanyNetworkConfiguration in interface AmazonWorkLinkdescribeCompanyNetworkConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
Provides information about a user's device.
describeDevice in interface AmazonWorkLinkdescribeDeviceRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeDevicePolicyConfigurationResult describeDevicePolicyConfiguration(DescribeDevicePolicyConfigurationRequest request)
Describes the device policy configuration for the specified fleet.
describeDevicePolicyConfiguration in interface AmazonWorkLinkdescribeDevicePolicyConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeDomainResult describeDomain(DescribeDomainRequest request)
Provides information about the domain.
describeDomain in interface AmazonWorkLinkdescribeDomainRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeFleetMetadataResult describeFleetMetadata(DescribeFleetMetadataRequest request)
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
describeFleetMetadata in interface AmazonWorkLinkdescribeFleetMetadataRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeIdentityProviderConfigurationResult describeIdentityProviderConfiguration(DescribeIdentityProviderConfigurationRequest request)
Describes the identity provider configuration of the specified fleet.
describeIdentityProviderConfiguration in interface AmazonWorkLinkdescribeIdentityProviderConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DescribeWebsiteCertificateAuthorityResult describeWebsiteCertificateAuthority(DescribeWebsiteCertificateAuthorityRequest request)
Provides information about the certificate authority.
describeWebsiteCertificateAuthority in interface AmazonWorkLinkdescribeWebsiteCertificateAuthorityRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DisassociateDomainResult disassociateDomain(DisassociateDomainRequest request)
Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
disassociateDomain in interface AmazonWorkLinkdisassociateDomainRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DisassociateWebsiteAuthorizationProviderResult disassociateWebsiteAuthorizationProvider(DisassociateWebsiteAuthorizationProviderRequest request)
Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
disassociateWebsiteAuthorizationProvider in interface AmazonWorkLinkdisassociateWebsiteAuthorizationProviderRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.ResourceAlreadyExistsException - The resource already exists.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public DisassociateWebsiteCertificateAuthorityResult disassociateWebsiteCertificateAuthority(DisassociateWebsiteCertificateAuthorityRequest request)
Removes a certificate authority (CA).
disassociateWebsiteCertificateAuthority in interface AmazonWorkLinkdisassociateWebsiteCertificateAuthorityRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public ListDevicesResult listDevices(ListDevicesRequest request)
Retrieves a list of devices registered with the specified fleet.
listDevices in interface AmazonWorkLinklistDevicesRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public ListDomainsResult listDomains(ListDomainsRequest request)
Retrieves a list of domains associated to a specified fleet.
listDomains in interface AmazonWorkLinklistDomainsRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public ListFleetsResult listFleets(ListFleetsRequest request)
Retrieves a list of fleets for the current account and Region.
listFleets in interface AmazonWorkLinklistFleetsRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves a list of tags for the specified resource.
listTagsForResource in interface AmazonWorkLinklistTagsForResourceRequest - InvalidRequestException - The request is not valid.@Deprecated public ListWebsiteAuthorizationProvidersResult listWebsiteAuthorizationProviders(ListWebsiteAuthorizationProvidersRequest request)
Retrieves a list of website authorization providers associated with a specified fleet.
listWebsiteAuthorizationProviders in interface AmazonWorkLinklistWebsiteAuthorizationProvidersRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public ListWebsiteCertificateAuthoritiesResult listWebsiteCertificateAuthorities(ListWebsiteCertificateAuthoritiesRequest request)
Retrieves a list of certificate authorities added for the current account and Region.
listWebsiteCertificateAuthorities in interface AmazonWorkLinklistWebsiteCertificateAuthoritiesRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public RestoreDomainAccessResult restoreDomainAccess(RestoreDomainAccessRequest request)
Moves a domain to ACTIVE status if it was in the INACTIVE status.
restoreDomainAccess in interface AmazonWorkLinkrestoreDomainAccessRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public RevokeDomainAccessResult revokeDomainAccess(RevokeDomainAccessRequest request)
Moves a domain to INACTIVE status if it was in the ACTIVE status.
revokeDomainAccess in interface AmazonWorkLinkrevokeDomainAccessRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public SignOutUserResult signOutUser(SignOutUserRequest request)
Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
signOutUser in interface AmazonWorkLinksignOutUserRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AmazonWorkLinktagResourceRequest - InvalidRequestException - The request is not valid.@Deprecated public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
untagResource in interface AmazonWorkLinkuntagResourceRequest - InvalidRequestException - The request is not valid.@Deprecated public UpdateAuditStreamConfigurationResult updateAuditStreamConfiguration(UpdateAuditStreamConfigurationRequest request)
Updates the audit stream configuration for the fleet.
updateAuditStreamConfiguration in interface AmazonWorkLinkupdateAuditStreamConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public UpdateCompanyNetworkConfigurationResult updateCompanyNetworkConfiguration(UpdateCompanyNetworkConfigurationRequest request)
Updates the company network configuration for the fleet.
updateCompanyNetworkConfiguration in interface AmazonWorkLinkupdateCompanyNetworkConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public UpdateDevicePolicyConfigurationResult updateDevicePolicyConfiguration(UpdateDevicePolicyConfigurationRequest request)
Updates the device policy configuration for the fleet.
updateDevicePolicyConfiguration in interface AmazonWorkLinkupdateDevicePolicyConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public UpdateDomainMetadataResult updateDomainMetadata(UpdateDomainMetadataRequest request)
Updates domain metadata, such as DisplayName.
updateDomainMetadata in interface AmazonWorkLinkupdateDomainMetadataRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public UpdateFleetMetadataResult updateFleetMetadata(UpdateFleetMetadataRequest request)
Updates fleet metadata, such as DisplayName.
updateFleetMetadata in interface AmazonWorkLinkupdateFleetMetadataRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.@Deprecated public UpdateIdentityProviderConfigurationResult updateIdentityProviderConfiguration(UpdateIdentityProviderConfigurationRequest request)
Updates the identity provider configuration for the fleet.
updateIdentityProviderConfiguration in interface AmazonWorkLinkupdateIdentityProviderConfigurationRequest - UnauthorizedException - You are not authorized to perform this action.InternalServerErrorException - The service is temporarily unavailable.InvalidRequestException - The request is not valid.ResourceNotFoundException - The requested resource was not found.TooManyRequestsException - The number of requests exceeds the limit.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonWorkLinkrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonWorkLinkshutdown in class AmazonWebServiceClient