| Overview |  |
An Erlang interface to AWS Workspaces.
Output is in the form of {ok, Value} or {error, Reason}. The
format of Value is controlled by the out option, which defaults
to json. The possible values are:
* json - The output from Workspaces as processed by jsx:decode
but with no further manipulation.
* record - A record containing all the information from the
Workspaces response except field types.
{error, {ErrorCode, Message}}
where ErrorCode and 'Message' are both binary
strings.
describe_tags_opt() = {resource_id, string_param()} | out_opt()
describe_tags_opts() = [describe_tags_opt()]
describe_workspace_directories_opt() = {directory_ids, [string_param()]} | {limit, pos_integer()} | {next_token, string_param()} | out_opt()
describe_workspace_directories_opts() = [describe_workspace_directories_opt()]
describe_workspaces_opt() = {bundle_id, string_param()} | {directory_id, string_param()} | {limit, pos_integer()} | {next_token, string_param()} | {user_name, string_param()} | {workspace_ids, [string_param()]} | out_opt()
describe_workspaces_opts() = [describe_workspaces_opt()]
out_opt() = {out, out_type()}
out_type() = json | record
string_param() = binary() | string()
workspaces_return(Record) = {ok, jsx:json_term() | Record} | {error, term()}
configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok
configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok
configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok
describe_tags(Opts::describe_tags_opts()) -> workspaces_return([#workspaces_tag{}])
describe_tags(Opts::describe_tags_opts(), Config::aws_config()) -> workspaces_return([#workspaces_tag{}])
Workspaces API
https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeTags.html
Describe tags for workspace id "ws-c8wvb67py"
{ok, Tags} = erlcloud_workspaces:describe_tags([{resource_id, "ws-c8wvb67py"}, {out, json}])
describe_workspace_directories() -> workspaces_return(#describe_workspace_directories{})
describe_workspace_directories(Aws_config::describe_workspace_directories_opts() | aws_config()) -> workspaces_return(#describe_workspace_directories{})
describe_workspace_directories(Opts::describe_workspace_directories_opts(), Config::aws_config()) -> workspaces_return(#describe_workspace_directories{})
Workspaces API
https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html
Describe workspaces directory "TestDirectory"
{ok, Clusters} = erlcloud_workspaces:describe_workspace_directories([{directory_ids, ["TestDirectory"]}, {out, json}])
describe_workspaces() -> workspaces_return(#describe_workspaces{})
describe_workspaces(Aws_config::describe_workspaces_opts() | aws_config()) -> workspaces_return(#describe_workspaces{})
describe_workspaces(Opts::describe_workspaces_opts(), Config::aws_config()) -> workspaces_return(#describe_workspaces{})
Workspaces API
https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
Describe workspaces in Directory "TestDirectory"
{ok, Clusters} = erlcloud_workspaces:describe_workspaces([{directory_id, "TestDirectory"}, {out, json}])
new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()
Generated by EDoc