Codeguruprofiler

add_notification_channels(channels, profiling_group_name)
add_notification_channels(channels, profiling_group_name, params::Dict{String,<:Any})

Add up to 2 anomaly notifications channels for a profiling group.

Arguments

• channels: One or 2 channels to report to when anomalies are detected.
• profiling_group_name: The name of the profiling group that we are setting up notifications for.

batch_get_frame_metric_data(profiling_group_name)
batch_get_frame_metric_data(profiling_group_name, params::Dict{String,<:Any})

Returns the time series of values for a requested list of frame metrics from a time period.

Arguments

• profiling_group_name: The name of the profiling group associated with the the frame metrics used to return the time series values.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endTime": The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
• "frameMetrics": The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
• "period": The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).
• "startTime": The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
• "targetResolution": The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes

configure_agent(profiling_group_name)
configure_agent(profiling_group_name, params::Dict{String,<:Any})

Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return profiling data.

Arguments

• profiling_group_name: The name of the profiling group for which the configured agent is collecting profiling data.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "fleetInstanceId": A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.
• "metadata": Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are: COMPUTEPLATFORM - The compute platform on which the agent is running AGENTID - The ID for an agent instance. AWSREQUESTID - The AWS request ID of a Lambda invocation. EXECUTIONENVIRONMENT - The execution environment a Lambda function is running on. LAMBDAFUNCTIONARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function. LAMBDAMEMORYLIMITINMB - The memory allocated to a Lambda function. LAMBDAREMAININGTIMEINMILLISECONDS - The time in milliseconds before execution of a Lambda function times out. LAMBDATIMEGAPBETWEENINVOKESINMILLISECONDS - The time in milliseconds between two invocations of a Lambda function. LAMBDAPREVIOUSEXECUTIONTIMEINMILLISECONDS - The time in milliseconds for the previous Lambda invocation.

create_profiling_group(client_token, profiling_group_name)
create_profiling_group(client_token, profiling_group_name, params::Dict{String,<:Any})

Creates a profiling group.

Arguments

• client_token: Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.
• profiling_group_name: The name of the profiling group to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "agentOrchestrationConfig": Specifies whether profiling is enabled or disabled for the created profiling group.
• "computePlatform": The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.
• "tags": A list of tags to add to the created profiling group.

delete_profiling_group(profiling_group_name)
delete_profiling_group(profiling_group_name, params::Dict{String,<:Any})

Deletes a profiling group.

Arguments

• profiling_group_name: The name of the profiling group to delete.

describe_profiling_group(profiling_group_name)
describe_profiling_group(profiling_group_name, params::Dict{String,<:Any})

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Arguments

• profiling_group_name: The name of the profiling group to get information about.

get_findings_report_account_summary()
get_findings_report_account_summary(params::Dict{String,<:Any})

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dailyReportsOnly": A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).
• "maxResults": The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.
• "nextToken": The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

get_notification_configuration(profiling_group_name)
get_notification_configuration(profiling_group_name, params::Dict{String,<:Any})

Get the current configuration for anomaly notifications for a profiling group.

Arguments

• profiling_group_name: The name of the profiling group we want to get the notification configuration for.

get_policy(profiling_group_name)
get_policy(profiling_group_name, params::Dict{String,<:Any})

Returns the JSON-formatted resource-based policy on a profiling group.

Arguments

• profiling_group_name: The name of the profiling group.

get_profile(profiling_group_name)
get_profile(profiling_group_name, params::Dict{String,<:Any})

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. <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> 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 <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/APIAggregatedProfileTim e.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/APIListProfileTimes.htm l"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> 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. </p> <p> 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. </p> </li> </ol>

Arguments

• profiling_group_name: The name of the profiling group to get.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Accept": The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
• "endTime": The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. If you specify endTime, then you must also specify period or startTime, but not both.
• "maxDepth": The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.
• "period": Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
• "startTime": The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>

get_recommendations(end_time, profiling_group_name, start_time)
get_recommendations(end_time, profiling_group_name, start_time, params::Dict{String,<:Any})

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Arguments

• end_time: The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
• profiling_group_name: The name of the profiling group to get analysis data about.
• start_time: The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "locale": The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes. de-DE - German, Germany en-GB - English, United Kingdom en-US - English, United States es-ES - Spanish, Spain fr-FR - French, France it-IT - Italian, Italy ja-JP - Japanese, Japan ko-KR - Korean, Republic of Korea pt-BR - Portugese, Brazil zh-CN - Chinese, China zh-TW - Chinese, Taiwan

list_findings_reports(end_time, profiling_group_name, start_time)
list_findings_reports(end_time, profiling_group_name, start_time, params::Dict{String,<:Any})

List the available reports for a given profiling group and time range.

Arguments

• end_time: The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
• profiling_group_name: The name of the profiling group from which to search for analysis data.
• start_time: The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "dailyReportsOnly": A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).
• "maxResults": The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.
• "nextToken": The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

list_profile_times(end_time, period, profiling_group_name, start_time)
list_profile_times(end_time, period, profiling_group_name, start_time, params::Dict{String,<:Any})

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Arguments

• end_time: The end time of the time range from which to list the profiles.
• period: The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes
• profiling_group_name: The name of the profiling group.
• start_time: The start time of the time range from which to list the profiles.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.
• "nextToken": The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
• "orderBy": The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

list_profiling_groups()
list_profiling_groups(params::Dict{String,<:Any})

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "includeDescription": A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.
• "maxResults": The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.
• "nextToken": The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Returns a list of the tags that are assigned to a specified resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource that contains the tags to return.

post_agent_profile(content-_type, agent_profile, profiling_group_name)
post_agent_profile(content-_type, agent_profile, profiling_group_name, params::Dict{String,<:Any})

Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .

Arguments

• content-_type: The format of the submitted profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
• agent_profile: The submitted profiling data.
• profiling_group_name: The name of the profiling group with the aggregated profile that receives the submitted profiling data.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "profileToken": Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries.

put_permission(action_group, principals, profiling_group_name)
put_permission(action_group, principals, profiling_group_name, params::Dict{String,<:Any})

Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter. <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.h tml">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/APIConfigureAgent.html "> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/APIPostAgentProfile.htm l"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p>

Arguments

• action_group: Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.
• principals: A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.
• profiling_group_name: The name of the profiling group to grant access to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "revisionId": A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

remove_notification_channel(channel_id, profiling_group_name)
remove_notification_channel(channel_id, profiling_group_name, params::Dict{String,<:Any})

Remove one anomaly notifications channel for a profiling group.

Arguments

• channel_id: The id of the channel that we want to stop receiving notifications.
• profiling_group_name: The name of the profiling group we want to change notification configuration for.

remove_permission(action_group, profiling_group_name, revision_id)
remove_permission(action_group, profiling_group_name, revision_id, params::Dict{String,<:Any})

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 .

Arguments

• action_group: Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions.
• profiling_group_name: The name of the profiling group.
• revision_id: A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions.

submit_feedback(anomaly_instance_id, profiling_group_name, type)
submit_feedback(anomaly_instance_id, profiling_group_name, type, params::Dict{String,<:Any})

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

Arguments

• anomaly_instance_id: The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.
• profiling_group_name: The name of the profiling group that is associated with the analysis data.
• type: The feedback tpye. Thee are two valid values, Positive and Negative.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "comment": Optional feedback about this anomaly.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Use to assign one or more tags to a resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource that the tags are added to.
• tags: The list of tags that are added to the specified resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Use to remove one or more tags from a resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource that contains the tags to remove.
• tag_keys: A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource.

update_profiling_group(agent_orchestration_config, profiling_group_name)
update_profiling_group(agent_orchestration_config, profiling_group_name, params::Dict{String,<:Any})

Updates a profiling group.

Arguments

• agent_orchestration_config: Specifies whether profiling is enabled or disabled for a profiling group.
• profiling_group_name: The name of the profiling group to update.