aws_erlang

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

%% @doc <fullname>AWS OpsWorks CM</fullname>
%%
%% AWS OpsWorks for configuration management (CM) is a service that runs and
%% manages configuration management servers. You can use AWS OpsWorks CM to
%% create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for
%% Puppet Enterprise servers, and add or remove nodes for the servers to
%% manage.
%%
%% <b>Glossary of terms</b>
%%
%% <ul> <li> <b>Server</b>: A configuration management server that can be
%% highly-available. The configuration management server runs on an Amazon
%% Elastic Compute Cloud (EC2) instance, and may use various other AWS
%% services, such as Amazon Relational Database Service (RDS) and Elastic
%% Load Balancing. A server is a generic abstraction over the configuration
%% manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM,
%% you do not start or stop servers. After you create servers, they continue
%% to run until they are deleted.
%%
%% </li> <li> <b>Engine</b>: The engine is the specific configuration manager
%% that you want to use. Valid values in this release include
%% <code>ChefAutomate</code> and <code>Puppet</code>.
%%
%% </li> <li> <b>Backup</b>: This is an application-level backup of the data
%% that the configuration manager stores. AWS OpsWorks CM creates an S3
%% bucket for backups when you launch the first server. A backup maintains a
%% snapshot of a server's configuration-related attributes at the time the
%% backup starts.
%%
%% </li> <li> <b>Events</b>: Events are always related to a server. Events
%% are written during server creation, when health checks run, when backups
%% are created, when system maintenance is performed, etc. When you delete a
%% server, the server's events are also deleted.
%%
%% </li> <li> <b>Account attributes</b>: Every account has attributes that
%% are assigned in the AWS OpsWorks CM database. These attributes store
%% information about configuration limits (servers, backups, etc.) and your
%% customer account.
%%
%% </li> </ul> <b>Endpoints</b>
%%
%% AWS OpsWorks CM supports the following endpoints, all HTTPS. You must
%% connect to one of the following endpoints. Your servers can only be
%% accessed or managed within the endpoint in which they are created.
%%
%% <ul> <li> opsworks-cm.us-east-1.amazonaws.com
%%
%% </li> <li> opsworks-cm.us-east-2.amazonaws.com
%%
%% </li> <li> opsworks-cm.us-west-1.amazonaws.com
%%
%% </li> <li> opsworks-cm.us-west-2.amazonaws.com
%%
%% </li> <li> opsworks-cm.ap-northeast-1.amazonaws.com
%%
%% </li> <li> opsworks-cm.ap-southeast-1.amazonaws.com
%%
%% </li> <li> opsworks-cm.ap-southeast-2.amazonaws.com
%%
%% </li> <li> opsworks-cm.eu-central-1.amazonaws.com
%%
%% </li> <li> opsworks-cm.eu-west-1.amazonaws.com
%%
%% </li> </ul> For more information, see <a
%% href="https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html">AWS
%% OpsWorks endpoints and quotas</a> in the AWS General Reference.
%%
%% <b>Throttling limits</b>
%%
%% All API operations allow for five requests per second with a burst of 10
%% requests per second.
-module(aws_ops_works_chef_automate).

-export([associate_node/2,
         associate_node/3,
         create_backup/2,
         create_backup/3,
         create_server/2,
         create_server/3,
         delete_backup/2,
         delete_backup/3,
         delete_server/2,
         delete_server/3,
         describe_account_attributes/2,
         describe_account_attributes/3,
         describe_backups/2,
         describe_backups/3,
         describe_events/2,
         describe_events/3,
         describe_node_association_status/2,
         describe_node_association_status/3,
         describe_servers/2,
         describe_servers/3,
         disassociate_node/2,
         disassociate_node/3,
         export_server_engine_attribute/2,
         export_server_engine_attribute/3,
         list_tags_for_resource/2,
         list_tags_for_resource/3,
         restore_server/2,
         restore_server/3,
         start_maintenance/2,
         start_maintenance/3,
         tag_resource/2,
         tag_resource/3,
         untag_resource/2,
         untag_resource/3,
         update_server/2,
         update_server/3,
         update_server_engine_attributes/2,
         update_server_engine_attributes/3]).

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

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

%% @doc Associates a new node with the server. For more information about how
%% to disassociate a node, see <a>DisassociateNode</a>.
%%
%% On a Chef server: This command is an alternative to <code>knife
%% bootstrap</code>.
%%
%% Example (Chef): <code>aws opsworks-cm associate-node --server-name
%% <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes
%% "Name=<i>CHEF_ORGANIZATION</i>,Value=default"
%% "Name=<i>CHEF_NODE_PUBLIC_KEY</i>,Value=<i>public-key-pem</i>"</code>
%%
%% On a Puppet server, this command is an alternative to the <code>puppet
%% cert sign</code> command that signs a Puppet node CSR.
%%
%% Example (Puppet): <code>aws opsworks-cm associate-node --server-name
%% <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes
%% "Name=<i>PUPPET_NODE_CSR</i>,Value=<i>csr-pem</i>"</code>
%%
%% A node can can only be associated with servers that are in a
%% <code>HEALTHY</code> state. Otherwise, an
%% <code>InvalidStateException</code> is thrown. A
%% <code>ResourceNotFoundException</code> is thrown when the server does not
%% exist. A <code>ValidationException</code> is raised when parameters of the
%% request are not valid. The AssociateNode API call can be integrated into
%% Auto Scaling configurations, AWS Cloudformation templates, or the user
%% data of a server's instance.
associate_node(Client, Input)
  when is_map(Client), is_map(Input) ->
    associate_node(Client, Input, []).
associate_node(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"AssociateNode">>, Input, Options).

%% @doc Creates an application-level backup of a server. While the server is
%% in the <code>BACKING_UP</code> state, the server cannot be changed, and no
%% additional backup can be created.
%%
%% Backups can be created for servers in <code>RUNNING</code>,
%% <code>HEALTHY</code>, and <code>UNHEALTHY</code> states. By default, you
%% can create a maximum of 50 manual backups.
%%
%% This operation is asynchronous.
%%
%% A <code>LimitExceededException</code> is thrown when the maximum number of
%% manual backups is reached. An <code>InvalidStateException</code> is thrown
%% when the server is not in any of the following states: RUNNING, HEALTHY,
%% or UNHEALTHY. A <code>ResourceNotFoundException</code> is thrown when the
%% server is not found. A <code>ValidationException</code> is thrown when
%% parameters of the request are not valid.
create_backup(Client, Input)
  when is_map(Client), is_map(Input) ->
    create_backup(Client, Input, []).
create_backup(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"CreateBackup">>, Input, Options).

%% @doc Creates and immedately starts a new server. The server is ready to
%% use when it is in the <code>HEALTHY</code> state. By default, you can
%% create a maximum of 10 servers.
%%
%% This operation is asynchronous.
%%
%% A <code>LimitExceededException</code> is thrown when you have created the
%% maximum number of servers (10). A
%% <code>ResourceAlreadyExistsException</code> is thrown when a server with
%% the same name already exists in the account. A
%% <code>ResourceNotFoundException</code> is thrown when you specify a backup
%% ID that is not valid or is for a backup that does not exist. A
%% <code>ValidationException</code> is thrown when parameters of the request
%% are not valid.
%%
%% If you do not specify a security group by adding the
%% <code>SecurityGroupIds</code> parameter, AWS OpsWorks creates a new
%% security group.
%%
%% <i>Chef Automate:</i> The default security group opens the Chef server to
%% the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables
%% SSH access. SSH is also open to the world on TCP port 22.
%%
%% <i>Puppet Enterprise:</i> The default security group opens TCP ports 22,
%% 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS
%% OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
%%
%% By default, your server is accessible from any IP address. We recommend
%% that you update your security group rules to allow access from known IP
%% addresses and address ranges only. To edit security group rules, open
%% Security Groups in the navigation pane of the EC2 management console.
%%
%% To specify your own domain for a server, and provide your own self-signed
%% or CA-signed certificate and private key, specify values for
%% <code>CustomDomain</code>, <code>CustomCertificate</code>, and
%% <code>CustomPrivateKey</code>.
create_server(Client, Input)
  when is_map(Client), is_map(Input) ->
    create_server(Client, Input, []).
create_server(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"CreateServer">>, Input, Options).

%% @doc Deletes a backup. You can delete both manual and automated backups.
%% This operation is asynchronous.
%%
%% An <code>InvalidStateException</code> is thrown when a backup deletion is
%% already in progress. A <code>ResourceNotFoundException</code> is thrown
%% when the backup does not exist. A <code>ValidationException</code> is
%% thrown when parameters of the request are not valid.
delete_backup(Client, Input)
  when is_map(Client), is_map(Input) ->
    delete_backup(Client, Input, []).
delete_backup(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DeleteBackup">>, Input, Options).

%% @doc Deletes the server and the underlying AWS CloudFormation stacks
%% (including the server's EC2 instance). When you run this command, the
%% server state is updated to <code>DELETING</code>. After the server is
%% deleted, it is no longer returned by <code>DescribeServer</code> requests.
%% If the AWS CloudFormation stack cannot be deleted, the server cannot be
%% deleted.
%%
%% This operation is asynchronous.
%%
%% An <code>InvalidStateException</code> is thrown when a server deletion is
%% already in progress. A <code>ResourceNotFoundException</code> is thrown
%% when the server does not exist. A <code>ValidationException</code> is
%% raised when parameters of the request are not valid.
delete_server(Client, Input)
  when is_map(Client), is_map(Input) ->
    delete_server(Client, Input, []).
delete_server(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DeleteServer">>, Input, Options).

%% @doc Describes your OpsWorks-CM account attributes.
%%
%% This operation is synchronous.
describe_account_attributes(Client, Input)
  when is_map(Client), is_map(Input) ->
    describe_account_attributes(Client, Input, []).
describe_account_attributes(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DescribeAccountAttributes">>, Input, Options).

%% @doc Describes backups. The results are ordered by time, with newest
%% backups first. If you do not specify a BackupId or ServerName, the command
%% returns all backups.
%%
%% This operation is synchronous.
%%
%% A <code>ResourceNotFoundException</code> is thrown when the backup does
%% not exist. A <code>ValidationException</code> is raised when parameters of
%% the request are not valid.
describe_backups(Client, Input)
  when is_map(Client), is_map(Input) ->
    describe_backups(Client, Input, []).
describe_backups(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DescribeBackups">>, Input, Options).

%% @doc Describes events for a specified server. Results are ordered by time,
%% with newest events first.
%%
%% This operation is synchronous.
%%
%% A <code>ResourceNotFoundException</code> is thrown when the server does
%% not exist. A <code>ValidationException</code> is raised when parameters of
%% the request are not valid.
describe_events(Client, Input)
  when is_map(Client), is_map(Input) ->
    describe_events(Client, Input, []).
describe_events(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DescribeEvents">>, Input, Options).

%% @doc Returns the current status of an existing association or
%% disassociation request.
%%
%% A <code>ResourceNotFoundException</code> is thrown when no recent
%% association or disassociation request with the specified token is found,
%% or when the server does not exist. A <code>ValidationException</code> is
%% raised when parameters of the request are not valid.
describe_node_association_status(Client, Input)
  when is_map(Client), is_map(Input) ->
    describe_node_association_status(Client, Input, []).
describe_node_association_status(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DescribeNodeAssociationStatus">>, Input, Options).

%% @doc Lists all configuration management servers that are identified with
%% your account. Only the stored results from Amazon DynamoDB are returned.
%% AWS OpsWorks CM does not query other services.
%%
%% This operation is synchronous.
%%
%% A <code>ResourceNotFoundException</code> is thrown when the server does
%% not exist. A <code>ValidationException</code> is raised when parameters of
%% the request are not valid.
describe_servers(Client, Input)
  when is_map(Client), is_map(Input) ->
    describe_servers(Client, Input, []).
describe_servers(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DescribeServers">>, Input, Options).

%% @doc Disassociates a node from an AWS OpsWorks CM server, and removes the
%% node from the server's managed nodes. After a node is disassociated, the
%% node key pair is no longer valid for accessing the configuration manager's
%% API. For more information about how to associate a node, see
%% <a>AssociateNode</a>.
%%
%% A node can can only be disassociated from a server that is in a
%% <code>HEALTHY</code> state. Otherwise, an
%% <code>InvalidStateException</code> is thrown. A
%% <code>ResourceNotFoundException</code> is thrown when the server does not
%% exist. A <code>ValidationException</code> is raised when parameters of the
%% request are not valid.
disassociate_node(Client, Input)
  when is_map(Client), is_map(Input) ->
    disassociate_node(Client, Input, []).
disassociate_node(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"DisassociateNode">>, Input, Options).

%% @doc Exports a specified server engine attribute as a base64-encoded
%% string. For example, you can export user data that you can use in EC2 to
%% associate nodes with a server.
%%
%% This operation is synchronous.
%%
%% A <code>ValidationException</code> is raised when parameters of the
%% request are not valid. A <code>ResourceNotFoundException</code> is thrown
%% when the server does not exist. An <code>InvalidStateException</code> is
%% thrown when the server is in any of the following states: CREATING,
%% TERMINATED, FAILED or DELETING.
export_server_engine_attribute(Client, Input)
  when is_map(Client), is_map(Input) ->
    export_server_engine_attribute(Client, Input, []).
export_server_engine_attribute(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"ExportServerEngineAttribute">>, Input, Options).

%% @doc Returns a list of tags that are applied to the specified AWS OpsWorks
%% for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or
%% backups.
list_tags_for_resource(Client, Input)
  when is_map(Client), is_map(Input) ->
    list_tags_for_resource(Client, Input, []).
list_tags_for_resource(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"ListTagsForResource">>, Input, Options).

%% @doc Restores a backup to a server that is in a
%% <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>,
%% <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run
%% RestoreServer, the server's EC2 instance is deleted, and a new EC2
%% instance is configured. RestoreServer maintains the existing server
%% endpoint, so configuration management of the server's client devices
%% (nodes) should continue to work.
%%
%% Restoring from a backup is performed by creating a new EC2 instance. If
%% restoration is successful, and the server is in a <code>HEALTHY</code>
%% state, AWS OpsWorks CM switches traffic over to the new instance. After
%% restoration is finished, the old EC2 instance is maintained in a
%% <code>Running</code> or <code>Stopped</code> state, but is eventually
%% terminated.
%%
%% This operation is asynchronous.
%%
%% An <code>InvalidStateException</code> is thrown when the server is not in
%% a valid state. A <code>ResourceNotFoundException</code> is thrown when the
%% server does not exist. A <code>ValidationException</code> is raised when
%% parameters of the request are not valid.
restore_server(Client, Input)
  when is_map(Client), is_map(Input) ->
    restore_server(Client, Input, []).
restore_server(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"RestoreServer">>, Input, Options).

%% @doc Manually starts server maintenance. This command can be useful if an
%% earlier maintenance attempt failed, and the underlying cause of
%% maintenance failure has been resolved. The server is in an
%% <code>UNDER_MAINTENANCE</code> state while maintenance is in progress.
%%
%% Maintenance can only be started on servers in <code>HEALTHY</code> and
%% <code>UNHEALTHY</code> states. Otherwise, an
%% <code>InvalidStateException</code> is thrown. A
%% <code>ResourceNotFoundException</code> is thrown when the server does not
%% exist. A <code>ValidationException</code> is raised when parameters of the
%% request are not valid.
start_maintenance(Client, Input)
  when is_map(Client), is_map(Input) ->
    start_maintenance(Client, Input, []).
start_maintenance(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"StartMaintenance">>, Input, Options).

%% @doc Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
%% Puppet Enterprise server, or to server backups.
tag_resource(Client, Input)
  when is_map(Client), is_map(Input) ->
    tag_resource(Client, Input, []).
tag_resource(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"TagResource">>, Input, Options).

%% @doc Removes specified tags from an AWS OpsWorks-CM server or backup.
untag_resource(Client, Input)
  when is_map(Client), is_map(Input) ->
    untag_resource(Client, Input, []).
untag_resource(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"UntagResource">>, Input, Options).

%% @doc Updates settings for a server.
%%
%% This operation is synchronous.
update_server(Client, Input)
  when is_map(Client), is_map(Input) ->
    update_server(Client, Input, []).
update_server(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"UpdateServer">>, Input, Options).

%% @doc Updates engine-specific attributes on a specified server. The server
%% enters the <code>MODIFYING</code> state when this operation is in
%% progress. Only one update can occur at a time. You can use this command to
%% reset a Chef server's public key (<code>CHEF_PIVOTAL_KEY</code>) or a
%% Puppet server's admin password (<code>PUPPET_ADMIN_PASSWORD</code>).
%%
%% This operation is asynchronous.
%%
%% This operation can only be called for servers in <code>HEALTHY</code> or
%% <code>UNHEALTHY</code> states. Otherwise, an
%% <code>InvalidStateException</code> is raised. A
%% <code>ResourceNotFoundException</code> is thrown when the server does not
%% exist. A <code>ValidationException</code> is raised when parameters of the
%% request are not valid.
update_server_engine_attributes(Client, Input)
  when is_map(Client), is_map(Input) ->
    update_server_engine_attributes(Client, Input, []).
update_server_engine_attributes(Client, Input, Options)
  when is_map(Client), is_map(Input), is_list(Options) ->
    request(Client, <<"UpdateServerEngineAttributes">>, Input, Options).

%%====================================================================
%% Internal functions
%%====================================================================

-spec request(aws_client:aws_client(), binary(), map(), list()) ->
    {ok, Result, {integer(), list(), hackney:client()}} |
    {error, Error, {integer(), list(), hackney:client()}} |
    {error, term()} when
    Result :: map() | undefined,
    Error :: {binary(), binary()}.
request(Client, Action, Input, Options) ->
    Client1 = Client#{service => <<"opsworks-cm">>},
    Host = get_host(<<"opsworks-cm">>, Client1),
    URL = get_url(Host, Client1),
    Headers = [
        {<<"Host">>, Host},
        {<<"Content-Type">>, <<"application/x-amz-json-1.1">>},
        {<<"X-Amz-Target">>, << <<"OpsWorksCM_V2016_11_01.">>/binary, Action/binary>>}
    ],
    Payload = jsx:encode(Input),
    SignedHeaders = aws_request:sign_request(Client1, <<"POST">>, URL, Headers, Payload),
    Response = hackney:request(post, URL, SignedHeaders, Payload, Options),
    handle_response(Response).

handle_response({ok, 200, ResponseHeaders, Client}) ->
    case hackney:body(Client) of
        {ok, <<>>} ->
            {ok, undefined, {200, ResponseHeaders, Client}};
        {ok, Body} ->
            Result = jsx:decode(Body, [return_maps]),
            {ok, Result, {200, ResponseHeaders, Client}}
    end;
handle_response({ok, StatusCode, ResponseHeaders, Client}) ->
    {ok, Body} = hackney:body(Client),
    Error = jsx:decode(Body, [return_maps]),
    Exception = maps:get(<<"__type">>, Error, undefined),
    Reason = maps:get(<<"message">>, Error, undefined),
    {error, {Exception, Reason}, {StatusCode, ResponseHeaders, Client}};
handle_response({error, Reason}) ->
    {error, Reason}.

get_host(_EndpointPrefix, #{region := <<"local">>}) ->
    <<"localhost">>;
get_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
    aws_util:binary_join([EndpointPrefix, <<".">>, Region, <<".">>, Endpoint], <<"">>).

get_url(Host, Client) ->
    Proto = maps:get(proto, Client),
    Port = maps:get(port, Client),
    aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, <<"/">>], <<"">>).