@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkLink
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkLink
instead.
Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateDomainResult |
associateDomain(AssociateDomainRequest associateDomainRequest)
Specifies a domain to be associated to Amazon WorkLink.
|
AssociateWebsiteAuthorizationProviderResult |
associateWebsiteAuthorizationProvider(AssociateWebsiteAuthorizationProviderRequest associateWebsiteAuthorizationProviderRequest)
Associates a website authorization provider with a specified fleet.
|
AssociateWebsiteCertificateAuthorityResult |
associateWebsiteCertificateAuthority(AssociateWebsiteCertificateAuthorityRequest associateWebsiteCertificateAuthorityRequest)
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated
websites within the company network.
|
CreateFleetResult |
createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a fleet.
|
DescribeAuditStreamConfigurationResult |
describeAuditStreamConfiguration(DescribeAuditStreamConfigurationRequest describeAuditStreamConfigurationRequest)
Describes the configuration for delivering audit streams to the customer account.
|
DescribeCompanyNetworkConfigurationResult |
describeCompanyNetworkConfiguration(DescribeCompanyNetworkConfigurationRequest describeCompanyNetworkConfigurationRequest)
Describes the networking configuration to access the internal websites associated with the specified fleet.
|
DescribeDeviceResult |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Provides information about a user's device.
|
DescribeDevicePolicyConfigurationResult |
describeDevicePolicyConfiguration(DescribeDevicePolicyConfigurationRequest describeDevicePolicyConfigurationRequest)
Describes the device policy configuration for the specified fleet.
|
DescribeDomainResult |
describeDomain(DescribeDomainRequest describeDomainRequest)
Provides information about the domain.
|
DescribeFleetMetadataResult |
describeFleetMetadata(DescribeFleetMetadataRequest describeFleetMetadataRequest)
Provides basic information for the specified fleet, excluding identity provider, networking, and device
configuration details.
|
DescribeIdentityProviderConfigurationResult |
describeIdentityProviderConfiguration(DescribeIdentityProviderConfigurationRequest describeIdentityProviderConfigurationRequest)
Describes the identity provider configuration of the specified fleet.
|
DescribeWebsiteCertificateAuthorityResult |
describeWebsiteCertificateAuthority(DescribeWebsiteCertificateAuthorityRequest describeWebsiteCertificateAuthorityRequest)
Provides information about the certificate authority.
|
DisassociateDomainResult |
disassociateDomain(DisassociateDomainRequest disassociateDomainRequest)
Disassociates a domain from Amazon WorkLink.
|
DisassociateWebsiteAuthorizationProviderResult |
disassociateWebsiteAuthorizationProvider(DisassociateWebsiteAuthorizationProviderRequest disassociateWebsiteAuthorizationProviderRequest)
Disassociates a website authorization provider from a specified fleet.
|
DisassociateWebsiteCertificateAuthorityResult |
disassociateWebsiteCertificateAuthority(DisassociateWebsiteCertificateAuthorityRequest disassociateWebsiteCertificateAuthorityRequest)
Removes a certificate authority (CA).
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Retrieves a list of devices registered with the specified fleet.
|
ListDomainsResult |
listDomains(ListDomainsRequest listDomainsRequest)
Retrieves a list of domains associated to a specified fleet.
|
ListFleetsResult |
listFleets(ListFleetsRequest listFleetsRequest)
Retrieves a list of fleets for the current account and Region.
|
ListWebsiteAuthorizationProvidersResult |
listWebsiteAuthorizationProviders(ListWebsiteAuthorizationProvidersRequest listWebsiteAuthorizationProvidersRequest)
Retrieves a list of website authorization providers associated with a specified fleet.
|
ListWebsiteCertificateAuthoritiesResult |
listWebsiteCertificateAuthorities(ListWebsiteCertificateAuthoritiesRequest listWebsiteCertificateAuthoritiesRequest)
Retrieves a list of certificate authorities added for the current account and Region.
|
RestoreDomainAccessResult |
restoreDomainAccess(RestoreDomainAccessRequest restoreDomainAccessRequest)
Moves a domain to ACTIVE status if it was in the INACTIVE status.
|
RevokeDomainAccessResult |
revokeDomainAccess(RevokeDomainAccessRequest revokeDomainAccessRequest)
Moves a domain to INACTIVE status if it was in the ACTIVE status.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SignOutUserResult |
signOutUser(SignOutUserRequest signOutUserRequest)
Signs the user out from all of their devices.
|
UpdateAuditStreamConfigurationResult |
updateAuditStreamConfiguration(UpdateAuditStreamConfigurationRequest updateAuditStreamConfigurationRequest)
Updates the audit stream configuration for the fleet.
|
UpdateCompanyNetworkConfigurationResult |
updateCompanyNetworkConfiguration(UpdateCompanyNetworkConfigurationRequest updateCompanyNetworkConfigurationRequest)
Updates the company network configuration for the fleet.
|
UpdateDevicePolicyConfigurationResult |
updateDevicePolicyConfiguration(UpdateDevicePolicyConfigurationRequest updateDevicePolicyConfigurationRequest)
Updates the device policy configuration for the fleet.
|
UpdateDomainMetadataResult |
updateDomainMetadata(UpdateDomainMetadataRequest updateDomainMetadataRequest)
Updates domain metadata, such as DisplayName.
|
UpdateFleetMetadataResult |
updateFleetMetadata(UpdateFleetMetadataRequest updateFleetMetadataRequest)
Updates fleet metadata, such as DisplayName.
|
UpdateIdentityProviderConfigurationResult |
updateIdentityProviderConfiguration(UpdateIdentityProviderConfigurationRequest updateIdentityProviderConfigurationRequest)
Updates the identity provider configuration for the fleet.
|
static final String ENDPOINT_PREFIX
AssociateDomainResult associateDomain(AssociateDomainRequest associateDomainRequest)
Specifies a domain to be associated to Amazon WorkLink.
associateDomainRequest
- 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.AssociateWebsiteAuthorizationProviderResult associateWebsiteAuthorizationProvider(AssociateWebsiteAuthorizationProviderRequest associateWebsiteAuthorizationProviderRequest)
Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.
associateWebsiteAuthorizationProviderRequest
- 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.AssociateWebsiteCertificateAuthorityResult associateWebsiteCertificateAuthority(AssociateWebsiteCertificateAuthorityRequest associateWebsiteCertificateAuthorityRequest)
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
associateWebsiteCertificateAuthorityRequest
- 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.CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
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.
createFleetRequest
- 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.DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a fleet. Prevents users from accessing previously associated websites.
deleteFleetRequest
- 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.DescribeAuditStreamConfigurationResult describeAuditStreamConfiguration(DescribeAuditStreamConfigurationRequest describeAuditStreamConfigurationRequest)
Describes the configuration for delivering audit streams to the customer account.
describeAuditStreamConfigurationRequest
- 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.DescribeCompanyNetworkConfigurationResult describeCompanyNetworkConfiguration(DescribeCompanyNetworkConfigurationRequest describeCompanyNetworkConfigurationRequest)
Describes the networking configuration to access the internal websites associated with the specified fleet.
describeCompanyNetworkConfigurationRequest
- 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.DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)
Provides information about a user's device.
describeDeviceRequest
- 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.DescribeDevicePolicyConfigurationResult describeDevicePolicyConfiguration(DescribeDevicePolicyConfigurationRequest describeDevicePolicyConfigurationRequest)
Describes the device policy configuration for the specified fleet.
describeDevicePolicyConfigurationRequest
- 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.DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)
Provides information about the domain.
describeDomainRequest
- 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.DescribeFleetMetadataResult describeFleetMetadata(DescribeFleetMetadataRequest describeFleetMetadataRequest)
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
describeFleetMetadataRequest
- 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.DescribeIdentityProviderConfigurationResult describeIdentityProviderConfiguration(DescribeIdentityProviderConfigurationRequest describeIdentityProviderConfigurationRequest)
Describes the identity provider configuration of the specified fleet.
describeIdentityProviderConfigurationRequest
- 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.DescribeWebsiteCertificateAuthorityResult describeWebsiteCertificateAuthority(DescribeWebsiteCertificateAuthorityRequest describeWebsiteCertificateAuthorityRequest)
Provides information about the certificate authority.
describeWebsiteCertificateAuthorityRequest
- 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.DisassociateDomainResult disassociateDomain(DisassociateDomainRequest disassociateDomainRequest)
Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
disassociateDomainRequest
- 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.DisassociateWebsiteAuthorizationProviderResult disassociateWebsiteAuthorizationProvider(DisassociateWebsiteAuthorizationProviderRequest disassociateWebsiteAuthorizationProviderRequest)
Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.
disassociateWebsiteAuthorizationProviderRequest
- 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.DisassociateWebsiteCertificateAuthorityResult disassociateWebsiteCertificateAuthority(DisassociateWebsiteCertificateAuthorityRequest disassociateWebsiteCertificateAuthorityRequest)
Removes a certificate authority (CA).
disassociateWebsiteCertificateAuthorityRequest
- 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.ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Retrieves a list of devices registered with the specified fleet.
listDevicesRequest
- 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.ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
Retrieves a list of domains associated to a specified fleet.
listDomainsRequest
- 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.ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)
Retrieves a list of fleets for the current account and Region.
listFleetsRequest
- 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.ListWebsiteAuthorizationProvidersResult listWebsiteAuthorizationProviders(ListWebsiteAuthorizationProvidersRequest listWebsiteAuthorizationProvidersRequest)
Retrieves a list of website authorization providers associated with a specified fleet.
listWebsiteAuthorizationProvidersRequest
- 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.ListWebsiteCertificateAuthoritiesResult listWebsiteCertificateAuthorities(ListWebsiteCertificateAuthoritiesRequest listWebsiteCertificateAuthoritiesRequest)
Retrieves a list of certificate authorities added for the current account and Region.
listWebsiteCertificateAuthoritiesRequest
- 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.RestoreDomainAccessResult restoreDomainAccess(RestoreDomainAccessRequest restoreDomainAccessRequest)
Moves a domain to ACTIVE status if it was in the INACTIVE status.
restoreDomainAccessRequest
- 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.RevokeDomainAccessResult revokeDomainAccess(RevokeDomainAccessRequest revokeDomainAccessRequest)
Moves a domain to INACTIVE status if it was in the ACTIVE status.
revokeDomainAccessRequest
- 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.SignOutUserResult signOutUser(SignOutUserRequest signOutUserRequest)
Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
signOutUserRequest
- 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.UpdateAuditStreamConfigurationResult updateAuditStreamConfiguration(UpdateAuditStreamConfigurationRequest updateAuditStreamConfigurationRequest)
Updates the audit stream configuration for the fleet.
updateAuditStreamConfigurationRequest
- 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.UpdateCompanyNetworkConfigurationResult updateCompanyNetworkConfiguration(UpdateCompanyNetworkConfigurationRequest updateCompanyNetworkConfigurationRequest)
Updates the company network configuration for the fleet.
updateCompanyNetworkConfigurationRequest
- 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.UpdateDevicePolicyConfigurationResult updateDevicePolicyConfiguration(UpdateDevicePolicyConfigurationRequest updateDevicePolicyConfigurationRequest)
Updates the device policy configuration for the fleet.
updateDevicePolicyConfigurationRequest
- 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.UpdateDomainMetadataResult updateDomainMetadata(UpdateDomainMetadataRequest updateDomainMetadataRequest)
Updates domain metadata, such as DisplayName.
updateDomainMetadataRequest
- 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.UpdateFleetMetadataResult updateFleetMetadata(UpdateFleetMetadataRequest updateFleetMetadataRequest)
Updates fleet metadata, such as DisplayName.
updateFleetMetadataRequest
- 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.UpdateIdentityProviderConfigurationResult updateIdentityProviderConfiguration(UpdateIdentityProviderConfigurationRequest updateIdentityProviderConfigurationRequest)
Updates the identity provider configuration for the fleet.
updateIdentityProviderConfigurationRequest
- 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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.