# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.WorkSpacesWeb do
@moduledoc """
Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built
specifically to facilitate secure, web-based workloads.
WorkSpaces Secure Browser 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 Secure Browser provides simple policy tools tailored for
user
interactions, while offloading common tasks like capacity management, scaling,
and
maintaining browser images.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
create_ip_access_settings_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("clientToken") => String.t() | atom(),
optional("customerManagedKey") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("tags") => list(tag()),
required("ipRules") => list(ip_rule())
}
"""
@type create_ip_access_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_rule() :: %{
"description" => String.t() | atom(),
"ipRange" => String.t() | atom()
}
"""
@type ip_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_browser_settings_response() :: %{
"browserSettingsArn" => String.t() | atom()
}
"""
@type create_browser_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
expire_session_response() :: %{}
"""
@type expire_session_response() :: %{}
@typedoc """
## Example:
get_trust_store_certificate_request() :: %{
required("thumbprint") => String.t() | atom()
}
"""
@type get_trust_store_certificate_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_ip_access_settings_response() :: %{
"ipAccessSettingsArn" => String.t() | atom()
}
"""
@type create_ip_access_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_access_settings_summary() :: %{
"creationDate" => non_neg_integer(),
"description" => String.t() | atom(),
"displayName" => String.t() | atom(),
"ipAccessSettingsArn" => String.t() | atom()
}
"""
@type ip_access_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_user_settings_response() :: %{
"portalArn" => String.t() | atom(),
"userSettingsArn" => String.t() | atom()
}
"""
@type associate_user_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cookie_synchronization_configuration() :: %{
"allowlist" => list(cookie_specification()),
"blocklist" => list(cookie_specification())
}
"""
@type cookie_synchronization_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
optional("clientToken") => String.t() | atom(),
required("tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trust_store_summary() :: %{
"trustStoreArn" => String.t() | atom()
}
"""
@type trust_store_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_ip_access_settings_response() :: %{
"ipAccessSettings" => list(ip_access_settings_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_ip_access_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_portal_request() :: %{}
"""
@type get_portal_request() :: %{}
@typedoc """
## Example:
get_network_settings_request() :: %{}
"""
@type get_network_settings_request() :: %{}
@typedoc """
## Example:
create_user_access_logging_settings_response() :: %{
"userAccessLoggingSettingsArn" => String.t() | atom()
}
"""
@type create_user_access_logging_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_summary() :: %{
"endTime" => non_neg_integer(),
"portalArn" => String.t() | atom(),
"sessionId" => String.t() | atom(),
"startTime" => non_neg_integer(),
"status" => list(any()),
"username" => String.t() | atom()
}
"""
@type session_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_identity_providers_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_identity_providers_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_response() :: %{
"session" => session()
}
"""
@type get_session_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_portal_service_provider_metadata_request() :: %{}
"""
@type get_portal_service_provider_metadata_request() :: %{}
@typedoc """
## Example:
list_trust_store_certificates_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_trust_store_certificates_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_session_logger_request() :: %{
optional("displayName") => String.t() | atom(),
optional("eventFilter") => list(),
optional("logConfiguration") => log_configuration()
}
"""
@type update_session_logger_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_identity_provider_response() :: %{
"identityProvider" => identity_provider()
}
"""
@type update_identity_provider_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_identity_provider_response() :: %{
"identityProvider" => identity_provider()
}
"""
@type get_identity_provider_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_browser_settings_request() :: %{
optional("browserPolicy") => String.t() | atom(),
optional("clientToken") => String.t() | atom(),
optional("webContentFilteringPolicy") => web_content_filtering_policy()
}
"""
@type update_browser_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_user_access_logging_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_user_access_logging_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_network_settings_response() :: %{
"networkSettings" => network_settings()
}
"""
@type update_network_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
create_network_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("securityGroupIds") => list(String.t() | atom()),
required("subnetIds") => list(String.t() | atom()),
required("vpcId") => String.t() | atom()
}
"""
@type create_network_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_trust_store_request() :: %{}
"""
@type get_trust_store_request() :: %{}
@typedoc """
## Example:
inline_redaction_configuration() :: %{
"globalConfidenceLevel" => integer(),
"globalEnforcedUrls" => list(String.t() | atom()),
"globalExemptUrls" => list(String.t() | atom()),
"inlineRedactionPatterns" => list(inline_redaction_pattern())
}
"""
@type inline_redaction_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_trust_store_request() :: %{
required("trustStoreArn") => String.t() | atom()
}
"""
@type associate_trust_store_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cookie_specification() :: %{
"domain" => String.t() | atom(),
"name" => String.t() | atom(),
"path" => String.t() | atom()
}
"""
@type cookie_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_trust_store_response() :: %{}
"""
@type disassociate_trust_store_response() :: %{}
@typedoc """
## Example:
associate_user_access_logging_settings_request() :: %{
required("userAccessLoggingSettingsArn") => String.t() | atom()
}
"""
@type associate_user_access_logging_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_user_settings_request() :: %{
required("userSettingsArn") => String.t() | atom()
}
"""
@type associate_user_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_logger_response() :: %{
"sessionLogger" => session_logger()
}
"""
@type get_session_logger_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_identity_provider_response() :: %{
"identityProviderArn" => String.t() | atom()
}
"""
@type create_identity_provider_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_browser_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_browser_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_user_access_logging_settings_request() :: %{}
"""
@type delete_user_access_logging_settings_request() :: %{}
@typedoc """
## Example:
create_portal_response() :: %{
"portalArn" => String.t() | atom(),
"portalEndpoint" => String.t() | atom()
}
"""
@type create_portal_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_ip_access_settings_response() :: %{
"ipAccessSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom()
}
"""
@type associate_ip_access_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_user_settings_response() :: %{
"nextToken" => String.t() | atom(),
"userSettings" => list(user_settings_summary())
}
"""
@type list_user_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_trust_store_response() :: %{
"trustStore" => trust_store()
}
"""
@type get_trust_store_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_data_protection_settings_response() :: %{
"dataProtectionSettingsArn" => String.t() | atom()
}
"""
@type create_data_protection_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user_access_logging_settings() :: %{
"associatedPortalArns" => list(String.t() | atom()),
"kinesisStreamArn" => String.t() | atom(),
"userAccessLoggingSettingsArn" => String.t() | atom()
}
"""
@type user_access_logging_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_user_access_logging_settings_request() :: %{}
"""
@type get_user_access_logging_settings_request() :: %{}
@typedoc """
## Example:
delete_identity_provider_request() :: %{}
"""
@type delete_identity_provider_request() :: %{}
@typedoc """
## Example:
expire_session_request() :: %{}
"""
@type expire_session_request() :: %{}
@typedoc """
## Example:
delete_session_logger_request() :: %{}
"""
@type delete_session_logger_request() :: %{}
@typedoc """
## Example:
list_session_loggers_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_session_loggers_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_browser_settings_response() :: %{}
"""
@type disassociate_browser_settings_response() :: %{}
@typedoc """
## Example:
list_ip_access_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_ip_access_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_user_settings_response() :: %{
"userSettings" => user_settings()
}
"""
@type get_user_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_ip_access_settings_response() :: %{
"ipAccessSettings" => ip_access_settings()
}
"""
@type update_ip_access_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_trust_store_response() :: %{
"portalArn" => String.t() | atom(),
"trustStoreArn" => String.t() | atom()
}
"""
@type associate_trust_store_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_trust_store_request() :: %{
optional("certificatesToAdd") => list(binary()),
optional("certificatesToDelete") => list(String.t() | atom()),
optional("clientToken") => String.t() | atom()
}
"""
@type update_trust_store_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user_settings_summary() :: %{
"cookieSynchronizationConfiguration" => cookie_synchronization_configuration(),
"copyAllowed" => String.t() | atom(),
"deepLinkAllowed" => String.t() | atom(),
"disconnectTimeoutInMinutes" => integer(),
"downloadAllowed" => String.t() | atom(),
"idleDisconnectTimeoutInMinutes" => integer(),
"pasteAllowed" => String.t() | atom(),
"printAllowed" => String.t() | atom(),
"toolbarConfiguration" => toolbar_configuration(),
"uploadAllowed" => String.t() | atom(),
"userSettingsArn" => String.t() | atom()
}
"""
@type user_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user_access_logging_settings_summary() :: %{
"kinesisStreamArn" => String.t() | atom(),
"userAccessLoggingSettingsArn" => String.t() | atom()
}
"""
@type user_access_logging_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_user_settings_response() :: %{}
"""
@type delete_user_settings_response() :: %{}
@typedoc """
## Example:
associate_network_settings_request() :: %{
required("networkSettingsArn") => String.t() | atom()
}
"""
@type associate_network_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_request() :: %{}
"""
@type get_session_request() :: %{}
@typedoc """
## Example:
associate_browser_settings_request() :: %{
required("browserSettingsArn") => String.t() | atom()
}
"""
@type associate_browser_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_protection_settings_response() :: %{}
"""
@type delete_data_protection_settings_response() :: %{}
@typedoc """
## Example:
list_trust_stores_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_trust_stores_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_trust_store_request() :: %{}
"""
@type delete_trust_store_request() :: %{}
@typedoc """
## Example:
delete_browser_settings_request() :: %{}
"""
@type delete_browser_settings_request() :: %{}
@typedoc """
## Example:
certificate_summary() :: %{
"issuer" => String.t() | atom(),
"notValidAfter" => non_neg_integer(),
"notValidBefore" => non_neg_integer(),
"subject" => String.t() | atom(),
"thumbprint" => String.t() | atom()
}
"""
@type certificate_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_browser_settings_request() :: %{}
"""
@type get_browser_settings_request() :: %{}
@typedoc """
## Example:
get_ip_access_settings_response() :: %{
"ipAccessSettings" => ip_access_settings()
}
"""
@type get_ip_access_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
network_settings() :: %{
"associatedPortalArns" => list(String.t() | atom()),
"networkSettingsArn" => String.t() | atom(),
"securityGroupIds" => list(String.t() | atom()),
"subnetIds" => list(String.t() | atom()),
"vpcId" => String.t() | atom()
}
"""
@type network_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_session_logger_request() :: %{
required("sessionLoggerArn") => String.t() | atom()
}
"""
@type associate_session_logger_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_portals_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_portals_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_log_configuration() :: %{
"bucket" => String.t() | atom(),
"bucketOwner" => String.t() | atom(),
"folderStructure" => list(any()),
"keyPrefix" => String.t() | atom(),
"logFileFormat" => list(any())
}
"""
@type s3_log_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
inline_redaction_pattern() :: %{
"builtInPatternId" => String.t() | atom(),
"confidenceLevel" => integer(),
"customPattern" => custom_pattern(),
"enforcedUrls" => list(String.t() | atom()),
"exemptUrls" => list(String.t() | atom()),
"redactionPlaceHolder" => redaction_place_holder()
}
"""
@type inline_redaction_pattern() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sessions_response() :: %{
"nextToken" => String.t() | atom(),
"sessions" => list(session_summary())
}
"""
@type list_sessions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_ip_access_settings_request() :: %{}
"""
@type delete_ip_access_settings_request() :: %{}
@typedoc """
## Example:
delete_portal_request() :: %{}
"""
@type delete_portal_request() :: %{}
@typedoc """
## Example:
update_user_settings_response() :: %{
"userSettings" => user_settings()
}
"""
@type update_user_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_session_logger_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("clientToken") => String.t() | atom(),
optional("customerManagedKey") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("tags") => list(tag()),
required("eventFilter") => list(),
required("logConfiguration") => log_configuration()
}
"""
@type create_session_logger_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_trust_store_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("certificateList") => list(binary())
}
"""
@type create_trust_store_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t() | atom(),
"resourceId" => String.t() | atom(),
"resourceType" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom(),
"resourceId" => String.t() | atom(),
"resourceType" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_network_settings_response() :: %{
"networkSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom()
}
"""
@type associate_network_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_session_loggers_response() :: %{
"nextToken" => String.t() | atom(),
"sessionLoggers" => list(session_logger_summary())
}
"""
@type list_session_loggers_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_user_access_logging_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("kinesisStreamArn") => String.t() | atom()
}
"""
@type update_user_access_logging_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_user_settings_request() :: %{}
"""
@type get_user_settings_request() :: %{}
@typedoc """
## Example:
create_network_settings_response() :: %{
"networkSettingsArn" => String.t() | atom()
}
"""
@type create_network_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_browser_settings_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("browserPolicy") => String.t() | atom(),
optional("clientToken") => String.t() | atom(),
optional("customerManagedKey") => String.t() | atom(),
optional("tags") => list(tag()),
optional("webContentFilteringPolicy") => web_content_filtering_policy()
}
"""
@type create_browser_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_network_settings_request() :: %{}
"""
@type disassociate_network_settings_request() :: %{}
@typedoc """
## Example:
delete_portal_response() :: %{}
"""
@type delete_portal_response() :: %{}
@typedoc """
## Example:
associate_data_protection_settings_response() :: %{
"dataProtectionSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom()
}
"""
@type associate_data_protection_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_network_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_network_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_portal_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("authenticationType") => String.t() | atom(),
optional("clientToken") => String.t() | atom(),
optional("customerManagedKey") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("instanceType") => String.t() | atom(),
optional("maxConcurrentSessions") => integer(),
optional("tags") => list(tag())
}
"""
@type create_portal_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => String.t() | atom(),
"quotaCode" => String.t() | atom(),
"resourceId" => String.t() | atom(),
"resourceType" => String.t() | atom(),
"serviceCode" => String.t() | atom()
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_network_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("securityGroupIds") => list(String.t() | atom()),
optional("subnetIds") => list(String.t() | atom()),
optional("vpcId") => String.t() | atom()
}
"""
@type update_network_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_portal_response() :: %{
"portal" => portal()
}
"""
@type update_portal_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_network_settings_response() :: %{
"networkSettings" => network_settings()
}
"""
@type get_network_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_protection_settings() :: %{
"additionalEncryptionContext" => map(),
"associatedPortalArns" => list(String.t() | atom()),
"creationDate" => non_neg_integer(),
"customerManagedKey" => String.t() | atom(),
"dataProtectionSettingsArn" => String.t() | atom(),
"description" => String.t() | atom(),
"displayName" => String.t() | atom(),
"inlineRedactionConfiguration" => inline_redaction_configuration()
}
"""
@type data_protection_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
web_content_filtering_policy() :: %{
"allowedUrls" => list(String.t() | atom()),
"blockedCategories" => list(list(any())()),
"blockedUrls" => list(String.t() | atom())
}
"""
@type web_content_filtering_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_user_settings_response() :: %{}
"""
@type disassociate_user_settings_response() :: %{}
@typedoc """
## Example:
update_data_protection_settings_response() :: %{
"dataProtectionSettings" => data_protection_settings()
}
"""
@type update_data_protection_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_session_logger_response() :: %{}
"""
@type delete_session_logger_response() :: %{}
@typedoc """
## Example:
browser_settings_summary() :: %{
"browserSettingsArn" => String.t() | atom()
}
"""
@type browser_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_session_logger_response() :: %{
"portalArn" => String.t() | atom(),
"sessionLoggerArn" => String.t() | atom()
}
"""
@type associate_session_logger_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_data_protection_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("inlineRedactionConfiguration") => inline_redaction_configuration()
}
"""
@type update_data_protection_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_user_settings_response() :: %{
"userSettingsArn" => String.t() | atom()
}
"""
@type create_user_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_trust_stores_response() :: %{
"nextToken" => String.t() | atom(),
"trustStores" => list(trust_store_summary())
}
"""
@type list_trust_stores_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_browser_settings_request() :: %{}
"""
@type disassociate_browser_settings_request() :: %{}
@typedoc """
## Example:
delete_network_settings_request() :: %{}
"""
@type delete_network_settings_request() :: %{}
@typedoc """
## Example:
identity_provider_summary() :: %{
"identityProviderArn" => String.t() | atom(),
"identityProviderName" => String.t() | atom(),
"identityProviderType" => String.t() | atom()
}
"""
@type identity_provider_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_session_logger_request() :: %{}
"""
@type disassociate_session_logger_request() :: %{}
@typedoc """
## Example:
associate_ip_access_settings_request() :: %{
required("ipAccessSettingsArn") => String.t() | atom()
}
"""
@type associate_ip_access_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_sessions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("sessionId") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("status") => list(any()),
optional("username") => String.t() | atom()
}
"""
@type list_sessions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_data_protection_settings_response() :: %{
"dataProtectionSettings" => list(data_protection_settings_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_data_protection_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception_field() :: %{
"message" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type validation_exception_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
network_settings_summary() :: %{
"networkSettingsArn" => String.t() | atom(),
"vpcId" => String.t() | atom()
}
"""
@type network_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_user_access_logging_settings_response() :: %{}
"""
@type disassociate_user_access_logging_settings_response() :: %{}
@typedoc """
## Example:
session() :: %{
"clientIpAddresses" => list(String.t() | atom()),
"endTime" => non_neg_integer(),
"portalArn" => String.t() | atom(),
"sessionId" => String.t() | atom(),
"startTime" => non_neg_integer(),
"status" => list(any()),
"username" => String.t() | atom()
}
"""
@type session() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_portal_service_provider_metadata_response() :: %{
"portalArn" => String.t() | atom(),
"serviceProviderSamlMetadata" => String.t() | atom()
}
"""
@type get_portal_service_provider_metadata_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_user_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("cookieSynchronizationConfiguration") => cookie_synchronization_configuration(),
optional("copyAllowed") => String.t() | atom(),
optional("deepLinkAllowed") => String.t() | atom(),
optional("disconnectTimeoutInMinutes") => integer(),
optional("downloadAllowed") => String.t() | atom(),
optional("idleDisconnectTimeoutInMinutes") => integer(),
optional("pasteAllowed") => String.t() | atom(),
optional("printAllowed") => String.t() | atom(),
optional("toolbarConfiguration") => toolbar_configuration(),
optional("uploadAllowed") => String.t() | atom()
}
"""
@type update_user_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_ip_access_settings_response() :: %{}
"""
@type disassociate_ip_access_settings_response() :: %{}
@typedoc """
## Example:
list_network_settings_response() :: %{
"networkSettings" => list(network_settings_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_network_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
identity_provider() :: %{
"identityProviderArn" => String.t() | atom(),
"identityProviderDetails" => map(),
"identityProviderName" => String.t() | atom(),
"identityProviderType" => String.t() | atom()
}
"""
@type identity_provider() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_ip_access_settings_response() :: %{}
"""
@type delete_ip_access_settings_response() :: %{}
@typedoc """
## Example:
get_browser_settings_response() :: %{
"browserSettings" => browser_settings()
}
"""
@type get_browser_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_trust_store_certificates_response() :: %{
"certificateList" => list(certificate_summary()),
"nextToken" => String.t() | atom(),
"trustStoreArn" => String.t() | atom()
}
"""
@type list_trust_store_certificates_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_portals_response() :: %{
"nextToken" => String.t() | atom(),
"portals" => list(portal_summary())
}
"""
@type list_portals_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => String.t() | atom(),
"retryAfterSeconds" => integer()
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_protection_settings_request() :: %{}
"""
@type delete_data_protection_settings_request() :: %{}
@typedoc """
## Example:
certificate() :: %{
"body" => binary(),
"issuer" => String.t() | atom(),
"notValidAfter" => non_neg_integer(),
"notValidBefore" => non_neg_integer(),
"subject" => String.t() | atom(),
"thumbprint" => String.t() | atom()
}
"""
@type certificate() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_ip_access_settings_request() :: %{}
"""
@type disassociate_ip_access_settings_request() :: %{}
@typedoc """
## Example:
get_trust_store_certificate_response() :: %{
"certificate" => certificate(),
"trustStoreArn" => String.t() | atom()
}
"""
@type get_trust_store_certificate_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_identity_provider_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("identityProviderDetails") => map(),
required("identityProviderName") => String.t() | atom(),
required("identityProviderType") => String.t() | atom(),
required("portalArn") => String.t() | atom()
}
"""
@type create_identity_provider_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_browser_settings_response() :: %{
"browserSettings" => browser_settings()
}
"""
@type update_browser_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_network_settings_response() :: %{}
"""
@type delete_network_settings_response() :: %{}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_trust_store_response() :: %{
"trustStoreArn" => String.t() | atom()
}
"""
@type create_trust_store_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_session_logger_response() :: %{
"sessionLogger" => session_logger()
}
"""
@type update_session_logger_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_identity_provider_response() :: %{}
"""
@type delete_identity_provider_response() :: %{}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
redaction_place_holder() :: %{
"redactionPlaceHolderText" => String.t() | atom(),
"redactionPlaceHolderType" => String.t() | atom()
}
"""
@type redaction_place_holder() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_user_settings_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("clientToken") => String.t() | atom(),
optional("cookieSynchronizationConfiguration") => cookie_synchronization_configuration(),
optional("customerManagedKey") => String.t() | atom(),
optional("deepLinkAllowed") => String.t() | atom(),
optional("disconnectTimeoutInMinutes") => integer(),
optional("idleDisconnectTimeoutInMinutes") => integer(),
optional("tags") => list(tag()),
optional("toolbarConfiguration") => toolbar_configuration(),
required("copyAllowed") => String.t() | atom(),
required("downloadAllowed") => String.t() | atom(),
required("pasteAllowed") => String.t() | atom(),
required("printAllowed") => String.t() | atom(),
required("uploadAllowed") => String.t() | atom()
}
"""
@type create_user_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_user_settings_request() :: %{}
"""
@type delete_user_settings_request() :: %{}
@typedoc """
## Example:
data_protection_settings_summary() :: %{
"creationDate" => non_neg_integer(),
"dataProtectionSettingsArn" => String.t() | atom(),
"description" => String.t() | atom(),
"displayName" => String.t() | atom()
}
"""
@type data_protection_settings_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_portal_request() :: %{
optional("authenticationType") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("instanceType") => String.t() | atom(),
optional("maxConcurrentSessions") => integer()
}
"""
@type update_portal_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_protection_settings_request() :: %{}
"""
@type get_data_protection_settings_request() :: %{}
@typedoc """
## Example:
create_data_protection_settings_request() :: %{
optional("additionalEncryptionContext") => map(),
optional("clientToken") => String.t() | atom(),
optional("customerManagedKey") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("inlineRedactionConfiguration") => inline_redaction_configuration(),
optional("tags") => list(tag())
}
"""
@type create_data_protection_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ip_access_settings() :: %{
"additionalEncryptionContext" => map(),
"associatedPortalArns" => list(String.t() | atom()),
"creationDate" => non_neg_integer(),
"customerManagedKey" => String.t() | atom(),
"description" => String.t() | atom(),
"displayName" => String.t() | atom(),
"ipAccessSettingsArn" => String.t() | atom(),
"ipRules" => list(ip_rule())
}
"""
@type ip_access_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_data_protection_settings_response() :: %{}
"""
@type disassociate_data_protection_settings_response() :: %{}
@typedoc """
## Example:
validation_exception() :: %{
"fieldList" => list(validation_exception_field()),
"message" => String.t() | atom(),
"reason" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
get_ip_access_settings_request() :: %{}
"""
@type get_ip_access_settings_request() :: %{}
@typedoc """
## Example:
list_identity_providers_response() :: %{
"identityProviders" => list(identity_provider_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_identity_providers_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_user_access_logging_settings_request() :: %{}
"""
@type disassociate_user_access_logging_settings_request() :: %{}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom(),
"quotaCode" => String.t() | atom(),
"retryAfterSeconds" => integer(),
"serviceCode" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_data_protection_settings_request() :: %{
required("dataProtectionSettingsArn") => String.t() | atom()
}
"""
@type associate_data_protection_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_browser_settings_response() :: %{
"browserSettings" => list(browser_settings_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_browser_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
toolbar_configuration() :: %{
"hiddenToolbarItems" => list(String.t() | atom()),
"maxDisplayResolution" => String.t() | atom(),
"toolbarType" => String.t() | atom(),
"visualMode" => String.t() | atom()
}
"""
@type toolbar_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_data_protection_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_data_protection_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_user_access_logging_settings_response() :: %{
"portalArn" => String.t() | atom(),
"userAccessLoggingSettingsArn" => String.t() | atom()
}
"""
@type associate_user_access_logging_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
portal_summary() :: %{
"authenticationType" => String.t() | atom(),
"browserSettingsArn" => String.t() | atom(),
"browserType" => String.t() | atom(),
"creationDate" => non_neg_integer(),
"dataProtectionSettingsArn" => String.t() | atom(),
"displayName" => String.t() | atom(),
"instanceType" => String.t() | atom(),
"ipAccessSettingsArn" => String.t() | atom(),
"maxConcurrentSessions" => integer(),
"networkSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom(),
"portalEndpoint" => String.t() | atom(),
"portalStatus" => String.t() | atom(),
"rendererType" => String.t() | atom(),
"sessionLoggerArn" => String.t() | atom(),
"trustStoreArn" => String.t() | atom(),
"userAccessLoggingSettingsArn" => String.t() | atom(),
"userSettingsArn" => String.t() | atom()
}
"""
@type portal_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_logger() :: %{
"additionalEncryptionContext" => map(),
"associatedPortalArns" => list(String.t() | atom()),
"creationDate" => non_neg_integer(),
"customerManagedKey" => String.t() | atom(),
"displayName" => String.t() | atom(),
"eventFilter" => list(),
"logConfiguration" => log_configuration(),
"sessionLoggerArn" => String.t() | atom()
}
"""
@type session_logger() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_identity_provider_request() :: %{}
"""
@type get_identity_provider_request() :: %{}
@typedoc """
## Example:
associate_browser_settings_response() :: %{
"browserSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom()
}
"""
@type associate_browser_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user_settings() :: %{
"additionalEncryptionContext" => map(),
"associatedPortalArns" => list(String.t() | atom()),
"cookieSynchronizationConfiguration" => cookie_synchronization_configuration(),
"copyAllowed" => String.t() | atom(),
"customerManagedKey" => String.t() | atom(),
"deepLinkAllowed" => String.t() | atom(),
"disconnectTimeoutInMinutes" => integer(),
"downloadAllowed" => String.t() | atom(),
"idleDisconnectTimeoutInMinutes" => integer(),
"pasteAllowed" => String.t() | atom(),
"printAllowed" => String.t() | atom(),
"toolbarConfiguration" => toolbar_configuration(),
"uploadAllowed" => String.t() | atom(),
"userSettingsArn" => String.t() | atom()
}
"""
@type user_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_portal_response() :: %{
"portal" => portal()
}
"""
@type get_portal_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_logger_summary() :: %{
"creationDate" => non_neg_integer(),
"displayName" => String.t() | atom(),
"logConfiguration" => log_configuration(),
"sessionLoggerArn" => String.t() | atom()
}
"""
@type session_logger_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_pattern() :: %{
"keywordRegex" => String.t() | atom(),
"patternDescription" => String.t() | atom(),
"patternName" => String.t() | atom(),
"patternRegex" => String.t() | atom()
}
"""
@type custom_pattern() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_user_access_logging_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("kinesisStreamArn") => String.t() | atom()
}
"""
@type create_user_access_logging_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_identity_provider_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("identityProviderDetails") => map(),
optional("identityProviderName") => String.t() | atom(),
optional("identityProviderType") => String.t() | atom()
}
"""
@type update_identity_provider_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_session_logger_request() :: %{}
"""
@type get_session_logger_request() :: %{}
@typedoc """
## Example:
disassociate_session_logger_response() :: %{}
"""
@type disassociate_session_logger_response() :: %{}
@typedoc """
## Example:
log_configuration() :: %{
"s3" => s3_log_configuration()
}
"""
@type log_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_user_access_logging_settings_response() :: %{
"nextToken" => String.t() | atom(),
"userAccessLoggingSettings" => list(user_access_logging_settings_summary())
}
"""
@type list_user_access_logging_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_protection_settings_response() :: %{
"dataProtectionSettings" => data_protection_settings()
}
"""
@type get_data_protection_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_user_settings_request() :: %{}
"""
@type disassociate_user_settings_request() :: %{}
@typedoc """
## Example:
disassociate_data_protection_settings_request() :: %{}
"""
@type disassociate_data_protection_settings_request() :: %{}
@typedoc """
## Example:
update_ip_access_settings_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("displayName") => String.t() | atom(),
optional("ipRules") => list(ip_rule())
}
"""
@type update_ip_access_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
browser_settings() :: %{
"additionalEncryptionContext" => map(),
"associatedPortalArns" => list(String.t() | atom()),
"browserPolicy" => String.t() | atom(),
"browserSettingsArn" => String.t() | atom(),
"customerManagedKey" => String.t() | atom(),
"webContentFilteringPolicy" => web_content_filtering_policy()
}
"""
@type browser_settings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_user_access_logging_settings_response() :: %{
"userAccessLoggingSettings" => user_access_logging_settings()
}
"""
@type update_user_access_logging_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_user_settings_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_user_settings_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
too_many_tags_exception() :: %{
"message" => String.t() | atom(),
"resourceName" => String.t() | atom()
}
"""
@type too_many_tags_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_browser_settings_response() :: %{}
"""
@type delete_browser_settings_response() :: %{}
@typedoc """
## Example:
disassociate_network_settings_response() :: %{}
"""
@type disassociate_network_settings_response() :: %{}
@typedoc """
## Example:
delete_user_access_logging_settings_response() :: %{}
"""
@type delete_user_access_logging_settings_response() :: %{}
@typedoc """
## Example:
delete_trust_store_response() :: %{}
"""
@type delete_trust_store_response() :: %{}
@typedoc """
## Example:
get_user_access_logging_settings_response() :: %{
"userAccessLoggingSettings" => user_access_logging_settings()
}
"""
@type get_user_access_logging_settings_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
portal() :: %{
"additionalEncryptionContext" => map(),
"authenticationType" => String.t() | atom(),
"browserSettingsArn" => String.t() | atom(),
"browserType" => String.t() | atom(),
"creationDate" => non_neg_integer(),
"customerManagedKey" => String.t() | atom(),
"dataProtectionSettingsArn" => String.t() | atom(),
"displayName" => String.t() | atom(),
"instanceType" => String.t() | atom(),
"ipAccessSettingsArn" => String.t() | atom(),
"maxConcurrentSessions" => integer(),
"networkSettingsArn" => String.t() | atom(),
"portalArn" => String.t() | atom(),
"portalEndpoint" => String.t() | atom(),
"portalStatus" => String.t() | atom(),
"rendererType" => String.t() | atom(),
"sessionLoggerArn" => String.t() | atom(),
"statusReason" => String.t() | atom(),
"trustStoreArn" => String.t() | atom(),
"userAccessLoggingSettingsArn" => String.t() | atom(),
"userSettingsArn" => String.t() | atom()
}
"""
@type portal() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_session_logger_response() :: %{
"sessionLoggerArn" => String.t() | atom()
}
"""
@type create_session_logger_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
trust_store() :: %{
"associatedPortalArns" => list(String.t() | atom()),
"trustStoreArn" => String.t() | atom()
}
"""
@type trust_store() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_trust_store_response() :: %{
"trustStoreArn" => String.t() | atom()
}
"""
@type update_trust_store_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_trust_store_request() :: %{}
"""
@type disassociate_trust_store_request() :: %{}
@type associate_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_identity_provider_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_portal_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type delete_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_identity_provider_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_portal_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type disassociate_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type disassociate_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type expire_session_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_identity_provider_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_portal_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_portal_service_provider_metadata_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_session_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_trust_store_certificate_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_identity_providers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_portals_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_session_loggers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_sessions_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_trust_store_certificates_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_trust_stores_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type tag_resource_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type untag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_browser_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_data_protection_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_identity_provider_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_ip_access_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_network_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_portal_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_session_logger_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_trust_store_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type update_user_access_logging_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_user_settings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
def metadata do
%{
api_version: "2020-07-08",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "workspaces-web",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "WorkSpaces Web",
signature_version: "v4",
signing_name: "workspaces-web",
target_prefix: nil
}
end
@doc """
Associates a browser settings resource with a web portal.
"""
@spec associate_browser_settings(
map(),
String.t() | atom(),
associate_browser_settings_request(),
list()
) ::
{:ok, associate_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_browser_settings_errors()}
def associate_browser_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/browserSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"browserSettingsArn", "browserSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a data protection settings resource with a web portal.
"""
@spec associate_data_protection_settings(
map(),
String.t() | atom(),
associate_data_protection_settings_request(),
list()
) ::
{:ok, associate_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_data_protection_settings_errors()}
def associate_data_protection_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/dataProtectionSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"dataProtectionSettingsArn", "dataProtectionSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates an IP access settings resource with a web portal.
"""
@spec associate_ip_access_settings(
map(),
String.t() | atom(),
associate_ip_access_settings_request(),
list()
) ::
{:ok, associate_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_ip_access_settings_errors()}
def associate_ip_access_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/ipAccessSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"ipAccessSettingsArn", "ipAccessSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a network settings resource with a web portal.
"""
@spec associate_network_settings(
map(),
String.t() | atom(),
associate_network_settings_request(),
list()
) ::
{:ok, associate_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_network_settings_errors()}
def associate_network_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/networkSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"networkSettingsArn", "networkSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a session logger with a portal.
"""
@spec associate_session_logger(
map(),
String.t() | atom(),
associate_session_logger_request(),
list()
) ::
{:ok, associate_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_session_logger_errors()}
def associate_session_logger(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/sessionLogger"
headers = []
custom_headers = []
{query_params, input} =
[
{"sessionLoggerArn", "sessionLoggerArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a trust store with a web portal.
"""
@spec associate_trust_store(map(), String.t() | atom(), associate_trust_store_request(), list()) ::
{:ok, associate_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_trust_store_errors()}
def associate_trust_store(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/trustStores"
headers = []
custom_headers = []
{query_params, input} =
[
{"trustStoreArn", "trustStoreArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a user access logging settings resource with a web portal.
"""
@spec associate_user_access_logging_settings(
map(),
String.t() | atom(),
associate_user_access_logging_settings_request(),
list()
) ::
{:ok, associate_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_user_access_logging_settings_errors()}
def associate_user_access_logging_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path =
"/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/userAccessLoggingSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"userAccessLoggingSettingsArn", "userAccessLoggingSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates a user settings resource with a web portal.
"""
@spec associate_user_settings(
map(),
String.t() | atom(),
associate_user_settings_request(),
list()
) ::
{:ok, associate_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_user_settings_errors()}
def associate_user_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/userSettings"
headers = []
custom_headers = []
{query_params, input} =
[
{"userSettingsArn", "userSettingsArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_browser_settings(map(), create_browser_settings_request(), list()) ::
{:ok, create_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_browser_settings_errors()}
def create_browser_settings(%Client{} = client, input, options \\ []) do
url_path = "/browserSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a data protection settings resource that can be associated with a web
portal.
"""
@spec create_data_protection_settings(map(), create_data_protection_settings_request(), list()) ::
{:ok, create_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_data_protection_settings_errors()}
def create_data_protection_settings(%Client{} = client, input, options \\ []) do
url_path = "/dataProtectionSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an identity provider resource that is then associated with a web portal.
"""
@spec create_identity_provider(map(), create_identity_provider_request(), list()) ::
{:ok, create_identity_provider_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_identity_provider_errors()}
def create_identity_provider(%Client{} = client, input, options \\ []) do
url_path = "/identityProviders"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an IP access settings resource that can be associated with a web portal.
"""
@spec create_ip_access_settings(map(), create_ip_access_settings_request(), list()) ::
{:ok, create_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_ip_access_settings_errors()}
def create_ip_access_settings(%Client{} = client, input, options \\ []) do
url_path = "/ipAccessSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_network_settings(map(), create_network_settings_request(), list()) ::
{:ok, create_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_network_settings_errors()}
def create_network_settings(%Client{} = client, input, options \\ []) do
url_path = "/networkSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a web portal.
"""
@spec create_portal(map(), create_portal_request(), list()) ::
{:ok, create_portal_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_portal_errors()}
def create_portal(%Client{} = client, input, options \\ []) do
url_path = "/portals"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a session logger.
"""
@spec create_session_logger(map(), create_session_logger_request(), list()) ::
{:ok, create_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_session_logger_errors()}
def create_session_logger(%Client{} = client, input, options \\ []) do
url_path = "/sessionLoggers"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_trust_store(map(), create_trust_store_request(), list()) ::
{:ok, create_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_trust_store_errors()}
def create_trust_store(%Client{} = client, input, options \\ []) do
url_path = "/trustStores"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a user access logging settings resource that can be associated with a
web
portal.
"""
@spec create_user_access_logging_settings(
map(),
create_user_access_logging_settings_request(),
list()
) ::
{:ok, create_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_user_access_logging_settings_errors()}
def create_user_access_logging_settings(%Client{} = client, input, options \\ []) do
url_path = "/userAccessLoggingSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_user_settings(map(), create_user_settings_request(), list()) ::
{:ok, create_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_user_settings_errors()}
def create_user_settings(%Client{} = client, input, options \\ []) do
url_path = "/userSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes browser settings.
"""
@spec delete_browser_settings(
map(),
String.t() | atom(),
delete_browser_settings_request(),
list()
) ::
{:ok, delete_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_browser_settings_errors()}
def delete_browser_settings(%Client{} = client, browser_settings_arn, input, options \\ []) do
url_path = "/browserSettings/#{AWS.Util.encode_multi_segment_uri(browser_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes data protection settings.
"""
@spec delete_data_protection_settings(
map(),
String.t() | atom(),
delete_data_protection_settings_request(),
list()
) ::
{:ok, delete_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_data_protection_settings_errors()}
def delete_data_protection_settings(
%Client{} = client,
data_protection_settings_arn,
input,
options \\ []
) do
url_path =
"/dataProtectionSettings/#{AWS.Util.encode_multi_segment_uri(data_protection_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the identity provider.
"""
@spec delete_identity_provider(
map(),
String.t() | atom(),
delete_identity_provider_request(),
list()
) ::
{:ok, delete_identity_provider_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_identity_provider_errors()}
def delete_identity_provider(%Client{} = client, identity_provider_arn, input, options \\ []) do
url_path = "/identityProviders/#{AWS.Util.encode_multi_segment_uri(identity_provider_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes IP access settings.
"""
@spec delete_ip_access_settings(
map(),
String.t() | atom(),
delete_ip_access_settings_request(),
list()
) ::
{:ok, delete_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_ip_access_settings_errors()}
def delete_ip_access_settings(%Client{} = client, ip_access_settings_arn, input, options \\ []) do
url_path = "/ipAccessSettings/#{AWS.Util.encode_multi_segment_uri(ip_access_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes network settings.
"""
@spec delete_network_settings(
map(),
String.t() | atom(),
delete_network_settings_request(),
list()
) ::
{:ok, delete_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_network_settings_errors()}
def delete_network_settings(%Client{} = client, network_settings_arn, input, options \\ []) do
url_path = "/networkSettings/#{AWS.Util.encode_multi_segment_uri(network_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a web portal.
"""
@spec delete_portal(map(), String.t() | atom(), delete_portal_request(), list()) ::
{:ok, delete_portal_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_portal_errors()}
def delete_portal(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a session logger resource.
"""
@spec delete_session_logger(map(), String.t() | atom(), delete_session_logger_request(), list()) ::
{:ok, delete_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_session_logger_errors()}
def delete_session_logger(%Client{} = client, session_logger_arn, input, options \\ []) do
url_path = "/sessionLoggers/#{AWS.Util.encode_multi_segment_uri(session_logger_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the trust store.
"""
@spec delete_trust_store(map(), String.t() | atom(), delete_trust_store_request(), list()) ::
{:ok, delete_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_trust_store_errors()}
def delete_trust_store(%Client{} = client, trust_store_arn, input, options \\ []) do
url_path = "/trustStores/#{AWS.Util.encode_multi_segment_uri(trust_store_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes user access logging settings.
"""
@spec delete_user_access_logging_settings(
map(),
String.t() | atom(),
delete_user_access_logging_settings_request(),
list()
) ::
{:ok, delete_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_user_access_logging_settings_errors()}
def delete_user_access_logging_settings(
%Client{} = client,
user_access_logging_settings_arn,
input,
options \\ []
) do
url_path =
"/userAccessLoggingSettings/#{AWS.Util.encode_multi_segment_uri(user_access_logging_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes user settings.
"""
@spec delete_user_settings(map(), String.t() | atom(), delete_user_settings_request(), list()) ::
{:ok, delete_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_user_settings_errors()}
def delete_user_settings(%Client{} = client, user_settings_arn, input, options \\ []) do
url_path = "/userSettings/#{AWS.Util.encode_multi_segment_uri(user_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates browser settings from a web portal.
"""
@spec disassociate_browser_settings(
map(),
String.t() | atom(),
disassociate_browser_settings_request(),
list()
) ::
{:ok, disassociate_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_browser_settings_errors()}
def disassociate_browser_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/browserSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates data protection settings from a web portal.
"""
@spec disassociate_data_protection_settings(
map(),
String.t() | atom(),
disassociate_data_protection_settings_request(),
list()
) ::
{:ok, disassociate_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_data_protection_settings_errors()}
def disassociate_data_protection_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/dataProtectionSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates IP access settings from a web portal.
"""
@spec disassociate_ip_access_settings(
map(),
String.t() | atom(),
disassociate_ip_access_settings_request(),
list()
) ::
{:ok, disassociate_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_ip_access_settings_errors()}
def disassociate_ip_access_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/ipAccessSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates network settings from a web portal.
"""
@spec disassociate_network_settings(
map(),
String.t() | atom(),
disassociate_network_settings_request(),
list()
) ::
{:ok, disassociate_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_network_settings_errors()}
def disassociate_network_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/networkSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates a session logger from a portal.
"""
@spec disassociate_session_logger(
map(),
String.t() | atom(),
disassociate_session_logger_request(),
list()
) ::
{:ok, disassociate_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_session_logger_errors()}
def disassociate_session_logger(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/sessionLogger"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates a trust store from a web portal.
"""
@spec disassociate_trust_store(
map(),
String.t() | atom(),
disassociate_trust_store_request(),
list()
) ::
{:ok, disassociate_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_trust_store_errors()}
def disassociate_trust_store(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/trustStores"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates user access logging settings from a web portal.
"""
@spec disassociate_user_access_logging_settings(
map(),
String.t() | atom(),
disassociate_user_access_logging_settings_request(),
list()
) ::
{:ok, disassociate_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_user_access_logging_settings_errors()}
def disassociate_user_access_logging_settings(
%Client{} = client,
portal_arn,
input,
options \\ []
) do
url_path =
"/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/userAccessLoggingSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates user settings from a web portal.
"""
@spec disassociate_user_settings(
map(),
String.t() | atom(),
disassociate_user_settings_request(),
list()
) ::
{:ok, disassociate_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_user_settings_errors()}
def disassociate_user_settings(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/userSettings"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Expires an active secure browser session.
"""
@spec expire_session(
map(),
String.t() | atom(),
String.t() | atom(),
expire_session_request(),
list()
) ::
{:ok, expire_session_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, expire_session_errors()}
def expire_session(%Client{} = client, portal_id, session_id, input, options \\ []) do
url_path =
"/portals/#{AWS.Util.encode_uri(portal_id)}/sessions/#{AWS.Util.encode_uri(session_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Gets browser settings.
"""
@spec get_browser_settings(map(), String.t() | atom(), list()) ::
{:ok, get_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_browser_settings_errors()}
def get_browser_settings(%Client{} = client, browser_settings_arn, options \\ []) do
url_path = "/browserSettings/#{AWS.Util.encode_multi_segment_uri(browser_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the data protection settings.
"""
@spec get_data_protection_settings(map(), String.t() | atom(), list()) ::
{:ok, get_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_data_protection_settings_errors()}
def get_data_protection_settings(
%Client{} = client,
data_protection_settings_arn,
options \\ []
) do
url_path =
"/dataProtectionSettings/#{AWS.Util.encode_multi_segment_uri(data_protection_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the identity provider.
"""
@spec get_identity_provider(map(), String.t() | atom(), list()) ::
{:ok, get_identity_provider_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_identity_provider_errors()}
def get_identity_provider(%Client{} = client, identity_provider_arn, options \\ []) do
url_path = "/identityProviders/#{AWS.Util.encode_multi_segment_uri(identity_provider_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the IP access settings.
"""
@spec get_ip_access_settings(map(), String.t() | atom(), list()) ::
{:ok, get_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_ip_access_settings_errors()}
def get_ip_access_settings(%Client{} = client, ip_access_settings_arn, options \\ []) do
url_path = "/ipAccessSettings/#{AWS.Util.encode_multi_segment_uri(ip_access_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the network settings.
"""
@spec get_network_settings(map(), String.t() | atom(), list()) ::
{:ok, get_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_network_settings_errors()}
def get_network_settings(%Client{} = client, network_settings_arn, options \\ []) do
url_path = "/networkSettings/#{AWS.Util.encode_multi_segment_uri(network_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the web portal.
"""
@spec get_portal(map(), String.t() | atom(), list()) ::
{:ok, get_portal_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_portal_errors()}
def get_portal(%Client{} = client, portal_arn, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the service provider metadata.
"""
@spec get_portal_service_provider_metadata(map(), String.t() | atom(), list()) ::
{:ok, get_portal_service_provider_metadata_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_portal_service_provider_metadata_errors()}
def get_portal_service_provider_metadata(%Client{} = client, portal_arn, options \\ []) do
url_path = "/portalIdp/#{AWS.Util.encode_multi_segment_uri(portal_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets information for a secure browser session.
"""
@spec get_session(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_session_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_session_errors()}
def get_session(%Client{} = client, portal_id, session_id, options \\ []) do
url_path =
"/portals/#{AWS.Util.encode_uri(portal_id)}/sessions/#{AWS.Util.encode_uri(session_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a specific session logger resource.
"""
@spec get_session_logger(map(), String.t() | atom(), list()) ::
{:ok, get_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_session_logger_errors()}
def get_session_logger(%Client{} = client, session_logger_arn, options \\ []) do
url_path = "/sessionLoggers/#{AWS.Util.encode_multi_segment_uri(session_logger_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the trust store.
"""
@spec get_trust_store(map(), String.t() | atom(), list()) ::
{:ok, get_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_trust_store_errors()}
def get_trust_store(%Client{} = client, trust_store_arn, options \\ []) do
url_path = "/trustStores/#{AWS.Util.encode_multi_segment_uri(trust_store_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets the trust store certificate.
"""
@spec get_trust_store_certificate(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_trust_store_certificate_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_trust_store_certificate_errors()}
def get_trust_store_certificate(%Client{} = client, trust_store_arn, thumbprint, options \\ []) do
url_path = "/trustStores/#{AWS.Util.encode_multi_segment_uri(trust_store_arn)}/certificate"
headers = []
query_params = []
query_params =
if !is_nil(thumbprint) do
[{"thumbprint", thumbprint} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets user access logging settings.
"""
@spec get_user_access_logging_settings(map(), String.t() | atom(), list()) ::
{:ok, get_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_user_access_logging_settings_errors()}
def get_user_access_logging_settings(
%Client{} = client,
user_access_logging_settings_arn,
options \\ []
) do
url_path =
"/userAccessLoggingSettings/#{AWS.Util.encode_multi_segment_uri(user_access_logging_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets user settings.
"""
@spec get_user_settings(map(), String.t() | atom(), list()) ::
{:ok, get_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_user_settings_errors()}
def get_user_settings(%Client{} = client, user_settings_arn, options \\ []) do
url_path = "/userSettings/#{AWS.Util.encode_multi_segment_uri(user_settings_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of browser settings.
"""
@spec list_browser_settings(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_browser_settings_errors()}
def list_browser_settings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/browserSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of data protection settings.
"""
@spec list_data_protection_settings(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_data_protection_settings_errors()}
def list_data_protection_settings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/dataProtectionSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of identity providers for a specific web portal.
"""
@spec list_identity_providers(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_identity_providers_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_identity_providers_errors()}
def list_identity_providers(
%Client{} = client,
portal_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}/identityProviders"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of IP access settings.
"""
@spec list_ip_access_settings(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_ip_access_settings_errors()}
def list_ip_access_settings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/ipAccessSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of network settings.
"""
@spec list_network_settings(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_network_settings_errors()}
def list_network_settings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/networkSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list or web portals.
"""
@spec list_portals(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_portals_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_portals_errors()}
def list_portals(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/portals"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all available session logger resources.
"""
@spec list_session_loggers(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_session_loggers_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_session_loggers_errors()}
def list_session_loggers(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/sessionLoggers"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists information for multiple secure browser sessions from a specific portal.
"""
@spec list_sessions(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_sessions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_sessions_errors()}
def list_sessions(
%Client{} = client,
portal_id,
max_results \\ nil,
next_token \\ nil,
session_id \\ nil,
sort_by \\ nil,
status \\ nil,
username \\ nil,
options \\ []
) do
url_path = "/portals/#{AWS.Util.encode_uri(portal_id)}/sessions"
headers = []
query_params = []
query_params =
if !is_nil(username) do
[{"username", username} | query_params]
else
query_params
end
query_params =
if !is_nil(status) do
[{"status", status} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(session_id) do
[{"sessionId", session_id} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of tags for a resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_multi_segment_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of trust store certificates.
"""
@spec list_trust_store_certificates(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_trust_store_certificates_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_trust_store_certificates_errors()}
def list_trust_store_certificates(
%Client{} = client,
trust_store_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/trustStores/#{AWS.Util.encode_multi_segment_uri(trust_store_arn)}/certificates"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of trust stores.
"""
@spec list_trust_stores(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_trust_stores_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_trust_stores_errors()}
def list_trust_stores(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/trustStores"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of user access logging settings.
"""
@spec list_user_access_logging_settings(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_user_access_logging_settings_errors()}
def list_user_access_logging_settings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/userAccessLoggingSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of user settings.
"""
@spec list_user_settings(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_user_settings_errors()}
def list_user_settings(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/userSettings"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Adds or overwrites one or more tags for the specified resource.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_multi_segment_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes one or more tags from the specified resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_multi_segment_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates browser settings.
"""
@spec update_browser_settings(
map(),
String.t() | atom(),
update_browser_settings_request(),
list()
) ::
{:ok, update_browser_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_browser_settings_errors()}
def update_browser_settings(%Client{} = client, browser_settings_arn, input, options \\ []) do
url_path = "/browserSettings/#{AWS.Util.encode_multi_segment_uri(browser_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates data protection settings.
"""
@spec update_data_protection_settings(
map(),
String.t() | atom(),
update_data_protection_settings_request(),
list()
) ::
{:ok, update_data_protection_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_data_protection_settings_errors()}
def update_data_protection_settings(
%Client{} = client,
data_protection_settings_arn,
input,
options \\ []
) do
url_path =
"/dataProtectionSettings/#{AWS.Util.encode_multi_segment_uri(data_protection_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the identity provider.
"""
@spec update_identity_provider(
map(),
String.t() | atom(),
update_identity_provider_request(),
list()
) ::
{:ok, update_identity_provider_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_identity_provider_errors()}
def update_identity_provider(%Client{} = client, identity_provider_arn, input, options \\ []) do
url_path = "/identityProviders/#{AWS.Util.encode_multi_segment_uri(identity_provider_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates IP access settings.
"""
@spec update_ip_access_settings(
map(),
String.t() | atom(),
update_ip_access_settings_request(),
list()
) ::
{:ok, update_ip_access_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_ip_access_settings_errors()}
def update_ip_access_settings(%Client{} = client, ip_access_settings_arn, input, options \\ []) do
url_path = "/ipAccessSettings/#{AWS.Util.encode_multi_segment_uri(ip_access_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates network settings.
"""
@spec update_network_settings(
map(),
String.t() | atom(),
update_network_settings_request(),
list()
) ::
{:ok, update_network_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_network_settings_errors()}
def update_network_settings(%Client{} = client, network_settings_arn, input, options \\ []) do
url_path = "/networkSettings/#{AWS.Util.encode_multi_segment_uri(network_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a web portal.
"""
@spec update_portal(map(), String.t() | atom(), update_portal_request(), list()) ::
{:ok, update_portal_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_portal_errors()}
def update_portal(%Client{} = client, portal_arn, input, options \\ []) do
url_path = "/portals/#{AWS.Util.encode_multi_segment_uri(portal_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the details of a session logger.
"""
@spec update_session_logger(map(), String.t() | atom(), update_session_logger_request(), list()) ::
{:ok, update_session_logger_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_session_logger_errors()}
def update_session_logger(%Client{} = client, session_logger_arn, input, options \\ []) do
url_path = "/sessionLoggers/#{AWS.Util.encode_multi_segment_uri(session_logger_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the trust store.
"""
@spec update_trust_store(map(), String.t() | atom(), update_trust_store_request(), list()) ::
{:ok, update_trust_store_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_trust_store_errors()}
def update_trust_store(%Client{} = client, trust_store_arn, input, options \\ []) do
url_path = "/trustStores/#{AWS.Util.encode_multi_segment_uri(trust_store_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the user access logging settings.
"""
@spec update_user_access_logging_settings(
map(),
String.t() | atom(),
update_user_access_logging_settings_request(),
list()
) ::
{:ok, update_user_access_logging_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_user_access_logging_settings_errors()}
def update_user_access_logging_settings(
%Client{} = client,
user_access_logging_settings_arn,
input,
options \\ []
) do
url_path =
"/userAccessLoggingSettings/#{AWS.Util.encode_multi_segment_uri(user_access_logging_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the user settings.
"""
@spec update_user_settings(map(), String.t() | atom(), update_user_settings_request(), list()) ::
{:ok, update_user_settings_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_user_settings_errors()}
def update_user_settings(%Client{} = client, user_settings_arn, input, options \\ []) do
url_path = "/userSettings/#{AWS.Util.encode_multi_segment_uri(user_settings_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
