Class: AWS.CodeGuruProfiler

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: PT5M | PT1H | P1D
};
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.

    • frameName — required — (String)

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

    • threadStates — required — (Array<String>)

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

    • type — required — (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:
    • "PT5M"
    • "PT1H"
    • "P1D"

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.

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

      • frameMetric — required — (map)

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

        • frameName — required — (String)

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

        • threadStates — required — (Array<String>)

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

        • type — required — (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"
      • values — required — (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:
      • "PT5M"
      • "PT1H"
      • "P1D"
    • 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.

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

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.

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

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

var params = {
  clientToken: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  agentOrchestrationConfig: {
    profilingEnabled: true || false /* required */
  },
  computePlatform: Default | AWSLambda,
  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.

    • profilingEnabled — required — (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:
    • "Default"
    • "AWSLambda"
  • 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.

        • profilingEnabled — required — (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:
        • "Default"
        • "AWSLambda"
      • 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:
            • "PT5M"
            • "PT1H"
            • "P1D"
          • 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.

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.

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.

        • profilingEnabled — required — (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:
        • "Default"
        • "AWSLambda"
      • 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:
            • "PT5M"
            • "PT1H"
            • "P1D"
          • 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.

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.

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.

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

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

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.

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.

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.

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

        • id — required — (String)

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

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

          • type — required — (String)

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

            Possible values include:
            • "Positive"
            • "Negative"
      • metric — required — (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.

        • frameName — required — (String)

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

        • threadStates — required — (Array<String>)

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

        • type — required — (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"
      • reason — required — (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.

      • allMatchesCount — required — (Integer)

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

      • allMatchesSum — required — (Float)

        How much of the total sample count is potentially affected.

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

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

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

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

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.

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  period: PT5M | PT1H | P1D, /* 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: TimestampDescending | TimestampAscending
};
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:
    • "TimestampDescending"
    • "TimestampAscending"
  • 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:
    • "PT5M"
    • "PT1H"
    • "P1D"
  • 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.

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.

        • profilingEnabled — required — (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:
        • "Default"
        • "AWSLambda"
      • 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:
            • "PT5M"
            • "PT1H"
            • "P1D"
          • 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.

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.

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.

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.

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.

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

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

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.

var params = {
  anomalyInstanceId: 'STRING_VALUE', /* required */
  profilingGroupName: 'STRING_VALUE', /* required */
  type: Positive | Negative, /* 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:
    • "Positive"
    • "Negative"

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.

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.

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.

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.

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

        • profilingEnabled — required — (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:
        • "Default"
        • "AWSLambda"
      • 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:
            • "PT5M"
            • "PT1H"
            • "P1D"
          • 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.