%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE! %% See https://github.com/aws-beam/aws-codegen for more details. %% @doc This section provides documentation for the Amazon CodeGuru Profiler %% API operations. %% %%
Amazon CodeGuru Profiler collects runtime performance data from your %% live applications, and provides recommendations that can help you %% fine-tune your application performance. Using machine learning algorithms, %% CodeGuru Profiler can help you find your most expensive lines of code and %% suggest ways you can improve efficiency and remove CPU bottlenecks.
%%Amazon CodeGuru Profiler provides different visualizations of profiling %% data to help you identify what code is running on the CPU, see how much %% time is consumed, and suggest ways to reduce CPU utilization.
Amazon CodeGuru Profiler currently supports applications written in all %% Java virtual machine (JVM) languages. While CodeGuru Profiler supports %% both visualizations and recommendations for applications written in Java, %% it can also generate visualizations and a subset of recommendations for %% applications written in other JVM languages.
For more %% information, see What %% is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User %% Guide.
-module(aws_codeguruprofiler). -export([add_notification_channels/3, add_notification_channels/4, batch_get_frame_metric_data/3, batch_get_frame_metric_data/4, configure_agent/3, configure_agent/4, create_profiling_group/2, create_profiling_group/3, delete_profiling_group/3, delete_profiling_group/4, describe_profiling_group/2, describe_profiling_group/4, describe_profiling_group/5, get_findings_report_account_summary/1, get_findings_report_account_summary/3, get_findings_report_account_summary/4, get_notification_configuration/2, get_notification_configuration/4, get_notification_configuration/5, get_policy/2, get_policy/4, get_policy/5, get_profile/2, get_profile/4, get_profile/5, get_recommendations/4, get_recommendations/6, get_recommendations/7, list_findings_reports/4, list_findings_reports/6, list_findings_reports/7, list_profile_times/5, list_profile_times/7, list_profile_times/8, list_profiling_groups/1, list_profiling_groups/3, list_profiling_groups/4, list_tags_for_resource/2, list_tags_for_resource/4, list_tags_for_resource/5, post_agent_profile/3, post_agent_profile/4, put_permission/4, put_permission/5, remove_notification_channel/4, remove_notification_channel/5, remove_permission/4, remove_permission/5, submit_feedback/4, submit_feedback/5, tag_resource/3, tag_resource/4, untag_resource/3, untag_resource/4, update_profiling_group/3, update_profiling_group/4]). -include_lib("hackney/include/hackney_lib.hrl"). %%==================================================================== %% API %%==================================================================== %% @doc Add up to 2 anomaly notifications channels for a profiling group. add_notification_channels(Client, ProfilingGroupName, Input) -> add_notification_channels(Client, ProfilingGroupName, Input, []). add_notification_channels(Client, ProfilingGroupName, Input0, Options0) -> Method = post, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/notificationConfiguration"], 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 time series of values for a requested list of frame %% metrics from a time period. batch_get_frame_metric_data(Client, ProfilingGroupName, Input) -> batch_get_frame_metric_data(Client, ProfilingGroupName, Input, []). batch_get_frame_metric_data(Client, ProfilingGroupName, Input0, Options0) -> Method = post, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/frames/-/metrics"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, QueryMapping = [ {<<"endTime">>, <<"endTime">>}, {<<"period">>, <<"period">>}, {<<"startTime">>, <<"startTime">>}, {<<"targetResolution">>, <<"targetResolution">>} ], {Query_, Input} = aws_request:build_headers(QueryMapping, Input1), request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Used by profiler agents to report their current state and to receive %% remote configuration updates. %% %% For example, `ConfigureAgent' can be used to tell and agent whether to %% profile or not and for how long to return profiling data. configure_agent(Client, ProfilingGroupName, Input) -> configure_agent(Client, ProfilingGroupName, Input, []). configure_agent(Client, ProfilingGroupName, Input0, Options0) -> Method = post, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/configureAgent"], 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 Creates a profiling group. create_profiling_group(Client, Input) -> create_profiling_group(Client, Input, []). create_profiling_group(Client, Input0, Options0) -> Method = post, Path = ["/profilingGroups"], SuccessStatusCode = 201, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, QueryMapping = [ {<<"clientToken">>, <<"clientToken">>} ], {Query_, Input} = aws_request:build_headers(QueryMapping, Input1), request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Deletes a profiling group. delete_profiling_group(Client, ProfilingGroupName, Input) -> delete_profiling_group(Client, ProfilingGroupName, Input, []). delete_profiling_group(Client, ProfilingGroupName, Input0, Options0) -> Method = delete, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), ""], SuccessStatusCode = 204, 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 `ProfilingGroupDescription' object that contains %% information about the requested profiling group. describe_profiling_group(Client, ProfilingGroupName) when is_map(Client) -> describe_profiling_group(Client, ProfilingGroupName, #{}, #{}). describe_profiling_group(Client, ProfilingGroupName, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> describe_profiling_group(Client, ProfilingGroupName, QueryMap, HeadersMap, []). describe_profiling_group(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), ""], 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 a list of `FindingsReportSummary' objects that contain %% analysis results for all profiling groups in your AWS account. get_findings_report_account_summary(Client) when is_map(Client) -> get_findings_report_account_summary(Client, #{}, #{}). get_findings_report_account_summary(Client, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> get_findings_report_account_summary(Client, QueryMap, HeadersMap, []). get_findings_report_account_summary(Client, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/internal/findingsReports"], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Query0_ = [ {<<"dailyReportsOnly">>, maps:get(<<"dailyReportsOnly">>, QueryMap, undefined)}, {<<"maxResults">>, maps:get(<<"maxResults">>, QueryMap, undefined)}, {<<"nextToken">>, maps:get(<<"nextToken">>, QueryMap, undefined)} ], Query_ = [H || {_, V} = H <- Query0_, V =/= undefined], request(Client, get, Path, Query_, Headers, undefined, Options, SuccessStatusCode). %% @doc Get the current configuration for anomaly notifications for a %% profiling group. get_notification_configuration(Client, ProfilingGroupName) when is_map(Client) -> get_notification_configuration(Client, ProfilingGroupName, #{}, #{}). get_notification_configuration(Client, ProfilingGroupName, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> get_notification_configuration(Client, ProfilingGroupName, QueryMap, HeadersMap, []). get_notification_configuration(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/notificationConfiguration"], 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 JSON-formatted resource-based policy on a profiling %% group. get_policy(Client, ProfilingGroupName) when is_map(Client) -> get_policy(Client, ProfilingGroupName, #{}, #{}). get_policy(Client, ProfilingGroupName, QueryMap, HeadersMap) when is_map(Client), is_map(QueryMap), is_map(HeadersMap) -> get_policy(Client, ProfilingGroupName, QueryMap, HeadersMap, []). get_policy(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0) when is_map(Client), is_map(QueryMap), is_map(HeadersMap), is_list(Options0) -> Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/policy"], 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 Gets the aggregated profile of a profiling group for a specified time %% range. %% %% Amazon CodeGuru Profiler collects posted agent profiles for a profiling %% group into aggregated profiles. %% %% Because aggregated profiles expire over time
%% GetProfile is not idempotent.
Specify the
%% time range for the requested aggregated profile using 1 or 2 of the
%% following parameters: startTime, endTime,
%% period. The maximum time range allowed is 7 days. If you
%% specify all 3 parameters, an exception is thrown. If you specify only
%% period, the latest aggregated profile is returned.
%% Aggregated profiles are available with aggregation periods of 5 minutes, 1
%% hour, and 1 day, aligned to UTC. The aggregation period of an aggregated
%% profile determines how long it is retained. For more information, see
%% AggregatedProfileTime . The aggregated profile's
%% aggregation period determines how long it is retained by CodeGuru
%% Profiler.
If the aggregation period is 5 minutes, the %% aggregated profile is retained for 15 days.
If the %% aggregation period is 1 hour, the aggregated profile is retained for 60 %% days.
If the aggregation period is 1 day, the %% aggregated profile is retained for 3 years.
There are
%% two use cases for calling GetProfile.
If
%% you want to return an aggregated profile that already exists, use
%% ListProfileTimes to view the time ranges of existing
%% aggregated profiles. Use them in a GetProfile request to
%% return a specific, existing aggregated profile.
If you %% want to return an aggregated profile for a time range that doesn't align %% with an existing aggregated profile, then CodeGuru Profiler makes a best %% effort to combine existing aggregated profiles from the requested time %% range and return them as one aggregated profile.
If aggregated %% profiles do not exist for the full time range requested, then aggregated %% profiles for a smaller time range are returned. For example, if the %% requested time range is from 00:00 to 00:20, and the existing aggregated %% profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 %% to 00:20 are returned.
The one supported action group that can be added is
%% agentPermission which grants ConfigureAgent and
%% PostAgent permissions. For more information, see Resource-based
%% policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User
%% Guide,
%% ConfigureAgent , and
%% PostAgentProfile .
The first time you call
%% PutPermission on a profiling group, do not specify a
%% revisionId because it doesn't have a resource-based policy.
%% Subsequent calls must provide a revisionId to specify which
%% revision of the resource-based policy to add the permissions to.
%% The response contains the profiling group's JSON-formatted resource %% policy.
put_permission(Client, ActionGroup, ProfilingGroupName, Input) -> put_permission(Client, ActionGroup, ProfilingGroupName, Input, []). put_permission(Client, ActionGroup, ProfilingGroupName, Input0, Options0) -> Method = put, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/policy/", aws_util:encode_uri(ActionGroup), ""], 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 Remove one anomaly notifications channel for a profiling group. remove_notification_channel(Client, ChannelId, ProfilingGroupName, Input) -> remove_notification_channel(Client, ChannelId, ProfilingGroupName, Input, []). remove_notification_channel(Client, ChannelId, ProfilingGroupName, Input0, Options0) -> Method = delete, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/notificationConfiguration/", aws_util:encode_uri(ChannelId), ""], 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 permissions from a profiling group's resource-based policy %% that are provided using an action group. %% %% The one supported action group that can be removed is `agentPermission' %% which grants `ConfigureAgent' and `PostAgent' permissions. For more %% information, see Resource-based policies in CodeGuru Profiler in the %% Amazon CodeGuru Profiler User Guide, `ConfigureAgent' , and %% `PostAgentProfile' . remove_permission(Client, ActionGroup, ProfilingGroupName, Input) -> remove_permission(Client, ActionGroup, ProfilingGroupName, Input, []). remove_permission(Client, ActionGroup, ProfilingGroupName, Input0, Options0) -> Method = delete, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/policy/", aws_util:encode_uri(ActionGroup), ""], SuccessStatusCode = 200, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, QueryMapping = [ {<<"revisionId">>, <<"revisionId">>} ], {Query_, Input} = aws_request:build_headers(QueryMapping, Input1), request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Sends feedback to CodeGuru Profiler about whether the anomaly %% detected by the analysis is useful or not. submit_feedback(Client, AnomalyInstanceId, ProfilingGroupName, Input) -> submit_feedback(Client, AnomalyInstanceId, ProfilingGroupName, Input, []). submit_feedback(Client, AnomalyInstanceId, ProfilingGroupName, Input0, Options0) -> Method = post, Path = ["/internal/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), "/anomalies/", aws_util:encode_uri(AnomalyInstanceId), "/feedback"], SuccessStatusCode = 204, 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 Use to assign one or more tags to a resource. tag_resource(Client, ResourceArn, Input) -> tag_resource(Client, ResourceArn, Input, []). tag_resource(Client, ResourceArn, Input0, Options0) -> Method = post, Path = ["/tags/", aws_util:encode_uri(ResourceArn), ""], SuccessStatusCode = 204, 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 Use to remove one or more tags from a resource. untag_resource(Client, ResourceArn, Input) -> untag_resource(Client, ResourceArn, Input, []). untag_resource(Client, ResourceArn, Input0, Options0) -> Method = delete, Path = ["/tags/", aws_util:encode_uri(ResourceArn), ""], SuccessStatusCode = 204, Options = [{send_body_as_binary, false}, {receive_body_as_binary, false} | Options0], Headers = [], Input1 = Input0, QueryMapping = [ {<<"tagKeys">>, <<"tagKeys">>} ], {Query_, Input} = aws_request:build_headers(QueryMapping, Input1), request(Client, Method, Path, Query_, Headers, Input, Options, SuccessStatusCode). %% @doc Updates a profiling group. update_profiling_group(Client, ProfilingGroupName, Input) -> update_profiling_group(Client, ProfilingGroupName, Input, []). update_profiling_group(Client, ProfilingGroupName, Input0, Options0) -> Method = put, Path = ["/profilingGroups/", aws_util:encode_uri(ProfilingGroupName), ""], 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 => <<"codeguru-profiler">>}, Host = build_host(<<"codeguru-profiler">>, 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).