Current section
Files
Jump to
Current section
Files
src/aws_support_app.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc Amazon Web Services Support App in Slack
%%
%% You can use the Amazon Web Services Support App in Slack API to manage
%% your support cases in Slack for your
%% Amazon Web Services account.
%%
%% After you configure your Slack workspace and channel with the Amazon Web
%% Services Support App, you can
%% perform the following tasks directly in your Slack channel:
%%
%% Create, search, update, and resolve your support cases
%%
%% Request service quota increases for your account
%%
%% Invite Amazon Web Services Support agents to your channel so that you can
%% chat directly about your
%% support cases
%%
%% For more information about how to perform these actions in Slack, see the
%% following
%% documentation in the Amazon Web Services Support User Guide:
%%
%% Amazon Web Services Support App in Slack:
%% https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html
%%
%% Joining a live chat session with Amazon Web Services Support:
%% https://docs.aws.amazon.com/awssupport/latest/user/joining-a-live-chat-session.html
%%
%% Requesting service quota increases:
%% https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html
%%
%% Amazon Web Services Support App commands in Slack:
%% https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html
%%
%% You can also use the Amazon Web Services Management Console instead of the
%% Amazon Web Services Support App API to manage your Slack
%% configurations. For more information, see Authorize a
%% Slack workspace to enable the Amazon Web Services Support App:
%% https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html.
%%
%% You must have a Business or Enterprise Support plan to use the Amazon Web
%% Services Support App API.
%%
%% For more information about the Amazon Web Services Support App endpoints,
%% see the Amazon Web Services Support App in Slack endpoints:
%% https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region
%% in the Amazon Web Services General
%% Reference.
-module(aws_support_app).
-export([create_slack_channel_configuration/2,
create_slack_channel_configuration/3,
delete_account_alias/2,
delete_account_alias/3,
delete_slack_channel_configuration/2,
delete_slack_channel_configuration/3,
delete_slack_workspace_configuration/2,
delete_slack_workspace_configuration/3,
get_account_alias/2,
get_account_alias/3,
list_slack_channel_configurations/2,
list_slack_channel_configurations/3,
list_slack_workspace_configurations/2,
list_slack_workspace_configurations/3,
put_account_alias/2,
put_account_alias/3,
register_slack_workspace_for_organization/2,
register_slack_workspace_for_organization/3,
update_slack_channel_configuration/2,
update_slack_channel_configuration/3]).
-include_lib("hackney/include/hackney_lib.hrl").
%% Example:
%% access_denied_exception() :: #{
%% <<"message">> => string()
%% }
-type access_denied_exception() :: #{binary() => any()}.
%% Example:
%% conflict_exception() :: #{
%% <<"message">> => string()
%% }
-type conflict_exception() :: #{binary() => any()}.
%% Example:
%% create_slack_channel_configuration_request() :: #{
%% <<"channelId">> := string(),
%% <<"channelName">> => string(),
%% <<"channelRoleArn">> := string(),
%% <<"notifyOnAddCorrespondenceToCase">> => boolean(),
%% <<"notifyOnCaseSeverity">> := string(),
%% <<"notifyOnCreateOrReopenCase">> => boolean(),
%% <<"notifyOnResolveCase">> => boolean(),
%% <<"teamId">> := string()
%% }
-type create_slack_channel_configuration_request() :: #{binary() => any()}.
%% Example:
%% create_slack_channel_configuration_result() :: #{}
-type create_slack_channel_configuration_result() :: #{}.
%% Example:
%% delete_account_alias_request() :: #{}
-type delete_account_alias_request() :: #{}.
%% Example:
%% delete_account_alias_result() :: #{}
-type delete_account_alias_result() :: #{}.
%% Example:
%% delete_slack_channel_configuration_request() :: #{
%% <<"channelId">> := string(),
%% <<"teamId">> := string()
%% }
-type delete_slack_channel_configuration_request() :: #{binary() => any()}.
%% Example:
%% delete_slack_channel_configuration_result() :: #{}
-type delete_slack_channel_configuration_result() :: #{}.
%% Example:
%% delete_slack_workspace_configuration_request() :: #{
%% <<"teamId">> := string()
%% }
-type delete_slack_workspace_configuration_request() :: #{binary() => any()}.
%% Example:
%% delete_slack_workspace_configuration_result() :: #{}
-type delete_slack_workspace_configuration_result() :: #{}.
%% Example:
%% get_account_alias_request() :: #{}
-type get_account_alias_request() :: #{}.
%% Example:
%% get_account_alias_result() :: #{
%% <<"accountAlias">> => string()
%% }
-type get_account_alias_result() :: #{binary() => any()}.
%% Example:
%% internal_server_exception() :: #{
%% <<"message">> => string()
%% }
-type internal_server_exception() :: #{binary() => any()}.
%% Example:
%% list_slack_channel_configurations_request() :: #{
%% <<"nextToken">> => string()
%% }
-type list_slack_channel_configurations_request() :: #{binary() => any()}.
%% Example:
%% list_slack_channel_configurations_result() :: #{
%% <<"nextToken">> => string(),
%% <<"slackChannelConfigurations">> := list(slack_channel_configuration())
%% }
-type list_slack_channel_configurations_result() :: #{binary() => any()}.
%% Example:
%% list_slack_workspace_configurations_request() :: #{
%% <<"nextToken">> => string()
%% }
-type list_slack_workspace_configurations_request() :: #{binary() => any()}.
%% Example:
%% list_slack_workspace_configurations_result() :: #{
%% <<"nextToken">> => string(),
%% <<"slackWorkspaceConfigurations">> => list(slack_workspace_configuration())
%% }
-type list_slack_workspace_configurations_result() :: #{binary() => any()}.
%% Example:
%% put_account_alias_request() :: #{
%% <<"accountAlias">> := string()
%% }
-type put_account_alias_request() :: #{binary() => any()}.
%% Example:
%% put_account_alias_result() :: #{}
-type put_account_alias_result() :: #{}.
%% Example:
%% register_slack_workspace_for_organization_request() :: #{
%% <<"teamId">> := string()
%% }
-type register_slack_workspace_for_organization_request() :: #{binary() => any()}.
%% Example:
%% register_slack_workspace_for_organization_result() :: #{
%% <<"accountType">> => string(),
%% <<"teamId">> => string(),
%% <<"teamName">> => string()
%% }
-type register_slack_workspace_for_organization_result() :: #{binary() => any()}.
%% Example:
%% resource_not_found_exception() :: #{
%% <<"message">> => string()
%% }
-type resource_not_found_exception() :: #{binary() => any()}.
%% Example:
%% service_quota_exceeded_exception() :: #{
%% <<"message">> => string()
%% }
-type service_quota_exceeded_exception() :: #{binary() => any()}.
%% Example:
%% slack_channel_configuration() :: #{
%% <<"channelId">> => string(),
%% <<"channelName">> => string(),
%% <<"channelRoleArn">> => string(),
%% <<"notifyOnAddCorrespondenceToCase">> => boolean(),
%% <<"notifyOnCaseSeverity">> => string(),
%% <<"notifyOnCreateOrReopenCase">> => boolean(),
%% <<"notifyOnResolveCase">> => boolean(),
%% <<"teamId">> => string()
%% }
-type slack_channel_configuration() :: #{binary() => any()}.
%% Example:
%% slack_workspace_configuration() :: #{
%% <<"allowOrganizationMemberAccount">> => boolean(),
%% <<"teamId">> => string(),
%% <<"teamName">> => string()
%% }
-type slack_workspace_configuration() :: #{binary() => any()}.
%% Example:
%% update_slack_channel_configuration_request() :: #{
%% <<"channelId">> := string(),
%% <<"channelName">> => string(),
%% <<"channelRoleArn">> => string(),
%% <<"notifyOnAddCorrespondenceToCase">> => boolean(),
%% <<"notifyOnCaseSeverity">> => string(),
%% <<"notifyOnCreateOrReopenCase">> => boolean(),
%% <<"notifyOnResolveCase">> => boolean(),
%% <<"teamId">> := string()
%% }
-type update_slack_channel_configuration_request() :: #{binary() => any()}.
%% Example:
%% update_slack_channel_configuration_result() :: #{
%% <<"channelId">> => string(),
%% <<"channelName">> => string(),
%% <<"channelRoleArn">> => string(),
%% <<"notifyOnAddCorrespondenceToCase">> => boolean(),
%% <<"notifyOnCaseSeverity">> => string(),
%% <<"notifyOnCreateOrReopenCase">> => boolean(),
%% <<"notifyOnResolveCase">> => boolean(),
%% <<"teamId">> => string()
%% }
-type update_slack_channel_configuration_result() :: #{binary() => any()}.
%% Example:
%% validation_exception() :: #{
%% <<"message">> => string()
%% }
-type validation_exception() :: #{binary() => any()}.
-type create_slack_channel_configuration_errors() ::
validation_exception() |
service_quota_exceeded_exception() |
internal_server_exception() |
conflict_exception() |
access_denied_exception().
-type delete_account_alias_errors() ::
resource_not_found_exception() |
internal_server_exception() |
access_denied_exception().
-type delete_slack_channel_configuration_errors() ::
validation_exception() |
resource_not_found_exception() |
internal_server_exception() |
conflict_exception() |
access_denied_exception().
-type delete_slack_workspace_configuration_errors() ::
validation_exception() |
resource_not_found_exception() |
internal_server_exception() |
conflict_exception() |
access_denied_exception().
-type get_account_alias_errors() ::
internal_server_exception().
-type list_slack_channel_configurations_errors() ::
internal_server_exception() |
access_denied_exception().
-type list_slack_workspace_configurations_errors() ::
internal_server_exception() |
access_denied_exception().
-type put_account_alias_errors() ::
validation_exception() |
internal_server_exception() |
access_denied_exception().
-type register_slack_workspace_for_organization_errors() ::
validation_exception() |
resource_not_found_exception() |
internal_server_exception() |
conflict_exception() |
access_denied_exception().
-type update_slack_channel_configuration_errors() ::
validation_exception() |
resource_not_found_exception() |
internal_server_exception() |
conflict_exception() |
access_denied_exception().
%%====================================================================
%% API
%%====================================================================
%% @doc Creates a Slack channel configuration for your Amazon Web Services
%% account.
%%
%% You can add up to 5 Slack workspaces for your account.
%%
%% You can add up to 20 Slack channels for your account.
%%
%% A Slack channel can have up to 100 Amazon Web Services accounts. This
%% means that only 100 accounts can
%% add the same Slack channel to the Amazon Web Services Support App. We
%% recommend that you only add the accounts that
%% you need to manage support cases for your organization. This can reduce
%% the notifications
%% about case updates that you receive in the Slack channel.
%%
%% We recommend that you choose a private Slack channel so that only members
%% in that
%% channel have read and write access to your support cases. Anyone in your
%% Slack channel can
%% create, update, or resolve support cases for your account. Users require
%% an invitation to
%% join private channels.
-spec create_slack_channel_configuration(aws_client:aws_client(), create_slack_channel_configuration_request()) ->
{ok, create_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, create_slack_channel_configuration_errors(), tuple()}.
create_slack_channel_configuration(Client, Input) ->
create_slack_channel_configuration(Client, Input, []).
-spec create_slack_channel_configuration(aws_client:aws_client(), create_slack_channel_configuration_request(), proplists:proplist()) ->
{ok, create_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, create_slack_channel_configuration_errors(), tuple()}.
create_slack_channel_configuration(Client, Input0, Options0) ->
Method = post,
Path = ["/control/create-slack-channel-configuration"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Deletes an alias for an Amazon Web Services account ID.
%%
%% The alias appears in the Amazon Web Services Support App page of the
%% Amazon Web Services Support Center. The alias also appears in Slack
%% messages from the Amazon Web Services Support App.
-spec delete_account_alias(aws_client:aws_client(), delete_account_alias_request()) ->
{ok, delete_account_alias_result(), tuple()} |
{error, any()} |
{error, delete_account_alias_errors(), tuple()}.
delete_account_alias(Client, Input) ->
delete_account_alias(Client, Input, []).
-spec delete_account_alias(aws_client:aws_client(), delete_account_alias_request(), proplists:proplist()) ->
{ok, delete_account_alias_result(), tuple()} |
{error, any()} |
{error, delete_account_alias_errors(), tuple()}.
delete_account_alias(Client, Input0, Options0) ->
Method = post,
Path = ["/control/delete-account-alias"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Deletes a Slack channel configuration from your Amazon Web Services
%% account.
%%
%% This operation doesn't
%% delete your Slack channel.
-spec delete_slack_channel_configuration(aws_client:aws_client(), delete_slack_channel_configuration_request()) ->
{ok, delete_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, delete_slack_channel_configuration_errors(), tuple()}.
delete_slack_channel_configuration(Client, Input) ->
delete_slack_channel_configuration(Client, Input, []).
-spec delete_slack_channel_configuration(aws_client:aws_client(), delete_slack_channel_configuration_request(), proplists:proplist()) ->
{ok, delete_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, delete_slack_channel_configuration_errors(), tuple()}.
delete_slack_channel_configuration(Client, Input0, Options0) ->
Method = post,
Path = ["/control/delete-slack-channel-configuration"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Deletes a Slack workspace configuration from your Amazon Web Services
%% account.
%%
%% This operation doesn't
%% delete your Slack workspace.
-spec delete_slack_workspace_configuration(aws_client:aws_client(), delete_slack_workspace_configuration_request()) ->
{ok, delete_slack_workspace_configuration_result(), tuple()} |
{error, any()} |
{error, delete_slack_workspace_configuration_errors(), tuple()}.
delete_slack_workspace_configuration(Client, Input) ->
delete_slack_workspace_configuration(Client, Input, []).
-spec delete_slack_workspace_configuration(aws_client:aws_client(), delete_slack_workspace_configuration_request(), proplists:proplist()) ->
{ok, delete_slack_workspace_configuration_result(), tuple()} |
{error, any()} |
{error, delete_slack_workspace_configuration_errors(), tuple()}.
delete_slack_workspace_configuration(Client, Input0, Options0) ->
Method = post,
Path = ["/control/delete-slack-workspace-configuration"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Retrieves the alias from an Amazon Web Services account ID.
%%
%% The alias appears in the Amazon Web Services Support App page of
%% the Amazon Web Services Support Center. The alias also appears in Slack
%% messages from the Amazon Web Services Support App.
-spec get_account_alias(aws_client:aws_client(), get_account_alias_request()) ->
{ok, get_account_alias_result(), tuple()} |
{error, any()} |
{error, get_account_alias_errors(), tuple()}.
get_account_alias(Client, Input) ->
get_account_alias(Client, Input, []).
-spec get_account_alias(aws_client:aws_client(), get_account_alias_request(), proplists:proplist()) ->
{ok, get_account_alias_result(), tuple()} |
{error, any()} |
{error, get_account_alias_errors(), tuple()}.
get_account_alias(Client, Input0, Options0) ->
Method = post,
Path = ["/control/get-account-alias"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Lists the Slack channel configurations for an Amazon Web Services
%% account.
-spec list_slack_channel_configurations(aws_client:aws_client(), list_slack_channel_configurations_request()) ->
{ok, list_slack_channel_configurations_result(), tuple()} |
{error, any()} |
{error, list_slack_channel_configurations_errors(), tuple()}.
list_slack_channel_configurations(Client, Input) ->
list_slack_channel_configurations(Client, Input, []).
-spec list_slack_channel_configurations(aws_client:aws_client(), list_slack_channel_configurations_request(), proplists:proplist()) ->
{ok, list_slack_channel_configurations_result(), tuple()} |
{error, any()} |
{error, list_slack_channel_configurations_errors(), tuple()}.
list_slack_channel_configurations(Client, Input0, Options0) ->
Method = post,
Path = ["/control/list-slack-channel-configurations"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Lists the Slack workspace configurations for an Amazon Web Services
%% account.
-spec list_slack_workspace_configurations(aws_client:aws_client(), list_slack_workspace_configurations_request()) ->
{ok, list_slack_workspace_configurations_result(), tuple()} |
{error, any()} |
{error, list_slack_workspace_configurations_errors(), tuple()}.
list_slack_workspace_configurations(Client, Input) ->
list_slack_workspace_configurations(Client, Input, []).
-spec list_slack_workspace_configurations(aws_client:aws_client(), list_slack_workspace_configurations_request(), proplists:proplist()) ->
{ok, list_slack_workspace_configurations_result(), tuple()} |
{error, any()} |
{error, list_slack_workspace_configurations_errors(), tuple()}.
list_slack_workspace_configurations(Client, Input0, Options0) ->
Method = post,
Path = ["/control/list-slack-workspace-configurations"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Creates or updates an individual alias for each Amazon Web Services
%% account ID.
%%
%% The alias appears in the
%% Amazon Web Services Support App page of the Amazon Web Services Support
%% Center. The alias also appears in Slack messages from the
%% Amazon Web Services Support App.
-spec put_account_alias(aws_client:aws_client(), put_account_alias_request()) ->
{ok, put_account_alias_result(), tuple()} |
{error, any()} |
{error, put_account_alias_errors(), tuple()}.
put_account_alias(Client, Input) ->
put_account_alias(Client, Input, []).
-spec put_account_alias(aws_client:aws_client(), put_account_alias_request(), proplists:proplist()) ->
{ok, put_account_alias_result(), tuple()} |
{error, any()} |
{error, put_account_alias_errors(), tuple()}.
put_account_alias(Client, Input0, Options0) ->
Method = post,
Path = ["/control/put-account-alias"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Registers a Slack workspace for your Amazon Web Services account.
%%
%% To call this API, your account must be
%% part of an organization in Organizations.
%%
%% If you're the management account and you want to register Slack
%% workspaces for your organization, you must complete the following tasks:
%%
%% Sign in to the Amazon Web Services Support Center:
%% https://console.aws.amazon.com/support/app and
%% authorize the Slack workspaces where you want your organization to have
%% access to. See
%% Authorize a Slack workspace:
%% https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html
%% in the Amazon Web Services Support User
%% Guide.
%%
%% Call the `RegisterSlackWorkspaceForOrganization' API to authorize each
%% Slack workspace for the organization.
%%
%% After the management account authorizes the Slack workspace, member
%% accounts can call this
%% API to authorize the same Slack workspace for their individual accounts.
%% Member accounts don't
%% need to authorize the Slack workspace manually through the Amazon Web
%% Services Support Center: https://console.aws.amazon.com/support/app.
%%
%% To use the Amazon Web Services Support App, each account must then
%% complete the following tasks:
%%
%% Create an Identity and Access Management (IAM) role with the required
%% permission. For more information,
%% see Managing access to the Amazon Web Services Support App:
%% https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html.
%%
%% Configure a Slack channel to use the Amazon Web Services Support App for
%% support cases for that account. For
%% more information, see Configuring a Slack channel:
%% https://docs.aws.amazon.com/awssupport/latest/user/add-your-slack-channel.html.
-spec register_slack_workspace_for_organization(aws_client:aws_client(), register_slack_workspace_for_organization_request()) ->
{ok, register_slack_workspace_for_organization_result(), tuple()} |
{error, any()} |
{error, register_slack_workspace_for_organization_errors(), tuple()}.
register_slack_workspace_for_organization(Client, Input) ->
register_slack_workspace_for_organization(Client, Input, []).
-spec register_slack_workspace_for_organization(aws_client:aws_client(), register_slack_workspace_for_organization_request(), proplists:proplist()) ->
{ok, register_slack_workspace_for_organization_result(), tuple()} |
{error, any()} |
{error, register_slack_workspace_for_organization_errors(), tuple()}.
register_slack_workspace_for_organization(Client, Input0, Options0) ->
Method = post,
Path = ["/control/register-slack-workspace-for-organization"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%% @doc Updates the configuration for a Slack channel, such as case update
%% notifications.
-spec update_slack_channel_configuration(aws_client:aws_client(), update_slack_channel_configuration_request()) ->
{ok, update_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, update_slack_channel_configuration_errors(), tuple()}.
update_slack_channel_configuration(Client, Input) ->
update_slack_channel_configuration(Client, Input, []).
-spec update_slack_channel_configuration(aws_client:aws_client(), update_slack_channel_configuration_request(), proplists:proplist()) ->
{ok, update_slack_channel_configuration_result(), tuple()} |
{error, any()} |
{error, update_slack_channel_configuration_errors(), tuple()}.
update_slack_channel_configuration(Client, Input0, Options0) ->
Method = post,
Path = ["/control/update-slack-channel-configuration"],
SuccessStatusCode = 200,
{SendBodyAsBinary, Options1} = proplists_take(send_body_as_binary, Options0, false),
{ReceiveBodyAsBinary, Options2} = proplists_take(receive_body_as_binary, Options1, false),
Options = [{send_body_as_binary, SendBodyAsBinary},
{receive_body_as_binary, ReceiveBodyAsBinary},
{append_sha256_content_hash, false}
| Options2],
Headers = [],
Input1 = Input0,
CustomHeaders = [],
Input2 = Input1,
Query_ = [],
Input = Input2,
request(Client, Method, Path, Query_, CustomHeaders ++ Headers, Input, Options, SuccessStatusCode).
%%====================================================================
%% Internal functions
%%====================================================================
-spec proplists_take(any(), proplists:proplist(), any()) -> {any(), proplists:proplist()}.
proplists_take(Key, Proplist, Default) ->
Value = proplists:get_value(Key, Proplist, Default),
{Value, proplists:delete(Key, Proplist)}.
-spec request(aws_client:aws_client(), atom(), iolist(), list(),
list(), map() | undefined, list(), pos_integer() | undefined) ->
{ok, {integer(), list()}} |
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map(),
Error :: map().
request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
RequestFun = fun() -> do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) end,
aws_request:request(RequestFun, Options).
do_request(Client, Method, Path, Query, Headers0, Input, Options, SuccessStatusCode) ->
Client1 = Client#{service => <<"supportapp">>},
DefaultHost = build_host(<<"supportapp">>, Client1),
URL0 = build_url(DefaultHost, Path, Client1),
PathBin = erlang:iolist_to_binary(Path),
{URL1, Host} = aws_util:apply_endpoint_url_override(URL0, DefaultHost, PathBin, <<"AWS_ENDPOINT_URL_SUPPORT_APP">>),
URL = aws_request:add_query(URL1, Query),
AdditionalHeaders1 = [ {<<"Host">>, Host}
, {<<"Content-Type">>, <<"application/x-amz-json-1.1">>}
],
Payload =
case proplists:get_value(send_body_as_binary, Options) of
true ->
maps:get(<<"Body">>, Input, <<"">>);
false ->
encode_payload(Input)
end,
AdditionalHeaders = case proplists:get_value(append_sha256_content_hash, Options, false) of
true ->
add_checksum_hash_header(AdditionalHeaders1, Payload);
false ->
AdditionalHeaders1
end,
Headers1 = aws_request:add_headers(AdditionalHeaders, Headers0),
MethodBin = aws_request:method_to_binary(Method),
SignedHeaders = aws_request:sign_request(Client1, MethodBin, URL, Headers1, Payload),
Response = hackney:request(Method, URL, SignedHeaders, Payload, Options),
DecodeBody = not proplists:get_value(receive_body_as_binary, Options),
handle_response(Response, SuccessStatusCode, DecodeBody).
add_checksum_hash_header(Headers, Body) ->
[ {<<"X-Amz-CheckSum-SHA256">>, base64:encode(crypto:hash(sha256, Body))}
| Headers
].
handle_response({ok, StatusCode, ResponseHeaders}, SuccessStatusCode, _DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
{ok, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders}, _, _DecodeBody) ->
{error, {StatusCode, ResponseHeaders}};
handle_response({ok, StatusCode, ResponseHeaders, Client}, SuccessStatusCode, DecodeBody)
when StatusCode =:= 200;
StatusCode =:= 202;
StatusCode =:= 204;
StatusCode =:= 206;
StatusCode =:= SuccessStatusCode ->
case hackney:body(Client) of
{ok, <<>>} when StatusCode =:= 200;
StatusCode =:= SuccessStatusCode ->
{ok, #{}, {StatusCode, ResponseHeaders, Client}};
{ok, Body} ->
Result = case DecodeBody of
true ->
try
jsx:decode(Body)
catch
Error:Reason:Stack ->
erlang:raise(error, {body_decode_failed, Error, Reason, StatusCode, Body}, Stack)
end;
false -> #{<<"Body">> => Body}
end,
{ok, Result, {StatusCode, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, _ResponseHeaders, _Client}, _, _DecodeBody)
when StatusCode =:= 503 ->
%% Retriable error if retries are enabled
{error, service_unavailable};
handle_response({ok, StatusCode, ResponseHeaders, Client}, _, _DecodeBody) ->
{ok, Body} = hackney:body(Client),
try
DecodedError = jsx:decode(Body),
{error, DecodedError, {StatusCode, ResponseHeaders, Client}}
catch
Error:Reason:Stack ->
erlang:raise(error, {body_decode_failed, Error, Reason, StatusCode, Body}, Stack)
end;
handle_response({error, Reason}, _, _DecodeBody) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Path0, Client) ->
Proto = aws_client:proto(Client),
Path = erlang:iolist_to_binary(Path0),
Port = aws_client:port(Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, Path], <<"">>).
-spec encode_payload(undefined | map()) -> binary().
encode_payload(undefined) ->
<<>>;
encode_payload(Input) ->
jsx:encode(Input).