%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE! %% See https://github.com/aws-beam/aws-codegen for more details. %% @doc Amazon DevOps Guru is a fully managed service that helps you identify %% anomalous behavior in business critical operational applications. %% %% You specify the AWS resources that you want DevOps Guru to cover, then the %% Amazon CloudWatch metrics and AWS CloudTrail events related to those %% resources are analyzed. When anomalous behavior is detected, DevOps Guru %% creates an insight that includes recommendations, related events, and %% related metrics that can help you improve your operational applications. %% For more information, see What is Amazon DevOps Guru. %% %% You can specify 1 or 2 Amazon Simple Notification Service topics so you %% are notified every time a new insight is created. You can also enable %% DevOps Guru to generate an OpsItem in AWS Systems Manager for each insight %% to help you manage and track your work addressing insights. %% %% To learn about the DevOps Guru workflow, see How DevOps Guru works. To %% learn about DevOps Guru concepts, see Concepts in DevOps Guru. -module(aws_devops_guru). -export([add_notification_channel/2, add_notification_channel/3, describe_account_health/1, describe_account_health/3, describe_account_health/4, describe_account_overview/2, describe_account_overview/3, describe_anomaly/2, describe_anomaly/4, describe_anomaly/5, describe_feedback/2, describe_feedback/3, describe_insight/2, describe_insight/4, describe_insight/5, describe_resource_collection_health/2, describe_resource_collection_health/4, describe_resource_collection_health/5, describe_service_integration/1, describe_service_integration/3, describe_service_integration/4, get_resource_collection/2, get_resource_collection/4, get_resource_collection/5, list_anomalies_for_insight/3, list_anomalies_for_insight/4, list_events/2, list_events/3, list_insights/2, list_insights/3, list_notification_channels/2, list_notification_channels/3, list_recommendations/2, list_recommendations/3, put_feedback/2, put_feedback/3, remove_notification_channel/3, remove_notification_channel/4, search_insights/2, search_insights/3, update_resource_collection/2, update_resource_collection/3, update_service_integration/2, update_service_integration/3]). -include_lib("hackney/include/hackney_lib.hrl"). %%==================================================================== %% API %%==================================================================== %% @doc Adds a notification channel to DevOps Guru. %% %% A notification channel is used to notify you about important DevOps Guru %% events, such as when an insight is generated. %% %% If you use an Amazon SNS topic in another account, you must attach a %% policy to it that grants DevOps Guru permission to it notifications. %% DevOps Guru adds the required policy on your behalf to send notifications %% using Amazon SNS in your account. For more information, see Permissions %% for cross account Amazon SNS topics. %% %% If you use an Amazon SNS topic that is encrypted by an AWS Key Management %% Service customer-managed key (CMK), then you must add permissions to the %% CMK. For more information, see Permissions for AWS KMS–encrypted Amazon %% SNS topics. add_notification_channel(Client, Input) -> add_notification_channel(Client, Input, []). add_notification_channel(Client, Input0, Options0) -> Method = put, Path = ["/channels"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns the number of open reactive insights, the number of open %% proactive insights, and the number of metrics analyzed in your AWS %% account. %% %% Use these numbers to gauge the health of operations in your AWS account. describe_account_health(Client) when is_map(Client) -> describe_account_health(Client, #{}, #{}). describe_account_health(Client, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_account_health(Client, QueryMap, HeadersMap, []). describe_account_health(Client, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/accounts/health"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query_ = [], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc For the time range passed in, returns the number of open reactive %% insight that were created, the number of open proactive insights that were %% created, and the Mean Time to Recover (MTTR) for all closed reactive %% insights. describe_account_overview(Client, Input) -> describe_account_overview(Client, Input, []). describe_account_overview(Client, Input0, Options0) -> Method = post, Path = ["/accounts/overview"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns details about an anomaly that you specify using its ID. describe_anomaly(Client, Id) when is_map(Client) -> describe_anomaly(Client, Id, #{}, #{}). describe_anomaly(Client, Id, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_anomaly(Client, Id, QueryMap, HeadersMap, []). describe_anomaly(Client, Id, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/anomalies/", aws_util:encode_uri(Id), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query_ = [], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Returns the most recent feedback submitted in the current AWS account %% and Region. describe_feedback(Client, Input) -> describe_feedback(Client, Input, []). describe_feedback(Client, Input0, Options0) -> Method = post, Path = ["/feedback"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns details about an insight that you specify using its ID. describe_insight(Client, Id) when is_map(Client) -> describe_insight(Client, Id, #{}, #{}). describe_insight(Client, Id, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_insight(Client, Id, QueryMap, HeadersMap, []). describe_insight(Client, Id, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/insights/", aws_util:encode_uri(Id), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query_ = [], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Returns the number of open proactive insights, open reactive %% insights, and the Mean Time to Recover (MTTR) for all closed insights in %% resource collections in your account. %% %% You specify the type of AWS resources collection. The one type of AWS %% resource collection supported is AWS CloudFormation stacks. DevOps Guru %% can be configured to analyze only the AWS resources that are defined in %% the stacks. describe_resource_collection_health(Client, ResourceCollectionType) when is_map(Client) -> describe_resource_collection_health(Client, ResourceCollectionType, #{}, #{}). describe_resource_collection_health(Client, ResourceCollectionType, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_resource_collection_health(Client, ResourceCollectionType, QueryMap, HeadersMap, []). describe_resource_collection_health(Client, ResourceCollectionType, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/accounts/health/resource-collection/", aws_util:encode_uri(ResourceCollectionType), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query0_ = [ {<<"NextToken">>, maps:get(<<"NextToken">>, QueryMap, undefined)} ], Query_ = [H || {_, V} = H <- Query0_, V =/= undefined], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Returns the integration status of services that are integrated with %% DevOps Guru. %% %% The one service that can be integrated with DevOps Guru is AWS Systems %% Manager, which can be used to create an OpsItem for each generated %% insight. describe_service_integration(Client) when is_map(Client) -> describe_service_integration(Client, #{}, #{}). describe_service_integration(Client, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_service_integration(Client, QueryMap, HeadersMap, []). describe_service_integration(Client, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/service-integrations"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query_ = [], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Returns lists AWS resources that are of the specified resource %% collection type. %% %% The one type of AWS resource collection supported is AWS CloudFormation %% stacks. DevOps Guru can be configured to analyze only the AWS resources %% that are defined in the stacks. get_resource_collection(Client, ResourceCollectionType) when is_map(Client) -> get_resource_collection(Client, ResourceCollectionType, #{}, #{}). get_resource_collection(Client, ResourceCollectionType, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> get_resource_collection(Client, ResourceCollectionType, QueryMap, HeadersMap, []). get_resource_collection(Client, ResourceCollectionType, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/resource-collections/", aws_util:encode_uri(ResourceCollectionType), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query0_ = [ {<<"NextToken">>, maps:get(<<"NextToken">>, QueryMap, undefined)} ], Query_ = [H || {_, V} = H <- Query0_, V =/= undefined], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Returns a list of the anomalies that belong to an insight that you %% specify using its ID. list_anomalies_for_insight(Client, InsightId, Input) -> list_anomalies_for_insight(Client, InsightId, Input, []). list_anomalies_for_insight(Client, InsightId, Input0, Options0) -> Method = post, Path = ["/anomalies/insight/", aws_util:encode_uri(InsightId), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns a list of the events emitted by the resources that are %% evaluated by DevOps Guru. %% %% You can use filters to specify which events are returned. list_events(Client, Input) -> list_events(Client, Input, []). list_events(Client, Input0, Options0) -> Method = post, Path = ["/events"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns a list of insights in your AWS account. %% %% You can specify which insights are returned by their start time and status %% (`ONGOING', `CLOSED', or `ANY'). list_insights(Client, Input) -> list_insights(Client, Input, []). list_insights(Client, Input0, Options0) -> Method = post, Path = ["/insights"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns a list of notification channels configured for DevOps Guru. %% %% Each notification channel is used to notify you when DevOps Guru generates %% an insight that contains information about how to improve your operations. %% The one supported notification channel is Amazon Simple Notification %% Service (Amazon SNS). list_notification_channels(Client, Input) -> list_notification_channels(Client, Input, []). list_notification_channels(Client, Input0, Options0) -> Method = post, Path = ["/channels"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns a list of a specified insight's recommendations. %% %% Each recommendation includes a list of related metrics and a list of %% related events. list_recommendations(Client, Input) -> list_recommendations(Client, Input, []). list_recommendations(Client, Input0, Options0) -> Method = post, Path = ["/recommendations"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Collects customer feedback about the specified insight. put_feedback(Client, Input) -> put_feedback(Client, Input, []). put_feedback(Client, Input0, Options0) -> Method = put, Path = ["/feedback"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Removes a notification channel from DevOps Guru. %% %% A notification channel is used to notify you when DevOps Guru generates an %% insight that contains information about how to improve your operations. remove_notification_channel(Client, Id, Input) -> remove_notification_channel(Client, Id, Input, []). remove_notification_channel(Client, Id, Input0, Options0) -> Method = delete, Path = ["/channels/", aws_util:encode_uri(Id), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Returns a list of insights in your AWS account. %% %% You can specify which insights are returned by their start time, one or %% more statuses (`ONGOING', `CLOSED', and `CLOSED'), one or more severities %% (`LOW', `MEDIUM', and `HIGH'), and type (`REACTIVE' or `PROACTIVE'). %% %% Use the `Filters' parameter to specify status and severity search %% parameters. Use the `Type' parameter to specify `REACTIVE' or `PROACTIVE' %% in your search. search_insights(Client, Input) -> search_insights(Client, Input, []). search_insights(Client, Input0, Options0) -> Method = post, Path = ["/insights/search"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Updates the collection of resources that DevOps Guru analyzes. %% %% The one type of AWS resource collection supported is AWS CloudFormation %% stacks. DevOps Guru can be configured to analyze only the AWS resources %% that are defined in the stacks. This method also creates the IAM role %% required for you to use DevOps Guru. update_resource_collection(Client, Input) -> update_resource_collection(Client, Input, []). update_resource_collection(Client, Input0, Options0) -> Method = put, Path = ["/resource-collections"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Enables or disables integration with a service that can be integrated %% with DevOps Guru. %% %% The one service that can be integrated with DevOps Guru is AWS Systems %% Manager, which can be used to create an OpsItem for each generated %% insight. update_service_integration(Client, Input) -> update_service_integration(Client, Input, []). update_service_integration(Client, Input0, Options0) -> Method = put, Path = ["/service-integrations"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, Query_ = [], Input = Input1, request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %%==================================================================== %% Internal functions %%==================================================================== -spec request(aws_client:aws_client(), atom(), iolist(), list(), list(), map() | undefined, list(), pos_integer() | undefined) -> {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) -> Client1 = Client#{service => <<"devops-guru">>}, Host = build_host(<<"devops-guru">>, Client1), URL0 = build_url(Host, Path, Client1), URL = aws_request:add_query(URL0, Query), AdditionalHeaders = [ {<<"Host">>, Host} , {<<"Content-Type">>, <<"application/x-amz-json-1.1">>} ], Headers1 = aws_request:add_headers(AdditionalHeaders, Headers0), Payload = case proplists:get_value(send_body_as_binary, Options) of true -> maps:get(<<"Body">>, Input, <<"">>); false -> encode_payload(Input) end, 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). handle_response({ok, StatusCode, ResponseHeaders, Client}, SuccessStatusCode, DecodeBody) when StatusCode =:= 200; StatusCode =:= 202; StatusCode =:= 204; StatusCode =:= SuccessStatusCode -> case hackney:body(Client) of {ok, <<>>} when StatusCode =:= 200; StatusCode =:= SuccessStatusCode -> {ok, #{}, {StatusCode, ResponseHeaders, Client}}; {ok, Body} -> Result = case DecodeBody of true -> jsx:decode(Body); false -> #{<<"Body">> => Body} end, {ok, Result, {StatusCode, ResponseHeaders, Client}} end; handle_response({ok, StatusCode, ResponseHeaders, Client}, _, _DecodeBody) -> {ok, Body} = hackney:body(Client), Error = jsx:decode(Body), {error, Error, {StatusCode, ResponseHeaders, Client}}; 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 = maps:get(proto, Client), Path = erlang:iolist_to_binary(Path0), Port = maps:get(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).