com.amazonaws.services.workspacesweb

Interface AmazonWorkSpacesWeb

All Known Subinterfaces:

AmazonWorkSpacesWebAsync

All Known Implementing Classes:

AbstractAmazonWorkSpacesWeb, AbstractAmazonWorkSpacesWebAsync, AmazonWorkSpacesWebAsyncClient, AmazonWorkSpacesWebClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkSpacesWeb

Interface for accessing Amazon WorkSpaces Web.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkSpacesWeb instead.

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Web provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateBrowserSettingsResult	associateBrowserSettings(AssociateBrowserSettingsRequest associateBrowserSettingsRequest) Associates a browser settings resource with a web portal.
AssociateNetworkSettingsResult	associateNetworkSettings(AssociateNetworkSettingsRequest associateNetworkSettingsRequest) Associates a network settings resource with a web portal.
AssociateTrustStoreResult	associateTrustStore(AssociateTrustStoreRequest associateTrustStoreRequest) Associates a trust store with a web portal.
AssociateUserAccessLoggingSettingsResult	associateUserAccessLoggingSettings(AssociateUserAccessLoggingSettingsRequest associateUserAccessLoggingSettingsRequest) Associates a user access logging settings resource with a web portal.
AssociateUserSettingsResult	associateUserSettings(AssociateUserSettingsRequest associateUserSettingsRequest) Associates a user settings resource with a web portal.
CreateBrowserSettingsResult	createBrowserSettings(CreateBrowserSettingsRequest createBrowserSettingsRequest) Creates a browser settings resource that can be associated with a web portal.
CreateIdentityProviderResult	createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) Creates an identity provider resource that is then associated with a web portal.
CreateNetworkSettingsResult	createNetworkSettings(CreateNetworkSettingsRequest createNetworkSettingsRequest) Creates a network settings resource that can be associated with a web portal.
CreatePortalResult	createPortal(CreatePortalRequest createPortalRequest) Creates a web portal.
CreateTrustStoreResult	createTrustStore(CreateTrustStoreRequest createTrustStoreRequest) Creates a trust store that can be associated with a web portal.
CreateUserAccessLoggingSettingsResult	createUserAccessLoggingSettings(CreateUserAccessLoggingSettingsRequest createUserAccessLoggingSettingsRequest) Creates a user access logging settings resource that can be associated with a web portal.
CreateUserSettingsResult	createUserSettings(CreateUserSettingsRequest createUserSettingsRequest) Creates a user settings resource that can be associated with a web portal.
DeleteBrowserSettingsResult	deleteBrowserSettings(DeleteBrowserSettingsRequest deleteBrowserSettingsRequest) Deletes browser settings.
DeleteIdentityProviderResult	deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) Deletes the identity provider.
DeleteNetworkSettingsResult	deleteNetworkSettings(DeleteNetworkSettingsRequest deleteNetworkSettingsRequest) Deletes network settings.
DeletePortalResult	deletePortal(DeletePortalRequest deletePortalRequest) Deletes a web portal.
DeleteTrustStoreResult	deleteTrustStore(DeleteTrustStoreRequest deleteTrustStoreRequest) Deletes the trust store.
DeleteUserAccessLoggingSettingsResult	deleteUserAccessLoggingSettings(DeleteUserAccessLoggingSettingsRequest deleteUserAccessLoggingSettingsRequest) Deletes user access logging settings.
DeleteUserSettingsResult	deleteUserSettings(DeleteUserSettingsRequest deleteUserSettingsRequest) Deletes user settings.
DisassociateBrowserSettingsResult	disassociateBrowserSettings(DisassociateBrowserSettingsRequest disassociateBrowserSettingsRequest) Disassociates browser settings from a web portal.
DisassociateNetworkSettingsResult	disassociateNetworkSettings(DisassociateNetworkSettingsRequest disassociateNetworkSettingsRequest) Disassociates network settings from a web portal.
DisassociateTrustStoreResult	disassociateTrustStore(DisassociateTrustStoreRequest disassociateTrustStoreRequest) Disassociates a trust store from a web portal.
DisassociateUserAccessLoggingSettingsResult	disassociateUserAccessLoggingSettings(DisassociateUserAccessLoggingSettingsRequest disassociateUserAccessLoggingSettingsRequest) Disassociates user access logging settings from a web portal.
DisassociateUserSettingsResult	disassociateUserSettings(DisassociateUserSettingsRequest disassociateUserSettingsRequest) Disassociates user settings from a web portal.
GetBrowserSettingsResult	getBrowserSettings(GetBrowserSettingsRequest getBrowserSettingsRequest) Gets browser settings.
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.
GetIdentityProviderResult	getIdentityProvider(GetIdentityProviderRequest getIdentityProviderRequest) Gets the identity provider.
GetNetworkSettingsResult	getNetworkSettings(GetNetworkSettingsRequest getNetworkSettingsRequest) Gets the network settings.
GetPortalResult	getPortal(GetPortalRequest getPortalRequest) Gets the web portal.
GetPortalServiceProviderMetadataResult	getPortalServiceProviderMetadata(GetPortalServiceProviderMetadataRequest getPortalServiceProviderMetadataRequest) Gets the service provider metadata.
GetTrustStoreResult	getTrustStore(GetTrustStoreRequest getTrustStoreRequest) Gets the trust store.
GetTrustStoreCertificateResult	getTrustStoreCertificate(GetTrustStoreCertificateRequest getTrustStoreCertificateRequest) Gets the trust store certificate.
GetUserAccessLoggingSettingsResult	getUserAccessLoggingSettings(GetUserAccessLoggingSettingsRequest getUserAccessLoggingSettingsRequest) Gets user access logging settings.
GetUserSettingsResult	getUserSettings(GetUserSettingsRequest getUserSettingsRequest) Gets user settings.
ListBrowserSettingsResult	listBrowserSettings(ListBrowserSettingsRequest listBrowserSettingsRequest) Retrieves a list of browser settings.
ListIdentityProvidersResult	listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) Retrieves a list of identity providers for a specific web portal.
ListNetworkSettingsResult	listNetworkSettings(ListNetworkSettingsRequest listNetworkSettingsRequest) Retrieves a list of network settings.
ListPortalsResult	listPortals(ListPortalsRequest listPortalsRequest) Retrieves a list or web portals.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves a list of tags for a resource.
ListTrustStoreCertificatesResult	listTrustStoreCertificates(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest) Retrieves a list of trust store certificates.
ListTrustStoresResult	listTrustStores(ListTrustStoresRequest listTrustStoresRequest) Retrieves a list of trust stores.
ListUserAccessLoggingSettingsResult	listUserAccessLoggingSettings(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest) Retrieves a list of user access logging settings.
ListUserSettingsResult	listUserSettings(ListUserSettingsRequest listUserSettingsRequest) Retrieves a list of user settings.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.
UpdateBrowserSettingsResult	updateBrowserSettings(UpdateBrowserSettingsRequest updateBrowserSettingsRequest) Updates browser settings.
UpdateIdentityProviderResult	updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) Updates the identity provider.
UpdateNetworkSettingsResult	updateNetworkSettings(UpdateNetworkSettingsRequest updateNetworkSettingsRequest) Updates network settings.
UpdatePortalResult	updatePortal(UpdatePortalRequest updatePortalRequest) Updates a web portal.
UpdateTrustStoreResult	updateTrustStore(UpdateTrustStoreRequest updateTrustStoreRequest) Updates the trust store.
UpdateUserAccessLoggingSettingsResult	updateUserAccessLoggingSettings(UpdateUserAccessLoggingSettingsRequest updateUserAccessLoggingSettingsRequest) Updates the user access logging settings.
UpdateUserSettingsResult	updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest) Updates the user settings.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateBrowserSettings

AssociateBrowserSettingsResult associateBrowserSettings(AssociateBrowserSettingsRequest associateBrowserSettingsRequest)

Associates a browser settings resource with a web portal.

Parameters:

associateBrowserSettingsRequest -

Returns:

Result of the AssociateBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

associateNetworkSettings

AssociateNetworkSettingsResult associateNetworkSettings(AssociateNetworkSettingsRequest associateNetworkSettingsRequest)

Associates a network settings resource with a web portal.

Parameters:

associateNetworkSettingsRequest -

Returns:

Result of the AssociateNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

associateTrustStore

AssociateTrustStoreResult associateTrustStore(AssociateTrustStoreRequest associateTrustStoreRequest)

Associates a trust store with a web portal.

Parameters:

associateTrustStoreRequest -

Returns:

Result of the AssociateTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

associateUserAccessLoggingSettings

AssociateUserAccessLoggingSettingsResult associateUserAccessLoggingSettings(AssociateUserAccessLoggingSettingsRequest associateUserAccessLoggingSettingsRequest)

Associates a user access logging settings resource with a web portal.

Parameters:

associateUserAccessLoggingSettingsRequest -

Returns:

Result of the AssociateUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

associateUserSettings

AssociateUserSettingsResult associateUserSettings(AssociateUserSettingsRequest associateUserSettingsRequest)

Associates a user settings resource with a web portal.

Parameters:

associateUserSettingsRequest -

Returns:

Result of the AssociateUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createBrowserSettings

CreateBrowserSettingsResult createBrowserSettings(CreateBrowserSettingsRequest createBrowserSettingsRequest)

Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

Parameters:

createBrowserSettingsRequest -

Returns:

Result of the CreateBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createIdentityProvider

CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)

Creates an identity provider resource that is then associated with a web portal.

Parameters:

createIdentityProviderRequest -

Returns:

Result of the CreateIdentityProvider operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createNetworkSettings

CreateNetworkSettingsResult createNetworkSettings(CreateNetworkSettingsRequest createNetworkSettingsRequest)

Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

Parameters:

createNetworkSettingsRequest -

Returns:

Result of the CreateNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createPortal

CreatePortalResult createPortal(CreatePortalRequest createPortalRequest)

Creates a web portal.

Parameters:

createPortalRequest -

Returns:

Result of the CreatePortal operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createTrustStore

CreateTrustStoreResult createTrustStore(CreateTrustStoreRequest createTrustStoreRequest)

Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.

Parameters:

createTrustStoreRequest -

Returns:

Result of the CreateTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createUserAccessLoggingSettings

CreateUserAccessLoggingSettingsResult createUserAccessLoggingSettings(CreateUserAccessLoggingSettingsRequest createUserAccessLoggingSettingsRequest)

Creates a user access logging settings resource that can be associated with a web portal.

Parameters:

createUserAccessLoggingSettingsRequest -

Returns:

Result of the CreateUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

createUserSettings

CreateUserSettingsResult createUserSettings(CreateUserSettingsRequest createUserSettingsRequest)

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

Parameters:

createUserSettingsRequest -

Returns:

Result of the CreateUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteBrowserSettings

DeleteBrowserSettingsResult deleteBrowserSettings(DeleteBrowserSettingsRequest deleteBrowserSettingsRequest)

Deletes browser settings.

Parameters:

deleteBrowserSettingsRequest -

Returns:

Result of the DeleteBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteIdentityProvider

DeleteIdentityProviderResult deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)

Deletes the identity provider.

Parameters:

deleteIdentityProviderRequest -

Returns:

Result of the DeleteIdentityProvider operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteNetworkSettings

DeleteNetworkSettingsResult deleteNetworkSettings(DeleteNetworkSettingsRequest deleteNetworkSettingsRequest)

Deletes network settings.

Parameters:

deleteNetworkSettingsRequest -

Returns:

Result of the DeleteNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deletePortal

DeletePortalResult deletePortal(DeletePortalRequest deletePortalRequest)

Deletes a web portal.

Parameters:

deletePortalRequest -

Returns:

Result of the DeletePortal operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteTrustStore

DeleteTrustStoreResult deleteTrustStore(DeleteTrustStoreRequest deleteTrustStoreRequest)

Deletes the trust store.

Parameters:

deleteTrustStoreRequest -

Returns:

Result of the DeleteTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteUserAccessLoggingSettings

DeleteUserAccessLoggingSettingsResult deleteUserAccessLoggingSettings(DeleteUserAccessLoggingSettingsRequest deleteUserAccessLoggingSettingsRequest)

Deletes user access logging settings.

Parameters:

deleteUserAccessLoggingSettingsRequest -

Returns:

Result of the DeleteUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

deleteUserSettings

DeleteUserSettingsResult deleteUserSettings(DeleteUserSettingsRequest deleteUserSettingsRequest)

Deletes user settings.

Parameters:

deleteUserSettingsRequest -

Returns:

Result of the DeleteUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

ConflictException - There is a conflict.

See Also:

AWS API Documentation

disassociateBrowserSettings

DisassociateBrowserSettingsResult disassociateBrowserSettings(DisassociateBrowserSettingsRequest disassociateBrowserSettingsRequest)

Disassociates browser settings from a web portal.

Parameters:

disassociateBrowserSettingsRequest -

Returns:

Result of the DisassociateBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

disassociateNetworkSettings

DisassociateNetworkSettingsResult disassociateNetworkSettings(DisassociateNetworkSettingsRequest disassociateNetworkSettingsRequest)

Disassociates network settings from a web portal.

Parameters:

disassociateNetworkSettingsRequest -

Returns:

Result of the DisassociateNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

disassociateTrustStore

DisassociateTrustStoreResult disassociateTrustStore(DisassociateTrustStoreRequest disassociateTrustStoreRequest)

Disassociates a trust store from a web portal.

Parameters:

disassociateTrustStoreRequest -

Returns:

Result of the DisassociateTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

disassociateUserAccessLoggingSettings

DisassociateUserAccessLoggingSettingsResult disassociateUserAccessLoggingSettings(DisassociateUserAccessLoggingSettingsRequest disassociateUserAccessLoggingSettingsRequest)

Disassociates user access logging settings from a web portal.

Parameters:

disassociateUserAccessLoggingSettingsRequest -

Returns:

Result of the DisassociateUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

disassociateUserSettings

DisassociateUserSettingsResult disassociateUserSettings(DisassociateUserSettingsRequest disassociateUserSettingsRequest)

Disassociates user settings from a web portal.

Parameters:

disassociateUserSettingsRequest -

Returns:

Result of the DisassociateUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getBrowserSettings

GetBrowserSettingsResult getBrowserSettings(GetBrowserSettingsRequest getBrowserSettingsRequest)

Gets browser settings.

Parameters:

getBrowserSettingsRequest -

Returns:

Result of the GetBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getIdentityProvider

GetIdentityProviderResult getIdentityProvider(GetIdentityProviderRequest getIdentityProviderRequest)

Gets the identity provider.

Parameters:

getIdentityProviderRequest -

Returns:

Result of the GetIdentityProvider operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getNetworkSettings

GetNetworkSettingsResult getNetworkSettings(GetNetworkSettingsRequest getNetworkSettingsRequest)

Gets the network settings.

Parameters:

getNetworkSettingsRequest -

Returns:

Result of the GetNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getPortal

GetPortalResult getPortal(GetPortalRequest getPortalRequest)

Gets the web portal.

Parameters:

getPortalRequest -

Returns:

Result of the GetPortal operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getPortalServiceProviderMetadata

GetPortalServiceProviderMetadataResult getPortalServiceProviderMetadata(GetPortalServiceProviderMetadataRequest getPortalServiceProviderMetadataRequest)

Gets the service provider metadata.

Parameters:

getPortalServiceProviderMetadataRequest -

Returns:

Result of the GetPortalServiceProviderMetadata operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getTrustStore

GetTrustStoreResult getTrustStore(GetTrustStoreRequest getTrustStoreRequest)

Gets the trust store.

Parameters:

getTrustStoreRequest -

Returns:

Result of the GetTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getTrustStoreCertificate

GetTrustStoreCertificateResult getTrustStoreCertificate(GetTrustStoreCertificateRequest getTrustStoreCertificateRequest)

Gets the trust store certificate.

Parameters:

getTrustStoreCertificateRequest -

Returns:

Result of the GetTrustStoreCertificate operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getUserAccessLoggingSettings

GetUserAccessLoggingSettingsResult getUserAccessLoggingSettings(GetUserAccessLoggingSettingsRequest getUserAccessLoggingSettingsRequest)

Gets user access logging settings.

Parameters:

getUserAccessLoggingSettingsRequest -

Returns:

Result of the GetUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

getUserSettings

GetUserSettingsResult getUserSettings(GetUserSettingsRequest getUserSettingsRequest)

Gets user settings.

Parameters:

getUserSettingsRequest -

Returns:

Result of the GetUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listBrowserSettings

ListBrowserSettingsResult listBrowserSettings(ListBrowserSettingsRequest listBrowserSettingsRequest)

Retrieves a list of browser settings.

Parameters:

listBrowserSettingsRequest -

Returns:

Result of the ListBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listIdentityProviders

ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)

Retrieves a list of identity providers for a specific web portal.

Parameters:

listIdentityProvidersRequest -

Returns:

Result of the ListIdentityProviders operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listNetworkSettings

ListNetworkSettingsResult listNetworkSettings(ListNetworkSettingsRequest listNetworkSettingsRequest)

Retrieves a list of network settings.

Parameters:

listNetworkSettingsRequest -

Returns:

Result of the ListNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listPortals

ListPortalsResult listPortals(ListPortalsRequest listPortalsRequest)

Retrieves a list or web portals.

Parameters:

listPortalsRequest -

Returns:

Result of the ListPortals operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Retrieves a list of tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listTrustStoreCertificates

ListTrustStoreCertificatesResult listTrustStoreCertificates(ListTrustStoreCertificatesRequest listTrustStoreCertificatesRequest)

Retrieves a list of trust store certificates.

Parameters:

listTrustStoreCertificatesRequest -

Returns:

Result of the ListTrustStoreCertificates operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listTrustStores

ListTrustStoresResult listTrustStores(ListTrustStoresRequest listTrustStoresRequest)

Retrieves a list of trust stores.

Parameters:

listTrustStoresRequest -

Returns:

Result of the ListTrustStores operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listUserAccessLoggingSettings

ListUserAccessLoggingSettingsResult listUserAccessLoggingSettings(ListUserAccessLoggingSettingsRequest listUserAccessLoggingSettingsRequest)

Retrieves a list of user access logging settings.

Parameters:

listUserAccessLoggingSettingsRequest -

Returns:

Result of the ListUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

listUserSettings

ListUserSettingsResult listUserSettings(ListUserSettingsRequest listUserSettingsRequest)

Retrieves a list of user settings.

Parameters:

listUserSettingsRequest -

Returns:

Result of the ListUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds or overwrites one or more tags for the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

TooManyTagsException - There are too many tags.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateBrowserSettings

UpdateBrowserSettingsResult updateBrowserSettings(UpdateBrowserSettingsRequest updateBrowserSettingsRequest)

Updates browser settings.

Parameters:

updateBrowserSettingsRequest -

Returns:

Result of the UpdateBrowserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateIdentityProvider

UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)

Updates the identity provider.

Parameters:

updateIdentityProviderRequest -

Returns:

Result of the UpdateIdentityProvider operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateNetworkSettings

UpdateNetworkSettingsResult updateNetworkSettings(UpdateNetworkSettingsRequest updateNetworkSettingsRequest)

Updates network settings.

Parameters:

updateNetworkSettingsRequest -

Returns:

Result of the UpdateNetworkSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updatePortal

UpdatePortalResult updatePortal(UpdatePortalRequest updatePortalRequest)

Updates a web portal.

Parameters:

updatePortalRequest -

Returns:

Result of the UpdatePortal operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateTrustStore

UpdateTrustStoreResult updateTrustStore(UpdateTrustStoreRequest updateTrustStoreRequest)

Updates the trust store.

Parameters:

updateTrustStoreRequest -

Returns:

Result of the UpdateTrustStore operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ServiceQuotaExceededException - The service quota has been exceeded.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateUserAccessLoggingSettings

UpdateUserAccessLoggingSettingsResult updateUserAccessLoggingSettings(UpdateUserAccessLoggingSettingsRequest updateUserAccessLoggingSettingsRequest)

Updates the user access logging settings.

Parameters:

updateUserAccessLoggingSettingsRequest -

Returns:

Result of the UpdateUserAccessLoggingSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

updateUserSettings

UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)

Updates the user settings.

Parameters:

updateUserSettingsRequest -

Returns:

Result of the UpdateUserSettings operation returned by the service.

Throws:

InternalServerException - There is an internal server error.

ResourceNotFoundException - The resource cannot be found.

AccessDeniedException - Access is denied.

ThrottlingException - There is a throttling error.

ValidationException - There is a validation error.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.