aws_erlang

%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.

%% @doc AppConfig Data provides the data plane APIs your application uses to
%% retrieve
%% configuration data.
%%
%% Here's how it works:
%%
%% Your application retrieves configuration data by first establishing a
%% configuration
%% session using the AppConfig Data `StartConfigurationSession' API
%% action.
%% Your session's client then makes periodic calls to
%% `GetLatestConfiguration'
%% to check for and retrieve the latest data available.
%%
%% When calling `StartConfigurationSession', your code sends the
%% following
%% information:
%%
%% Identifiers (ID or name) of an AppConfig application, environment, and
%% configuration profile that the session tracks.
%%
%% (Optional) The minimum amount of time the session's client must wait
%% between calls
%% to `GetLatestConfiguration'.
%%
%% In response, AppConfig provides an `InitialConfigurationToken' to be
%% given to
%% the session's client and used the first time it calls
%% `GetLatestConfiguration'
%% for that session.
%%
%% This token should only be used once in your first call to
%% `GetLatestConfiguration'. You must use the new token
%% in the `GetLatestConfiguration' response
%% (`NextPollConfigurationToken') in each subsequent call to
%% `GetLatestConfiguration'.
%%
%% When calling `GetLatestConfiguration', your client code sends the most
%% recent
%% `ConfigurationToken' value it has and receives in response:
%%
%% `NextPollConfigurationToken': the `ConfigurationToken' value
%% to use on the next call to `GetLatestConfiguration'.
%%
%% `NextPollIntervalInSeconds': the duration the client should wait
%% before
%% making its next call to `GetLatestConfiguration'. This duration may
%% vary
%% over the course of the session, so it should be used instead of the value
%% sent on the
%% `StartConfigurationSession' call.
%%
%% The configuration: the latest data intended for the session. This may be
%% empty if
%% the client already has the latest version of the configuration.
%%
%% The `InitialConfigurationToken' and
%% `NextPollConfigurationToken' should only be used once. To support long
%% poll
%% use cases, the tokens are valid for up to 24 hours. If a
%% `GetLatestConfiguration' call uses an expired token, the system
%% returns
%% `BadRequestException'.
%%
%% For more information and to view example CLI commands that show how to
%% retrieve a
%% configuration using the AppConfig Data `StartConfigurationSession' and
%% `GetLatestConfiguration' API actions, see Retrieving the
%% configuration:
%% http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
%% in the AppConfig User Guide.
-module(aws_appconfigdata).

-export([get_latest_configuration/2,
         get_latest_configuration/4,
         get_latest_configuration/5,
         start_configuration_session/2,
         start_configuration_session/3]).

-include_lib("hackney/include/hackney_lib.hrl").



%% Example:
%% bad_request_exception() :: #{
%%   <<"Details">> => list(),
%%   <<"Message">> => string(),
%%   <<"Reason">> => string()
%% }
-type bad_request_exception() :: #{binary() => any()}.


%% Example:
%% get_latest_configuration_request() :: #{
%%   <<"ConfigurationToken">> := string()
%% }
-type get_latest_configuration_request() :: #{binary() => any()}.


%% Example:
%% get_latest_configuration_response() :: #{
%%   <<"Configuration">> => binary(),
%%   <<"ContentType">> => string(),
%%   <<"NextPollConfigurationToken">> => string(),
%%   <<"NextPollIntervalInSeconds">> => integer(),
%%   <<"VersionLabel">> => string()
%% }
-type get_latest_configuration_response() :: #{binary() => any()}.


%% Example:
%% internal_server_exception() :: #{
%%   <<"Message">> => string()
%% }
-type internal_server_exception() :: #{binary() => any()}.


%% Example:
%% invalid_parameter_detail() :: #{
%%   <<"Problem">> => string()
%% }
-type invalid_parameter_detail() :: #{binary() => any()}.


%% Example:
%% resource_not_found_exception() :: #{
%%   <<"Message">> => string(),
%%   <<"ReferencedBy">> => map(),
%%   <<"ResourceType">> => string()
%% }
-type resource_not_found_exception() :: #{binary() => any()}.


%% Example:
%% start_configuration_session_request() :: #{
%%   <<"ApplicationIdentifier">> := string(),
%%   <<"ConfigurationProfileIdentifier">> := string(),
%%   <<"EnvironmentIdentifier">> := string(),
%%   <<"RequiredMinimumPollIntervalInSeconds">> => integer()
%% }
-type start_configuration_session_request() :: #{binary() => any()}.


%% Example:
%% start_configuration_session_response() :: #{
%%   <<"InitialConfigurationToken">> => string()
%% }
-type start_configuration_session_response() :: #{binary() => any()}.


%% Example:
%% throttling_exception() :: #{
%%   <<"Message">> => string()
%% }
-type throttling_exception() :: #{binary() => any()}.

-type get_latest_configuration_errors() ::
    throttling_exception() | 
    resource_not_found_exception() | 
    internal_server_exception() | 
    bad_request_exception().

-type start_configuration_session_errors() ::
    throttling_exception() | 
    resource_not_found_exception() | 
    internal_server_exception() | 
    bad_request_exception().

%%====================================================================
%% API
%%====================================================================

%% @doc Retrieves the latest deployed configuration.
%%
%% This API may return empty configuration
%% data if the client already has the latest version. For more information
%% about this API
%% action and to view example CLI commands that show how to use it with the
%% `StartConfigurationSession' API action, see Retrieving the
%% configuration:
%% http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
%% in the AppConfig User Guide.
%%
%% Note the following important information.
%%
%% Each configuration token is only valid for one call to
%% `GetLatestConfiguration'. The `GetLatestConfiguration'
%% response includes a `NextPollConfigurationToken' that should always
%% replace the token used for the just-completed call in preparation for the
%% next
%% one.
%%
%% `GetLatestConfiguration' is a priced call. For more information, see
%% Pricing: https://aws.amazon.com/systems-manager/pricing/.
-spec get_latest_configuration(aws_client:aws_client(), binary() | list()) ->
    {ok, get_latest_configuration_response(), tuple()} |
    {error, any()} |
    {error, get_latest_configuration_errors(), tuple()}.
get_latest_configuration(Client, ConfigurationToken)
  when is_map(Client) ->
    get_latest_configuration(Client, ConfigurationToken, #{}, #{}).

-spec get_latest_configuration(aws_client:aws_client(), binary() | list(), map(), map()) ->
    {ok, get_latest_configuration_response(), tuple()} |
    {error, any()} |
    {error, get_latest_configuration_errors(), tuple()}.
get_latest_configuration(Client, ConfigurationToken, QueryMap, HeadersMap)
  when is_map(Client), is_map(QueryMap), is_map(HeadersMap) ->
    get_latest_configuration(Client, ConfigurationToken, QueryMap, HeadersMap, []).

-spec get_latest_configuration(aws_client:aws_client(), binary() | list(), map(), map(), proplists:proplist()) ->
    {ok, get_latest_configuration_response(), tuple()} |
    {error, any()} |
    {error, get_latest_configuration_errors(), tuple()}.
get_latest_configuration(Client, ConfigurationToken, QueryMap, HeadersMap, Options0)
  when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) ->
    Path = ["/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}
               | Options2],

    Headers = [],

    Query0_ =
      [
        {<<"configuration_token">>, ConfigurationToken}
      ],
    Query_ = [H || {_, V} = H <- Query0_, V =/= undefined],

    case request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode) of
      {ok, Body0, {_, ResponseHeaders, _} = Response} ->
        ResponseHeadersParams =
          [
            {<<"Content-Type">>, <<"ContentType">>},
            {<<"Next-Poll-Configuration-Token">>, <<"NextPollConfigurationToken">>},
            {<<"Next-Poll-Interval-In-Seconds">>, <<"NextPollIntervalInSeconds">>},
            {<<"Version-Label">>, <<"VersionLabel">>}
          ],
        FoldFun = fun({Name_, Key_}, Acc_) ->
                      case lists:keyfind(Name_, 1, ResponseHeaders) of
                        false -> Acc_;
                        {_, Value_} -> Acc_#{Key_ => Value_}
                      end
                  end,
        Body = lists:foldl(FoldFun, Body0, ResponseHeadersParams),
        {ok, Body, Response};
      Result ->
        Result
    end.

%% @doc Starts a configuration session used to retrieve a deployed
%% configuration.
%%
%% For more
%% information about this API action and to view example CLI commands that
%% show how to use
%% it with the `GetLatestConfiguration' API action, see Retrieving the
%% configuration:
%% http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
%% in the AppConfig User Guide.
-spec start_configuration_session(aws_client:aws_client(), start_configuration_session_request()) ->
    {ok, start_configuration_session_response(), tuple()} |
    {error, any()} |
    {error, start_configuration_session_errors(), tuple()}.
start_configuration_session(Client, Input) ->
    start_configuration_session(Client, Input, []).

-spec start_configuration_session(aws_client:aws_client(), start_configuration_session_request(), proplists:proplist()) ->
    {ok, start_configuration_session_response(), tuple()} |
    {error, any()} |
    {error, start_configuration_session_errors(), tuple()}.
start_configuration_session(Client, Input0, Options0) ->
    Method = post,
    Path = ["/configurationsessions"],
    SuccessStatusCode = 201,
    {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 => <<"appconfig">>},
    DefaultHost = build_host(<<"appconfigdata">>, 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_AWS_APPCONFIGDATA">>),
    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).