Class: Aws::CodeGuruProfiler::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/aws-sdk-codeguruprofiler/client.rb,
sig/client.rbs

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Defined Under Namespace

Modules: _AddNotificationChannelsResponseSuccess, _BatchGetFrameMetricDataResponseSuccess, _ConfigureAgentResponseSuccess, _CreateProfilingGroupResponseSuccess, _DeleteProfilingGroupResponseSuccess, _DescribeProfilingGroupResponseSuccess, _GetFindingsReportAccountSummaryResponseSuccess, _GetNotificationConfigurationResponseSuccess, _GetPolicyResponseSuccess, _GetProfileResponseSuccess, _GetRecommendationsResponseSuccess, _ListFindingsReportsResponseSuccess, _ListProfileTimesResponseSuccess, _ListProfilingGroupsResponseSuccess, _ListTagsForResourceResponseSuccess, _PostAgentProfileResponseSuccess, _PutPermissionResponseSuccess, _RemoveNotificationChannelResponseSuccess, _RemovePermissionResponseSuccess, _SubmitFeedbackResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateProfilingGroupResponseSuccess

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CodeGuruProfiler::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CodeGuruProfiler::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-codeguruprofiler/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1801
1802
1803
 
# File 'lib/aws-sdk-codeguruprofiler/client.rb', line 1801

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1804
1805
1806
 
# File 'lib/aws-sdk-codeguruprofiler/client.rb', line 1804

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CodeGuruProfiler/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#add_notification_channels(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



86
 
# File 'sig/client.rbs', line 86

def add_notification_channels: (

#batch_get_frame_metric_data(params = {}) ⇒ 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: "PT5M", # accepts PT5M, PT1H, P1D
})

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 "PT5M", "PT1H", "P1D"
resp.start_time #=> Time
resp.unprocessed_end_times #=> Hash
resp.unprocessed_end_times["String"] #=> Array
resp.unprocessed_end_times["String"][0].value #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :end_time (Time, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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:



108
 
# File 'sig/client.rbs', line 108

def batch_get_frame_metric_data: (

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/aws-sdk-codeguruprofiler/client.rb', line 1774

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CodeGuruProfiler')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-codeguruprofiler'
  context[:gem_version] = '1.71.0'
  Seahorse::Client::Request.new(handlers, context)
end

#configure_agent(params = {}) ⇒ 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 an 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: {
    "ComputePlatform" => "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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :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:



129
 
# File 'sig/client.rbs', line 129

def configure_agent: (

#create_profiling_group(params = {}) ⇒ 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: "Default", # accepts Default, AWSLambda
  profiling_group_name: "ProfilingGroupName", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.profiling_group.agent_orchestration_config.profiling_enabled #=> Boolean
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "Default", "AWSLambda"
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 "PT5M", "PT1H", "P1D"
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

Parameters:

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

    ({})

Options Hash (params):

  • :agent_orchestration_config (Types::AgentOrchestrationConfig) —

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

  • :client_token (required, String) —

    Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



141
 
# File 'sig/client.rbs', line 141

def create_profiling_group: (

#delete_profiling_group(params = {}) ⇒ Struct

Deletes a profiling group.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :profiling_group_name (required, String) —

    The name of the profiling group to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



156
 
# File 'sig/client.rbs', line 156

def delete_profiling_group: (

#describe_profiling_group(params = {}) ⇒ 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 #=> Boolean
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "Default", "AWSLambda"
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 "PT5M", "PT1H", "P1D"
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

Parameters:

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

    ({})

Options Hash (params):

  • :profiling_group_name (required, String) —

    The name of the profiling group to get information about.

Returns:

See Also:



166
 
# File 'sig/client.rbs', line 166

def describe_profiling_group: (

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



177
 
# File 'sig/client.rbs', line 177

def get_findings_report_account_summary: (

#get_notification_configuration(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :profiling_group_name (required, String) —

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

Returns:

See Also:



189
 
# File 'sig/client.rbs', line 189

def get_notification_configuration: (

#get_policy(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :profiling_group_name (required, String) —

    The name of the profiling group.

Returns:

See Also:



200
 
# File 'sig/client.rbs', line 200

def get_policy: (

#get_profile(params = {}) ⇒ 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="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.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/API_ListProfileTimes.html"> <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 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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:



212
 
# File 'sig/client.rbs', line 212

def get_profile: (

#get_recommendations(params = {}) ⇒ 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 "Positive", "Negative"
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

Parameters:

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

    ({})

Options Hash (params):

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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:



231
 
# File 'sig/client.rbs', line 231

def get_recommendations: (

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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:



245
 
# File 'sig/client.rbs', line 245

def list_findings_reports: (

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_profile_times({
  end_time: Time.now, # required
  max_results: 1,
  next_token: "PaginationToken",
  order_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
  period: "PT5M", # required, accepts PT5M, PT1H, P1D
  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

Parameters:

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

    ({})

Options Hash (params):

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

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

Returns:

See Also:



261
 
# File 'sig/client.rbs', line 261

def list_profile_times: (

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
resp.profiling_groups[0].arn #=> String
resp.profiling_groups[0].compute_platform #=> String, one of "Default", "AWSLambda"
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 "PT5M", "PT1H", "P1D"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



279
 
# File 'sig/client.rbs', line 279

def list_profiling_groups: (

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



291
 
# File 'sig/client.rbs', line 291

def list_tags_for_resource: (

#post_agent_profile(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :agent_profile (required, String, StringIO, File) —

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

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :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:



300
 
# File 'sig/client.rbs', line 300

def post_agent_profile: (

#put_permission(params = {}) ⇒ 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="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">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/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



314
 
# File 'sig/client.rbs', line 314

def put_permission: (

#remove_notification_channel(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



327
 
# File 'sig/client.rbs', line 327

def remove_notification_channel: (

#remove_permission(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



339
 
# File 'sig/client.rbs', line 339

def remove_permission: (

#submit_feedback(params = {}) ⇒ 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: "Positive", # required, accepts Positive, Negative
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



350
 
# File 'sig/client.rbs', line 350

def submit_feedback: (

#tag_resource(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



362
 
# File 'sig/client.rbs', line 362

def tag_resource: (

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



372
 
# File 'sig/client.rbs', line 372

def untag_resource: (

#update_profiling_group(params = {}) ⇒ 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 #=> Boolean
resp.profiling_group.arn #=> String
resp.profiling_group.compute_platform #=> String, one of "Default", "AWSLambda"
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 "PT5M", "PT1H", "P1D"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



383
 
# File 'sig/client.rbs', line 383

def update_profiling_group: (

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1794
1795
1796
 
# File 'lib/aws-sdk-codeguruprofiler/client.rb', line 1794

def waiter_names
  []
end