Client

codeguruprofiler

R Documentation

Amazon CodeGuru Profiler¶

Description¶

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 and Python. 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 and Python.

For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.

Usage¶

codeguruprofiler(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- codeguruprofiler(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

add_notification_channels: Add up to 2 anomaly notifications channels for a profiling group
batch_get_frame_metric_data: Returns the time series of values for a requested list of frame metrics from a time period
configure_agent: Used by profiler agents to report their current state and to receive remote configuration updates
create_profiling_group: Creates a profiling group
delete_profiling_group: Deletes a profiling group
describe_profiling_group: Returns a ProfilingGroupDescription object that contains information about the requested profiling group
get_findings_report_account_summary: Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account
get_notification_configuration: Get the current configuration for anomaly notifications for a profiling group
get_policy: Returns the JSON-formatted resource-based policy on a profiling group
get_profile: Gets the aggregated profile of a profiling group for a specified time range
get_recommendations: Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period
list_findings_reports: List the available reports for a given profiling group and time range
list_profile_times: Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range
list_profiling_groups: Returns a list of profiling groups
list_tags_for_resource: Returns a list of the tags that are assigned to a specified resource
post_agent_profile: Submits profiling data to an aggregated profile of a profiling group
put_permission: Adds permissions to a profiling group's resource-based policy that are provided using an action group
remove_notification_channel: Remove one anomaly notifications channel for a profiling group
remove_permission: Removes permissions from a profiling group's resource-based policy that are provided using an action group
submit_feedback: Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not
tag_resource: Use to assign one or more tags to a resource
untag_resource: Use to remove one or more tags from a resource
update_profiling_group: Updates a profiling group

Examples¶

## Not run: 
svc <- codeguruprofiler()
svc$add_notification_channels(
  Foo = 123
)

## End(Not run)