# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.WorkSpacesThinClient do
@moduledoc """
Amazon WorkSpaces Thin Client is an affordable device built to work with Amazon
Web Services End User Computing (EUC) virtual desktops to provide users with a
complete cloud desktop solution.
WorkSpaces Thin Client is a compact device designed to connect up to two
monitors and USB devices like a keyboard, mouse, headset, and webcam. To
maximize endpoint security, WorkSpaces Thin Client devices do not allow local
data storage or installation of unapproved applications. The WorkSpaces Thin
Client device ships preloaded with device management software.
You can use these APIs to complete WorkSpaces Thin Client tasks, such as
creating environments or viewing devices. For more information about WorkSpaces
Thin Client, including the required permissions to use the service, see the
[Amazon WorkSpaces Thin Client Administrator Guide](https://docs.aws.amazon.com/workspaces-thin-client/latest/ag/). For more
information about using the Command Line Interface (CLI) to manage your
WorkSpaces Thin Client resources, see the [WorkSpaces Thin Client section of the CLI
Reference](https://docs.aws.amazon.com/cli/latest/reference/workspaces-thin-client/index.html).
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
update_environment_response() :: %{
"environment" => environment_summary()
}
"""
@type update_environment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_devices_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_devices_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_software_set_request() :: %{
required("validationStatus") => list(any())
}
"""
@type update_software_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_device_response() :: %{
"device" => device_summary()
}
"""
@type update_device_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
update_device_request() :: %{
optional("desiredSoftwareSetId") => String.t() | atom(),
optional("name") => String.t() | atom(),
optional("softwareSetUpdateSchedule") => list(any())
}
"""
@type update_device_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
environment_summary() :: %{
"activationCode" => String.t() | atom(),
"arn" => String.t() | atom(),
"createdAt" => non_neg_integer(),
"desiredSoftwareSetId" => String.t() | atom(),
"desktopArn" => String.t() | atom(),
"desktopEndpoint" => String.t() | atom(),
"desktopType" => list(any()),
"id" => String.t() | atom(),
"maintenanceWindow" => maintenance_window(),
"name" => String.t() | atom(),
"pendingSoftwareSetId" => String.t() | atom(),
"softwareSetUpdateMode" => list(any()),
"softwareSetUpdateSchedule" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type environment_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_environment_request() :: %{}
"""
@type get_environment_request() :: %{}
@typedoc """
## Example:
get_software_set_request() :: %{}
"""
@type get_software_set_request() :: %{}
@typedoc """
## Example:
delete_device_request() :: %{
optional("clientToken") => String.t() | atom()
}
"""
@type delete_device_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
software_set_summary() :: %{
"arn" => String.t() | atom(),
"id" => String.t() | atom(),
"releasedAt" => non_neg_integer(),
"supportedUntil" => non_neg_integer(),
"validationStatus" => list(any()),
"version" => [String.t() | atom()]
}
"""
@type software_set_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_environment_response() :: %{
"environment" => environment()
}
"""
@type get_environment_response() :: %{(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:
software_set() :: %{
"arn" => String.t() | atom(),
"id" => String.t() | atom(),
"releasedAt" => non_neg_integer(),
"software" => list(software()),
"supportedUntil" => non_neg_integer(),
"validationStatus" => list(any()),
"version" => [String.t() | atom()]
}
"""
@type software_set() :: %{(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:
get_software_set_response() :: %{
"softwareSet" => software_set()
}
"""
@type get_software_set_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
environment() :: %{
"activationCode" => String.t() | atom(),
"arn" => String.t() | atom(),
"createdAt" => non_neg_integer(),
"desiredSoftwareSetId" => String.t() | atom(),
"desktopArn" => String.t() | atom(),
"desktopEndpoint" => String.t() | atom(),
"desktopType" => list(any()),
"deviceCreationTags" => map(),
"id" => String.t() | atom(),
"kmsKeyArn" => String.t() | atom(),
"maintenanceWindow" => maintenance_window(),
"name" => String.t() | atom(),
"pendingSoftwareSetId" => String.t() | atom(),
"pendingSoftwareSetVersion" => [String.t() | atom()],
"registeredDevicesCount" => [integer()],
"softwareSetComplianceStatus" => list(any()),
"softwareSetUpdateMode" => list(any()),
"softwareSetUpdateSchedule" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type environment() :: %{(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:
list_tags_for_resource_response() :: %{
"tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_devices_response() :: %{
"devices" => list(device_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_devices_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_environments_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_environments_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_device_response() :: %{}
"""
@type deregister_device_response() :: %{}
@typedoc """
## Example:
validation_exception_field() :: %{
"message" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type validation_exception_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_software_sets_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_software_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_device_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("targetDeviceStatus") => list(any())
}
"""
@type deregister_device_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_device_request() :: %{}
"""
@type get_device_request() :: %{}
@typedoc """
## Example:
create_environment_response() :: %{
"environment" => environment_summary()
}
"""
@type create_environment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_device_response() :: %{}
"""
@type delete_device_response() :: %{}
@typedoc """
## Example:
device_summary() :: %{
"arn" => String.t() | atom(),
"createdAt" => non_neg_integer(),
"currentSoftwareSetId" => String.t() | atom(),
"desiredSoftwareSetId" => String.t() | atom(),
"environmentId" => String.t() | atom(),
"id" => String.t() | atom(),
"lastConnectedAt" => non_neg_integer(),
"lastPostureAt" => non_neg_integer(),
"lastUserId" => String.t() | atom(),
"model" => [String.t() | atom()],
"name" => String.t() | atom(),
"pendingSoftwareSetId" => String.t() | atom(),
"serialNumber" => [String.t() | atom()],
"softwareSetUpdateSchedule" => list(any()),
"status" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type device_summary() :: %{(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_environment_request() :: %{
optional("clientToken") => String.t() | atom()
}
"""
@type delete_environment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_software_sets_response() :: %{
"nextToken" => String.t() | atom(),
"softwareSets" => list(software_set_summary())
}
"""
@type list_software_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
software() :: %{
"name" => [String.t() | atom()],
"version" => [String.t() | atom()]
}
"""
@type software() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"fieldList" => list(validation_exception_field()),
"message" => String.t() | atom(),
"reason" => list(any())
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_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:
list_environments_response() :: %{
"environments" => list(environment_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_environments_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
device() :: %{
"arn" => String.t() | atom(),
"createdAt" => non_neg_integer(),
"currentSoftwareSetId" => String.t() | atom(),
"currentSoftwareSetVersion" => [String.t() | atom()],
"desiredSoftwareSetId" => String.t() | atom(),
"environmentId" => String.t() | atom(),
"id" => String.t() | atom(),
"kmsKeyArn" => String.t() | atom(),
"lastConnectedAt" => non_neg_integer(),
"lastPostureAt" => non_neg_integer(),
"lastUserId" => String.t() | atom(),
"model" => [String.t() | atom()],
"name" => String.t() | atom(),
"pendingSoftwareSetId" => String.t() | atom(),
"pendingSoftwareSetVersion" => [String.t() | atom()],
"serialNumber" => [String.t() | atom()],
"softwareSetComplianceStatus" => list(any()),
"softwareSetUpdateSchedule" => list(any()),
"softwareSetUpdateStatus" => list(any()),
"status" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type device() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_environment_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("desiredSoftwareSetId") => String.t() | atom(),
optional("desktopEndpoint") => String.t() | atom(),
optional("deviceCreationTags") => map(),
optional("kmsKeyArn") => String.t() | atom(),
optional("maintenanceWindow") => maintenance_window(),
optional("name") => String.t() | atom(),
optional("softwareSetUpdateMode") => list(any()),
optional("softwareSetUpdateSchedule") => list(any()),
optional("tags") => map(),
required("desktopArn") => String.t() | atom()
}
"""
@type create_environment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_environment_request() :: %{
optional("desiredSoftwareSetId") => String.t() | atom(),
optional("desktopArn") => String.t() | atom(),
optional("desktopEndpoint") => String.t() | atom(),
optional("deviceCreationTags") => map(),
optional("maintenanceWindow") => maintenance_window(),
optional("name") => String.t() | atom(),
optional("softwareSetUpdateMode") => list(any()),
optional("softwareSetUpdateSchedule") => list(any())
}
"""
@type update_environment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
maintenance_window() :: %{
"applyTimeOf" => list(any()),
"daysOfTheWeek" => list(list(any())()),
"endTimeHour" => integer(),
"endTimeMinute" => integer(),
"startTimeHour" => integer(),
"startTimeMinute" => integer(),
"type" => list(any())
}
"""
@type maintenance_window() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_environment_response() :: %{}
"""
@type delete_environment_response() :: %{}
@typedoc """
## Example:
update_software_set_response() :: %{}
"""
@type update_software_set_response() :: %{}
@typedoc """
## Example:
get_device_response() :: %{
"device" => device()
}
"""
@type get_device_response() :: %{(String.t() | atom()) => any()}
@type create_environment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_device_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_environment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type deregister_device_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type get_device_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_environment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_software_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_devices_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_environments_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_software_sets_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type tag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type untag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_device_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_environment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_software_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
def metadata do
%{
api_version: "2023-08-22",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "thinclient",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "WorkSpaces Thin Client",
signature_version: "v4",
signing_name: "thinclient",
target_prefix: nil
}
end
@doc """
Creates an environment for your thin client devices.
"""
@spec create_environment(map(), create_environment_request(), list()) ::
{:ok, create_environment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_environment_errors()}
def create_environment(%Client{} = client, input, options \\ []) do
url_path = "/environments"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
Deletes a thin client device.
"""
@spec delete_device(map(), String.t() | atom(), delete_device_request(), list()) ::
{:ok, delete_device_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_device_errors()}
def delete_device(%Client{} = client, id, input, options \\ []) do
url_path = "/devices/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deletes an environment.
"""
@spec delete_environment(map(), String.t() | atom(), delete_environment_request(), list()) ::
{:ok, delete_environment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_environment_errors()}
def delete_environment(%Client{} = client, id, input, options \\ []) do
url_path = "/environments/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
@doc """
Deregisters a thin client device.
"""
@spec deregister_device(map(), String.t() | atom(), deregister_device_request(), list()) ::
{:ok, deregister_device_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, deregister_device_errors()}
def deregister_device(%Client{} = client, id, input, options \\ []) do
url_path = "/deregister-device/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Returns information for a thin client device.
"""
@spec get_device(map(), String.t() | atom(), list()) ::
{:ok, get_device_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_device_errors()}
def get_device(%Client{} = client, id, options \\ []) do
url_path = "/devices/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns information for an environment.
"""
@spec get_environment(map(), String.t() | atom(), list()) ::
{:ok, get_environment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_environment_errors()}
def get_environment(%Client{} = client, id, options \\ []) do
url_path = "/environments/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns information for a software set.
"""
@spec get_software_set(map(), String.t() | atom(), list()) ::
{:ok, get_software_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_software_set_errors()}
def get_software_set(%Client{} = client, id, options \\ []) do
url_path = "/softwaresets/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of thin client devices.
"""
@spec list_devices(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_devices_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_devices_errors()}
def list_devices(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/devices"
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() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of environments.
"""
@spec list_environments(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_environments_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_environments_errors()}
def list_environments(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/environments"
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() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of software sets.
"""
@spec list_software_sets(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_software_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_software_sets_errors()}
def list_software_sets(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/softwaresets"
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() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns 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_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Assigns one or more tags (key-value pairs) to 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_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a tag or tags from a 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_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a thin client device.
"""
@spec update_device(map(), String.t() | atom(), update_device_request(), list()) ::
{:ok, update_device_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_device_errors()}
def update_device(%Client{} = client, id, input, options \\ []) do
url_path = "/devices/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an environment.
"""
@spec update_environment(map(), String.t() | atom(), update_environment_request(), list()) ::
{:ok, update_environment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_environment_errors()}
def update_environment(%Client{} = client, id, input, options \\ []) do
url_path = "/environments/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a software set.
"""
@spec update_software_set(map(), String.t() | atom(), update_software_set_request(), list()) ::
{:ok, update_software_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_software_set_errors()}
def update_software_set(%Client{} = client, id, input, options \\ []) do
url_path = "/softwaresets/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "api.")
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
204
)
end
end
