AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeGuruProfiler::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon CodeGuru Profiler. To construct a client, you need to configure a :region and :credentials.

codeguruprofiler = Aws::CodeGuruProfiler::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::CodeGuruProfiler::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::CodeGuruProfiler::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#add_notification_channels(options = {}) ⇒ Types::AddNotificationChannelsResponse

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

Examples:

Request syntax with placeholder values


resp = client.add_notification_channels({
  channels: [ # required
    {
      event_publishers: ["AnomalyDetection"], # required, accepts AnomalyDetection
      id: "ChannelId",
      uri: "ChannelUri", # required
    },
  ],
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.notification_configuration.channels #=> Array
resp.notification_configuration.channels[0].event_publishers #=> Array
resp.notification_configuration.channels[0].event_publishers[0] #=> String, one of "AnomalyDetection"
resp.notification_configuration.channels[0].id #=> String
resp.notification_configuration.channels[0].uri #=> String

Options Hash (options):

  • :channels (required, Array<Types::Channel>)

    One or 2 channels to report to when anomalies are detected.

  • :profiling_group_name (required, String)

    The name of the profiling group that we are setting up notifications for.

Returns:

See Also:

#batch_get_frame_metric_data(options = {}) ⇒ Types::BatchGetFrameMetricDataResponse

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

Examples:

Request syntax with placeholder values


resp = client.batch_get_frame_metric_data({
  end_time: Time.now,
  frame_metrics: [
    {
      frame_name: "String", # required
      thread_states: ["String"], # required
      type: "AggregatedRelativeTotalTime", # required, accepts AggregatedRelativeTotalTime
    },
  ],
  period: "Period",
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now,
  target_resolution: "P1D", # accepts P1D, PT1H, PT5M
})

Response structure


resp.end_time #=> Time
resp.end_times #=> Array
resp.end_times[0].value #=> Time
resp.frame_metric_data #=> Array
resp.frame_metric_data[0].frame_metric.frame_name #=> String
resp.frame_metric_data[0].frame_metric.thread_states #=> Array
resp.frame_metric_data[0].frame_metric.thread_states[0] #=> String
resp.frame_metric_data[0].frame_metric.type #=> String, one of "AggregatedRelativeTotalTime"
resp.frame_metric_data[0].values #=> Array
resp.frame_metric_data[0].values[0] #=> Float
resp.resolution #=> String, one of "P1D", "PT1H", "PT5M"
resp.start_time #=> Time
resp.unprocessed_end_times #=> Hash
resp.unprocessed_end_times["String"] #=> Array
resp.unprocessed_end_times["String"][0].value #=> Time

Options Hash (options):

  • :end_time (Time)

    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.

  • :frame_metrics (Array<Types::FrameMetric>)

    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 (String)

    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).

  • :profiling_group_name (required, String)

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

  • :start_time (Time)

    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.

  • :target_resolution (String)

    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

Returns:

See Also:

#configure_agent(options = {}) ⇒ Types::ConfigureAgentResponse

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.

Examples:

Request syntax with placeholder values


resp = client.configure_agent({
  fleet_instance_id: "FleetInstanceId",
  metadata: {
    "AgentId" => "String",
  },
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.configuration.agent_parameters #=> Hash
resp.configuration.agent_parameters["AgentParameterField"] #=> String
resp.configuration.period_in_seconds #=> Integer
resp.configuration.should_profile #=> true/false

Options Hash (options):

  • :fleet_instance_id (String)

    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 (Hash<String,String>)

    Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

    • COMPUTE_PLATFORM - The compute platform on which the agent is running

    • AGENT_ID - The ID for an agent instance.

    • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

    • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

    • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

    • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

    • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

    • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

    • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

  • :profiling_group_name (required, String)

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

Returns:

See Also:

#create_profiling_group(options = {}) ⇒ Types::CreateProfilingGroupResponse

Creates a profiling group.

Examples:

Request syntax with placeholder values


resp = client.create_profiling_group({
  agent_orchestration_config: {
    profiling_enabled: false, # required
  },
  client_token: "ClientToken", # required
  compute_platform: "AWSLambda", # accepts AWSLambda, Default
  profiling_group_name: "ProfilingGroupName", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.profiling_group.agent_orchestration_config.profiling_enabled #=> true/false
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "AWSLambda", "Default"
resp.profiling_group.created_at #=> Time
resp.profiling_group.name #=> String
resp.profiling_group.profiling_status.latest_agent_orchestrated_at #=> Time
resp.profiling_group.profiling_status.latest_agent_profile_reported_at #=> Time
resp.profiling_group.profiling_status.latest_aggregated_profile.period #=> String, one of "P1D", "PT1H", "PT5M"
resp.profiling_group.profiling_status.latest_aggregated_profile.start #=> Time
resp.profiling_group.tags #=> Hash
resp.profiling_group.tags["String"] #=> String
resp.profiling_group.updated_at #=> Time

Options Hash (options):

  • :agent_orchestration_config (Types::AgentOrchestrationConfig)

    Specifies whether profiling is enabled or disabled for the created profiling group.

  • :client_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

  • :compute_platform (String)

    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.

  • :profiling_group_name (required, String)

    The name of the profiling group to create.

  • :tags (Hash<String,String>)

    A list of tags to add to the created profiling group.

Returns:

See Also:

#delete_profiling_group(options = {}) ⇒ Struct

Deletes a profiling group.

Examples:

Request syntax with placeholder values


resp = client.delete_profiling_group({
  profiling_group_name: "ProfilingGroupName", # required
})

Options Hash (options):

  • :profiling_group_name (required, String)

    The name of the profiling group to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_profiling_group(options = {}) ⇒ Types::DescribeProfilingGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_profiling_group({
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.profiling_group.agent_orchestration_config.profiling_enabled #=> true/false
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "AWSLambda", "Default"
resp.profiling_group.created_at #=> Time
resp.profiling_group.name #=> String
resp.profiling_group.profiling_status.latest_agent_orchestrated_at #=> Time
resp.profiling_group.profiling_status.latest_agent_profile_reported_at #=> Time
resp.profiling_group.profiling_status.latest_aggregated_profile.period #=> String, one of "P1D", "PT1H", "PT5M"
resp.profiling_group.profiling_status.latest_aggregated_profile.start #=> Time
resp.profiling_group.tags #=> Hash
resp.profiling_group.tags["String"] #=> String
resp.profiling_group.updated_at #=> Time

Options Hash (options):

  • :profiling_group_name (required, String)

    The name of the profiling group to get information about.

Returns:

See Also:

#get_findings_report_account_summary(options = {}) ⇒ Types::GetFindingsReportAccountSummaryResponse

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

Examples:

Request syntax with placeholder values


resp = client.({
  daily_reports_only: false,
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.report_summaries #=> Array
resp.report_summaries[0].id #=> String
resp.report_summaries[0].profile_end_time #=> Time
resp.report_summaries[0].profile_start_time #=> Time
resp.report_summaries[0].profiling_group_name #=> String
resp.report_summaries[0].total_number_of_findings #=> Integer

Options Hash (options):

  • :daily_reports_only (Boolean)

    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).

  • :max_results (Integer)

    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.

  • :next_token (String)

    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.

Returns:

See Also:

#get_notification_configuration(options = {}) ⇒ Types::GetNotificationConfigurationResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_notification_configuration({
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.notification_configuration.channels #=> Array
resp.notification_configuration.channels[0].event_publishers #=> Array
resp.notification_configuration.channels[0].event_publishers[0] #=> String, one of "AnomalyDetection"
resp.notification_configuration.channels[0].id #=> String
resp.notification_configuration.channels[0].uri #=> String

Options Hash (options):

  • :profiling_group_name (required, String)

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

Returns:

See Also:

#get_policy(options = {}) ⇒ Types::GetPolicyResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Options Hash (options):

  • :profiling_group_name (required, String)

    The name of the profiling group.

Returns:

See Also:

#get_profile(options = {}) ⇒ Types::GetProfileResponse

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="<a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html&quot;&gt;">https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html&quot;&gt;</a> <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="<a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html&quot;&gt;">https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html&quot;&gt;</a> <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> 

Examples:

Request syntax with placeholder values


resp = client.get_profile({
  accept: "String",
  end_time: Time.now,
  max_depth: 1,
  period: "Period",
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now,
})

Response structure


resp.content_encoding #=> String
resp.content_type #=> String
resp.profile #=> IO

Options Hash (options):

  • :accept (String)

    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>
    
  • :end_time (Time)

    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.

  • :max_depth (Integer)

    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 (String)

    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>
    
  • :profiling_group_name (required, String)

    The name of the profiling group to get.

  • :start_time (Time)

    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>
    

Returns:

See Also:

#get_recommendations(options = {}) ⇒ Types::GetRecommendationsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_recommendations({
  end_time: Time.now, # required
  locale: "Locale",
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now, # required
})

Response structure


resp.anomalies #=> Array
resp.anomalies[0].instances #=> Array
resp.anomalies[0].instances[0].end_time #=> Time
resp.anomalies[0].instances[0].id #=> String
resp.anomalies[0].instances[0].start_time #=> Time
resp.anomalies[0].instances[0].user_feedback.type #=> String, one of "Negative", "Positive"
resp.anomalies[0].metric.frame_name #=> String
resp.anomalies[0].metric.thread_states #=> Array
resp.anomalies[0].metric.thread_states[0] #=> String
resp.anomalies[0].metric.type #=> String, one of "AggregatedRelativeTotalTime"
resp.anomalies[0].reason #=> String
resp.profile_end_time #=> Time
resp.profile_start_time #=> Time
resp.profiling_group_name #=> String
resp.recommendations #=> Array
resp.recommendations[0].all_matches_count #=> Integer
resp.recommendations[0].all_matches_sum #=> Float
resp.recommendations[0].end_time #=> Time
resp.recommendations[0].pattern.counters_to_aggregate #=> Array
resp.recommendations[0].pattern.counters_to_aggregate[0] #=> String
resp.recommendations[0].pattern.description #=> String
resp.recommendations[0].pattern.id #=> String
resp.recommendations[0].pattern.name #=> String
resp.recommendations[0].pattern.resolution_steps #=> String
resp.recommendations[0].pattern.target_frames #=> Array
resp.recommendations[0].pattern.target_frames[0] #=> Array
resp.recommendations[0].pattern.target_frames[0][0] #=> String
resp.recommendations[0].pattern.threshold_percent #=> Float
resp.recommendations[0].start_time #=> Time
resp.recommendations[0].top_matches #=> Array
resp.recommendations[0].top_matches[0].frame_address #=> String
resp.recommendations[0].top_matches[0].target_frames_index #=> Integer
resp.recommendations[0].top_matches[0].threshold_breach_value #=> Float

Options Hash (options):

  • :end_time (required, 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.

  • :locale (String)

    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

  • :profiling_group_name (required, String)

    The name of the profiling group to get analysis data about.

  • :start_time (required, 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.

Returns:

See Also:

#list_findings_reports(options = {}) ⇒ Types::ListFindingsReportsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_findings_reports({
  daily_reports_only: false,
  end_time: Time.now, # required
  max_results: 1,
  next_token: "PaginationToken",
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now, # required
})

Response structure


resp.findings_report_summaries #=> Array
resp.findings_report_summaries[0].id #=> String
resp.findings_report_summaries[0].profile_end_time #=> Time
resp.findings_report_summaries[0].profile_start_time #=> Time
resp.findings_report_summaries[0].profiling_group_name #=> String
resp.findings_report_summaries[0].total_number_of_findings #=> Integer
resp.next_token #=> String

Options Hash (options):

  • :daily_reports_only (Boolean)

    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).

  • :end_time (required, 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.

  • :max_results (Integer)

    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.

  • :next_token (String)

    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.

  • :profiling_group_name (required, String)

    The name of the profiling group from which to search for analysis data.

  • :start_time (required, 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.

Returns:

See Also:

#list_profile_times(options = {}) ⇒ Types::ListProfileTimesResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_profile_times({
  end_time: Time.now, # required
  max_results: 1,
  next_token: "PaginationToken",
  order_by: "TimestampAscending", # accepts TimestampAscending, TimestampDescending
  period: "P1D", # required, accepts P1D, PT1H, PT5M
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now, # required
})

Response structure


resp.next_token #=> String
resp.profile_times #=> Array
resp.profile_times[0].start #=> Time

Options Hash (options):

  • :end_time (required, Time)

    The end time of the time range from which to list the profiles.

  • :max_results (Integer)

    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.

  • :next_token (String)

    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.

  • :order_by (String)

    The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

  • :period (required, String)

    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 (required, String)

    The name of the profiling group.

  • :start_time (required, Time)

    The start time of the time range from which to list the profiles.

Returns:

See Also:

#list_profiling_groups(options = {}) ⇒ Types::ListProfilingGroupsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_profiling_groups({
  include_description: false,
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.profiling_group_names #=> Array
resp.profiling_group_names[0] #=> String
resp.profiling_groups #=> Array
resp.profiling_groups[0].agent_orchestration_config.profiling_enabled #=> true/false
resp.profiling_groups[0].arn #=> String
resp.profiling_groups[0].compute_platform #=> String, one of "AWSLambda", "Default"
resp.profiling_groups[0].created_at #=> Time
resp.profiling_groups[0].name #=> String
resp.profiling_groups[0].profiling_status.latest_agent_orchestrated_at #=> Time
resp.profiling_groups[0].profiling_status.latest_agent_profile_reported_at #=> Time
resp.profiling_groups[0].profiling_status.latest_aggregated_profile.period #=> String, one of "P1D", "PT1H", "PT5M"
resp.profiling_groups[0].profiling_status.latest_aggregated_profile.start #=> Time
resp.profiling_groups[0].tags #=> Hash
resp.profiling_groups[0].tags["String"] #=> String
resp.profiling_groups[0].updated_at #=> Time

Options Hash (options):

  • :include_description (Boolean)

    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.

  • :max_results (Integer)

    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.

  • :next_token (String)

    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.

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ProfilingGroupArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :resource_arn (required, String)

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

Returns:

See Also:

#post_agent_profile(options = {}) ⇒ Struct

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 .

Examples:

Request syntax with placeholder values


resp = client.post_agent_profile({
  agent_profile: "data", # required
  content_type: "String", # required
  profile_token: "ClientToken",
  profiling_group_name: "ProfilingGroupName", # required
})

Options Hash (options):

  • :agent_profile (required, IO, String)

    The submitted profiling data.

  • :content_type (required, String)

    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>
    
  • :profile_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries.

  • :profiling_group_name (required, String)

    The name of the profiling group with the aggregated profile that receives the submitted profiling data.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_permission(options = {}) ⇒ Types::PutPermissionResponse

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="<a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html&quot;&gt;Resource-based">https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html&quot;&gt;Resource-based</a> policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="<a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html&quot;&gt;">https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html&quot;&gt;</a> <code>ConfigureAgent</code> </a>, and <a href="<a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html&quot;&gt;">https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html&quot;&gt;</a> <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> 

Examples:

Request syntax with placeholder values


resp = client.put_permission({
  action_group: "agentPermissions", # required, accepts agentPermissions
  principals: ["Principal"], # required
  profiling_group_name: "ProfilingGroupName", # required
  revision_id: "RevisionId",
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Options Hash (options):

  • :action_group (required, String)

    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 (required, Array<String>)

    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 (required, String)

    The name of the profiling group to grant access to.

  • :revision_id (String)

    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.

Returns:

See Also:

#remove_notification_channel(options = {}) ⇒ Types::RemoveNotificationChannelResponse

Remove one anomaly notifications channel for a profiling group.

Examples:

Request syntax with placeholder values


resp = client.remove_notification_channel({
  channel_id: "ChannelId", # required
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.notification_configuration.channels #=> Array
resp.notification_configuration.channels[0].event_publishers #=> Array
resp.notification_configuration.channels[0].event_publishers[0] #=> String, one of "AnomalyDetection"
resp.notification_configuration.channels[0].id #=> String
resp.notification_configuration.channels[0].uri #=> String

Options Hash (options):

  • :channel_id (required, String)

    The id of the channel that we want to stop receiving notifications.

  • :profiling_group_name (required, String)

    The name of the profiling group we want to change notification configuration for.

Returns:

See Also:

#remove_permission(options = {}) ⇒ Types::RemovePermissionResponse

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 .

Examples:

Request syntax with placeholder values


resp = client.remove_permission({
  action_group: "agentPermissions", # required, accepts agentPermissions
  profiling_group_name: "ProfilingGroupName", # required
  revision_id: "RevisionId", # required
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Options Hash (options):

  • :action_group (required, String)

    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 (required, String)

    The name of the profiling group.

  • :revision_id (required, String)

    A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions.

Returns:

See Also:

#submit_feedback(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.submit_feedback({
  anomaly_instance_id: "AnomalyInstanceId", # required
  comment: "String",
  profiling_group_name: "ProfilingGroupName", # required
  type: "Negative", # required, accepts Negative, Positive
})

Options Hash (options):

  • :anomaly_instance_id (required, String)

    The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.

  • :comment (String)

    Optional feedback about this anomaly.

  • :profiling_group_name (required, String)

    The name of the profiling group that is associated with the analysis data.

  • :type (required, String)

    The feedback tpye. Thee are two valid values, Positive and Negative.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#tag_resource(options = {}) ⇒ Struct

Use to assign one or more tags to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ProfilingGroupArn", # required
  tags: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that the tags are added to.

  • :tags (required, Hash<String,String>)

    The list of tags that are added to the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Use to remove one or more tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ProfilingGroupArn", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that contains the tags to remove.

  • :tag_keys (required, Array<String>)

    A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_profiling_group(options = {}) ⇒ Types::UpdateProfilingGroupResponse

Updates a profiling group.

Examples:

Request syntax with placeholder values


resp = client.update_profiling_group({
  agent_orchestration_config: { # required
    profiling_enabled: false, # required
  },
  profiling_group_name: "ProfilingGroupName", # required
})

Response structure


resp.profiling_group.agent_orchestration_config.profiling_enabled #=> true/false
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "AWSLambda", "Default"
resp.profiling_group.created_at #=> Time
resp.profiling_group.name #=> String
resp.profiling_group.profiling_status.latest_agent_orchestrated_at #=> Time
resp.profiling_group.profiling_status.latest_agent_profile_reported_at #=> Time
resp.profiling_group.profiling_status.latest_aggregated_profile.period #=> String, one of "P1D", "PT1H", "PT5M"
resp.profiling_group.profiling_status.latest_aggregated_profile.start #=> Time
resp.profiling_group.tags #=> Hash
resp.profiling_group.tags["String"] #=> String
resp.profiling_group.updated_at #=> Time

Options Hash (options):

  • :agent_orchestration_config (required, Types::AgentOrchestrationConfig)

    Specifies whether profiling is enabled or disabled for a profiling group.

  • :profiling_group_name (required, String)

    The name of the profiling group to update.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.