Class: AWS.CodeGuruProfiler

Inherits:
AWS.Service show all
Identifier:
codeguruprofiler
API Version:
2019-07-18
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This section provides documentation for the Amazon CodeGuru Profiler API operations.

 <p>Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. </p> <p>Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. </p> <note> <p>Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html&quot;&gt;What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p> 

Sending a Request Using CodeGuruProfiler

var codeguruprofiler = new AWS.CodeGuruProfiler();
codeguruprofiler.addNotificationChannels(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeGuruProfiler object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codeguruprofiler = new AWS.CodeGuruProfiler({apiVersion: '2019-07-18'});

You can also set the API version globally in AWS.config.apiVersions using the codeguruprofiler service identifier:

AWS.config.apiVersions = {
  codeguruprofiler: '2019-07-18',
  // other service API versions
};

var codeguruprofiler = new AWS.CodeGuruProfiler();

Version:

  • 2019-07-18

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeGuruProfiler(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodeGuruProfiler object

var codeguruprofiler = new AWS.CodeGuruProfiler({apiVersion: '2019-07-18'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CodeGuruProfiler.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CodeGuruProfiler.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CodeGuruProfiler.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addNotificationChannels(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the addNotificationChannels operation

var params = {
  channels: [ /* required */
    {
      eventPublishers: [ /* required */
        AnomalyDetection,
        /* more items */
      ],
      uri: 'STRING_VALUE', /* required */
      id: 'STRING_VALUE'
    },
    /* more items */
  ],
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.addNotificationChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channels — (Array<map>)

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

      • eventPublishersrequired — (Array<String>)

        List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

      • id — (String)

        Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

      • urirequired — (String)

        Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

    • profilingGroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • notificationConfiguration — (map)

        The new notification configuration for this profiling group.

        • channels — (Array<map>)

          List of up to two channels to be used for sending notifications for events detected from the application profile.

          • eventPublishersrequired — (Array<String>)

            List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

          • id — (String)

            Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

          • urirequired — (String)

            Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchGetFrameMetricData(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the batchGetFrameMetricData operation

var params = {
  profilingGroupName: 'STRING_VALUE', /* required */
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  frameMetrics: [
    {
      frameName: 'STRING_VALUE', /* required */
      threadStates: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      type: AggregatedRelativeTotalTime /* required */
    },
    /* more items */
  ],
  period: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  targetResolution: P1D | PT1H | PT5M
};
codeguruprofiler.batchGetFrameMetricData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endTime — (Date)

      The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

    • frameMetrics — (Array<map>)

      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.

      • frameNamerequired — (String)

        Name of the method common across the multiple occurrences of a frame in an application profile.

      • threadStatesrequired — (Array<String>)

        List of application runtime thread states used to get the counts for a frame a derive a metric value.

      • typerequired — (String)

        A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile.

        Possible values include:
        • "AggregatedRelativeTotalTime"
    • 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).

    • profilingGroupName — (String)

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

    • startTime — (Date)

      The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

    • targetResolution — (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

      Possible values include:
      • "P1D"
      • "PT1H"
      • "PT5M"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endTime — (Date)

        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.

      • endTimes — (Array<map>)

        List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

        • valuerequired — (Date)

          A Timestamp. 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.

      • frameMetricData — (Array<map>)

        Details of the metrics 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.

        • frameMetricrequired — (map)

          The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

          • frameNamerequired — (String)

            Name of the method common across the multiple occurrences of a frame in an application profile.

          • threadStatesrequired — (Array<String>)

            List of application runtime thread states used to get the counts for a frame a derive a metric value.

          • typerequired — (String)

            A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile.

            Possible values include:
            • "AggregatedRelativeTotalTime"
        • valuesrequired — (Array<Float>)

          A list of values that are associated with a frame metric.

      • resolution — (String)

        Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

        • P1D — 1 day

        • PT1H — 1 hour

        • PT5M — 5 minutes

        Possible values include:
        • "P1D"
        • "PT1H"
        • "PT5M"
      • startTime — (Date)

        The start 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.

      • unprocessedEndTimes — (map<Array<map>>)

        List of instances which remained unprocessed. This will create a missing time step in the list of end times.

        • valuerequired — (Date)

          A Timestamp. 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:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

configureAgent(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the configureAgent operation

var params = {
  profilingGroupName: 'STRING_VALUE', /* required */
  fleetInstanceId: 'STRING_VALUE',
  metadata: {
    '<MetadataField>': 'STRING_VALUE',
    /* '<MetadataField>': ... */
  }
};
codeguruprofiler.configureAgent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • fleetInstanceId — (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 — (map<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.

    • profilingGroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • configuration — (map)

        An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.

        • agentParameters — (map<String>)

          Parameters used by the profiler. The valid parameters are:

          • MaxStackDepth - The maximum depth of the stacks in the code that is represented in the 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 profiler evaluates A and B.

          • MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

          • MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

          • ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

          • SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

        • periodInSecondsrequired — (Integer)

          How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period.

        • shouldProfilerequired — (Boolean)

          A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createProfilingGroup(params = {}, callback) ⇒ AWS.Request

Creates a profiling group.

Service Reference:

Examples:

Calling the createProfilingGroup operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  agentOrchestrationConfig: {
    profilingEnabled: true || false /* required */
  },
  computePlatform: AWSLambda | Default,
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
codeguruprofiler.createProfilingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • agentOrchestrationConfig — (map)

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

      • profilingEnabledrequired — (Boolean)

        A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

    • clientToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • computePlatform — (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.

      Possible values include:
      • "AWSLambda"
      • "Default"
    • profilingGroupName — (String)

      The name of the profiling group to create.

    • tags — (map<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • profilingGroup — (map)

        The returned ProfilingGroupDescription object that contains information about the created profiling group.

        • agentOrchestrationConfig — (map)

          An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

          • profilingEnabledrequired — (Boolean)

            A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

        • arn — (String)

          The Amazon Resource Name (ARN) identifying the profiling group resource.

        • computePlatform — (String)

          The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

          Possible values include:
          • "AWSLambda"
          • "Default"
        • createdAt — (Date)

          The time when the profiling group was created. 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.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

          • latestAgentOrchestratedAt — (Date)

            The date and time when the profiling agent most recently pinged back. 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.

          • latestAgentProfileReportedAt — (Date)

            The date and time when the most recent profile was received. 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.

          • latestAggregatedProfile — (map)

            An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

            • period — (String)

              The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

              • P1D — 1 day

              • PT1H — 1 hour

              • PT5M — 5 minutes

              Possible values include:
              • "P1D"
              • "PT1H"
              • "PT5M"
            • start — (Date)

              The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

              Specify start 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.

        • tags — (map<String>)

          A list of the tags that belong to this profiling group.

        • updatedAt — (Date)

          The date and time when the profiling group was last updated. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteProfilingGroup(params = {}, callback) ⇒ AWS.Request

Deletes a profiling group.

Service Reference:

Examples:

Calling the deleteProfilingGroup operation

var params = {
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.deleteProfilingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • profilingGroupName — (String)

      The name of the profiling group to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeProfilingGroup(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeProfilingGroup operation

var params = {
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.describeProfilingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • profilingGroupName — (String)

      The name of the profiling group to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • profilingGroup — (map)

        The returned ProfilingGroupDescription object that contains information about the requested profiling group.

        • agentOrchestrationConfig — (map)

          An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

          • profilingEnabledrequired — (Boolean)

            A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

        • arn — (String)

          The Amazon Resource Name (ARN) identifying the profiling group resource.

        • computePlatform — (String)

          The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

          Possible values include:
          • "AWSLambda"
          • "Default"
        • createdAt — (Date)

          The time when the profiling group was created. 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.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

          • latestAgentOrchestratedAt — (Date)

            The date and time when the profiling agent most recently pinged back. 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.

          • latestAgentProfileReportedAt — (Date)

            The date and time when the most recent profile was received. 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.

          • latestAggregatedProfile — (map)

            An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

            • period — (String)

              The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

              • P1D — 1 day

              • PT1H — 1 hour

              • PT5M — 5 minutes

              Possible values include:
              • "P1D"
              • "PT1H"
              • "PT5M"
            • start — (Date)

              The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

              Specify start 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.

        • tags — (map<String>)

          A list of the tags that belong to this profiling group.

        • updatedAt — (Date)

          The date and time when the profiling group was last updated. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFindingsReportAccountSummary(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getFindingsReportAccountSummary operation

var params = {
  dailyReportsOnly: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeguruprofiler.getFindingsReportAccountSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • dailyReportsOnly — (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).

    • maxResults — (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.

    • nextToken — (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.

      Note: 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

      • reportSummaries — (Array<map>)

        The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account.

        • id — (String)

          The universally unique identifier (UUID) of the recommendation report.

        • profileEndTime — (Date)

          The end time of the period during which the metric is flagged as anomalous. 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.

        • profileStartTime — (Date)

          The start time of the profile the analysis data is about. 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.

        • profilingGroupName — (String)

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

        • totalNumberOfFindings — (Integer)

          The total number of different recommendations that were found by the analysis.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getNotificationConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getNotificationConfiguration operation

var params = {
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.getNotificationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • profilingGroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • notificationConfiguration — (map)

        The current notification configuration for this profiling group.

        • channels — (Array<map>)

          List of up to two channels to be used for sending notifications for events detected from the application profile.

          • eventPublishersrequired — (Array<String>)

            List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

          • id — (String)

            Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

          • urirequired — (String)

            Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getPolicy operation

var params = {
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.getPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • profilingGroupName — (String)

      The name of the profiling group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (String)

        The JSON-formatted resource-based policy attached to the ProfilingGroup.

      • revisionId — (String)

        A unique identifier for the current revision of the returned policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProfile(params = {}, callback) ⇒ AWS.Request

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&#95;AggregatedProfileTime.html&quot;&gt; <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&#95;ListProfileTimes.html&quot;&gt; <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> 

Service Reference:

Examples:

Calling the getProfile operation

var params = {
  profilingGroupName: 'STRING_VALUE', /* required */
  accept: 'STRING_VALUE',
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxDepth: 'NUMBER_VALUE',
  period: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
codeguruprofiler.getProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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/&quot;&gt;Amazon Ion</a>. </p> </li> </ul> 
    • endTime — (Date)

      The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

      If you specify endTime, then you must also specify period or startTime, but not both.

    • maxDepth — (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> 
    • profilingGroupName — (String)

      The name of the profiling group to get.

    • startTime — (Date)

      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> 

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • contentEncoding — (String)

        The content encoding of the profile.

      • contentType — (String)

        The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.

      • profile — (Buffer(Node.js), Typed Array(Browser))

        Information about the profile.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecommendations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getRecommendations operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  locale: 'STRING_VALUE'
};
codeguruprofiler.getRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endTime — (Date)

      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

    • profilingGroupName — (String)

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

    • startTime — (Date)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • anomalies — (Array<map>)

        The list of anomalies that the analysis has found for this profile.

        • instancesrequired — (Array<map>)

          A list of the instances of the detected anomalies during the requested period.

          • endTime — (Date)

            The end time of the period during which the metric is flagged as anomalous. 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.

          • idrequired — (String)

            The universally unique identifier (UUID) of an instance of an anomaly in a metric.

          • startTimerequired — (Date)

            The start time of the period during which the metric is flagged as anomalous. 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.

          • userFeedback — (map)

            Feedback type on a specific instance of anomaly submitted by the user.

            • typerequired — (String)

              Optional Positive or Negative feedback submitted by the user about whether the recommendation is useful or not.

              Possible values include:
              • "Negative"
              • "Positive"
        • metricrequired — (map)

          Details about the metric that the analysis used when it detected the anomaly. The metric includes the name of the frame that was analyzed with the type and thread states used to derive the metric value for that frame.

          • frameNamerequired — (String)

            The name of the method that appears as a frame in any stack in a profile.

          • threadStatesrequired — (Array<String>)

            The list of application runtime thread states that is used to calculate the metric value for the frame.

          • typerequired — (String)

            A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

            Possible values include:
            • "AggregatedRelativeTotalTime"
        • reasonrequired — (String)

          The reason for which metric was flagged as anomalous.

      • profileEndTime — (Date)

        The end time of the profile the analysis data is about. 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.

      • profileStartTime — (Date)

        The start time of the profile the analysis data is about. 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.

      • profilingGroupName — (String)

        The name of the profiling group the analysis data is about.

      • recommendations — (Array<map>)

        The list of recommendations that the analysis found for this profile.

        • allMatchesCountrequired — (Integer)

          How many different places in the profile graph triggered a match.

        • allMatchesSumrequired — (Float)

          How much of the total sample count is potentially affected.

        • endTimerequired — (Date)

          End time of the profile that was used by this analysis. 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.

        • patternrequired — (map)

          The pattern that analysis recognized in the profile to make this recommendation.

          • countersToAggregate — (Array<String>)

            A list of the different counters used to determine if there is a match.

          • description — (String)

            The description of the recommendation. This explains a potential inefficiency in a profiled application.

          • id — (String)

            The universally unique identifier (UUID) of this pattern.

          • name — (String)

            The name for this pattern.

          • resolutionSteps — (String)

            A string that contains the steps recommended to address the potential inefficiency.

          • targetFrames — (Array<Array<String>>)

            A list of frame names that were searched during the analysis that generated a recommendation.

          • thresholdPercent — (Float)

            The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

        • startTimerequired — (Date)

          The start time of the profile that was used by this analysis. 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.

        • topMatchesrequired — (Array<map>)

          List of the matches with most impact.

          • frameAddress — (String)

            The location in the profiling graph that contains a recommendation found during analysis.

          • targetFramesIndex — (Integer)

            The target frame that triggered a match.

          • thresholdBreachValue — (Float)

            The value in the profile data that exceeded the recommendation threshold.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFindingsReports(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listFindingsReports operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  dailyReportsOnly: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeguruprofiler.listFindingsReports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • dailyReportsOnly — (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).

    • endTime — (Date)

      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.

    • maxResults — (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.

    • nextToken — (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.

      Note: 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.
    • profilingGroupName — (String)

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

    • startTime — (Date)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • findingsReportSummaries — (Array<map>)

        The list of analysis results summaries.

        • id — (String)

          The universally unique identifier (UUID) of the recommendation report.

        • profileEndTime — (Date)

          The end time of the period during which the metric is flagged as anomalous. 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.

        • profileStartTime — (Date)

          The start time of the profile the analysis data is about. 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.

        • profilingGroupName — (String)

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

        • totalNumberOfFindings — (Integer)

          The total number of different recommendations that were found by the analysis.

      • nextToken — (String)

        The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProfileTimes(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listProfileTimes operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  period: P1D | PT1H | PT5M, /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  orderBy: TimestampAscending | TimestampDescending
};
codeguruprofiler.listProfileTimes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endTime — (Date)

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

    • maxResults — (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.

    • nextToken — (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.

      Note: This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
    • orderBy — (String)

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

      Possible values include:
      • "TimestampAscending"
      • "TimestampDescending"
    • period — (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

      Possible values include:
      • "P1D"
      • "PT1H"
      • "PT5M"
    • profilingGroupName — (String)

      The name of the profiling group.

    • startTime — (Date)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

      • profileTimes — (Array<map>)

        The list of start times of the available profiles for the aggregation period in the specified time range.

        • start — (Date)

          The start time of a profile. It 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:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProfilingGroups(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listProfilingGroups operation

var params = {
  includeDescription: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeguruprofiler.listProfilingGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • includeDescription — (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.

    • maxResults — (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.

    • nextToken — (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.

      Note: 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

      • profilingGroupNames — (Array<String>)

        A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

      • profilingGroups — (Array<map>)

        A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

        • agentOrchestrationConfig — (map)

          An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

          • profilingEnabledrequired — (Boolean)

            A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

        • arn — (String)

          The Amazon Resource Name (ARN) identifying the profiling group resource.

        • computePlatform — (String)

          The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

          Possible values include:
          • "AWSLambda"
          • "Default"
        • createdAt — (Date)

          The time when the profiling group was created. 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.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

          • latestAgentOrchestratedAt — (Date)

            The date and time when the profiling agent most recently pinged back. 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.

          • latestAgentProfileReportedAt — (Date)

            The date and time when the most recent profile was received. 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.

          • latestAggregatedProfile — (map)

            An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

            • period — (String)

              The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

              • P1D — 1 day

              • PT1H — 1 hour

              • PT5M — 5 minutes

              Possible values include:
              • "P1D"
              • "PT1H"
              • "PT5M"
            • start — (Date)

              The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

              Specify start 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.

        • tags — (map<String>)

          A list of the tags that belong to this profiling group.

        • updatedAt — (Date)

          The date and time when the profiling group was last updated. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
codeguruprofiler.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The list of tags assigned to the specified resource. This is the list of tags returned in the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

postAgentProfile(params = {}, callback) ⇒ AWS.Request

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 .

Service Reference:

Examples:

Calling the postAgentProfile operation

var params = {
  agentProfile: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  contentType: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  profileToken: 'STRING_VALUE'
};
codeguruprofiler.postAgentProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • agentProfile — (Buffer, Typed Array, Blob, String)

      The submitted profiling data.

    • contentType — (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/&quot;&gt;Amazon Ion</a>. </p> </li> </ul> 
    • profileToken — (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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • profilingGroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putPermission(params = {}, callback) ⇒ AWS.Request

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&quot;&gt;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&#95;ConfigureAgent.html&quot;&gt; <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API&#95;PostAgentProfile.html&quot;&gt; <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> 

Service Reference:

Examples:

Calling the putPermission operation

var params = {
  actionGroup: agentPermissions, /* required */
  principals: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  profilingGroupName: 'STRING_VALUE', /* required */
  revisionId: 'STRING_VALUE'
};
codeguruprofiler.putPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • actionGroup — (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.

      Possible values include:
      • "agentPermissions"
    • principals — (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.

    • profilingGroupName — (String)

      The name of the profiling group to grant access to.

    • revisionId — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (String)

        The JSON-formatted resource-based policy on the profiling group that includes the added permissions.

      • revisionId — (String)

        A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeNotificationChannel(params = {}, callback) ⇒ AWS.Request

Remove one anomaly notifications channel for a profiling group.

Service Reference:

Examples:

Calling the removeNotificationChannel operation

var params = {
  channelId: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.removeNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • channelId — (String)

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

    • profilingGroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • notificationConfiguration — (map)

        The new notification configuration for this profiling group.

        • channels — (Array<map>)

          List of up to two channels to be used for sending notifications for events detected from the application profile.

          • eventPublishersrequired — (Array<String>)

            List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

          • id — (String)

            Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

          • urirequired — (String)

            Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removePermission(params = {}, callback) ⇒ AWS.Request

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 .

Service Reference:

Examples:

Calling the removePermission operation

var params = {
  actionGroup: agentPermissions, /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  revisionId: 'STRING_VALUE' /* required */
};
codeguruprofiler.removePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • actionGroup — (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.

      Possible values include:
      • "agentPermissions"
    • profilingGroupName — (String)

      The name of the profiling group.

    • revisionId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (String)

        The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed.

      • revisionId — (String)

        A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

submitFeedback(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the submitFeedback operation

var params = {
  anomalyInstanceId: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  type: Negative | Positive, /* required */
  comment: 'STRING_VALUE'
};
codeguruprofiler.submitFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • anomalyInstanceId — (String)

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

    • comment — (String)

      Optional feedback about this anomaly.

    • profilingGroupName — (String)

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

    • type — (String)

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

      Possible values include:
      • "Negative"
      • "Positive"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Use to assign one or more tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
codeguruprofiler.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

    • tags — (map<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Use to remove one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codeguruprofiler.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

    • tagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateProfilingGroup(params = {}, callback) ⇒ AWS.Request

Updates a profiling group.

Service Reference:

Examples:

Calling the updateProfilingGroup operation

var params = {
  agentOrchestrationConfig: { /* required */
    profilingEnabled: true || false /* required */
  },
  profilingGroupName: 'STRING_VALUE' /* required */
};
codeguruprofiler.updateProfilingGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • agentOrchestrationConfig — (map)

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

      • profilingEnabledrequired — (Boolean)

        A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

    • profilingGroupName — (String)

      The name of the profiling group to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • profilingGroup — (map)

        A ProfilingGroupDescription that contains information about the returned updated profiling group.

        • agentOrchestrationConfig — (map)

          An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

          • profilingEnabledrequired — (Boolean)

            A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

        • arn — (String)

          The Amazon Resource Name (ARN) identifying the profiling group resource.

        • computePlatform — (String)

          The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

          Possible values include:
          • "AWSLambda"
          • "Default"
        • createdAt — (Date)

          The time when the profiling group was created. 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.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

          • latestAgentOrchestratedAt — (Date)

            The date and time when the profiling agent most recently pinged back. 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.

          • latestAgentProfileReportedAt — (Date)

            The date and time when the most recent profile was received. 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.

          • latestAggregatedProfile — (map)

            An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

            • period — (String)

              The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

              • P1D — 1 day

              • PT1H — 1 hour

              • PT5M — 5 minutes

              Possible values include:
              • "P1D"
              • "PT1H"
              • "PT5M"
            • start — (Date)

              The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

              Specify start 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.

        • tags — (map<String>)

          A list of the tags that belong to this profiling group.

        • updatedAt — (Date)

          The date and time when the profiling group was last updated. 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.