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

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

Example service documentation.

Sending a Request Using CodeGuruProfiler

var codeguruprofiler = new AWS.CodeGuruProfiler();
codeguruprofiler.configureAgent(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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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

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

Provides the configuration to use for an agent of the profiling group.

Service Reference:

Examples:

Calling the configureAgent operation

var params = {
  profilingGroupName: 'STRING_VALUE', /* required */
  fleetInstanceId: 'STRING_VALUE'
};
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)

      Identifier of the instance of compute fleet being profiled by the agent. For instance, host name in EC2, task id for ECS, function name for AWS Lambda

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

      • configuration — (map)

        The configuration for the agent to use.

        • periodInSecondsrequired — (Integer)

          Specifies the period to follow the configuration (to profile or not) and call back to get a new configuration.

        • shouldProfilerequired — (Boolean)

          Specifies if the profiling should be enabled by the agent.

Returns:

  • (AWS.Request)

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

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

Create 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 */
  }
};
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)

      Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

      • profilingEnabledrequired — (Boolean)

        If the agents should be enabled to create and report profiles.

    • clientToken — (String)

      Client token for the request.

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

      • profilingGroup — (map)

        The description of a profiling group.

        • agentOrchestrationConfig — (map)

          Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

          • profilingEnabledrequired — (Boolean)

            If the agents should be enabled to create and report profiles.

        • arn — (String)

          The ARN of the profiling group.

        • createdAt — (Date)

          The timestamp of when the profiling group was created.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          The status of profiling of a profiling group.

          • latestAgentOrchestratedAt — (Date)

            Timestamp of when the last interaction of the agent with configureAgent API for orchestration.

          • latestAgentProfileReportedAt — (Date)

            Timestamp of when the latest agent profile was successfully reported.

          • latestAggregatedProfile — (map)

            The time range of latest aggregated profile available.

            • period — (String)

              The aggregation period of the aggregated profile.

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

              The start time of the aggregated profile.

        • updatedAt — (Date)

          The timestamp of when the profiling group was last updated.

Returns:

  • (AWS.Request)

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

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

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

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

Describe a 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.

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 description of a profiling group.

        • agentOrchestrationConfig — (map)

          Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

          • profilingEnabledrequired — (Boolean)

            If the agents should be enabled to create and report profiles.

        • arn — (String)

          The ARN of the profiling group.

        • createdAt — (Date)

          The timestamp of when the profiling group was created.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          The status of profiling of a profiling group.

          • latestAgentOrchestratedAt — (Date)

            Timestamp of when the last interaction of the agent with configureAgent API for orchestration.

          • latestAgentProfileReportedAt — (Date)

            Timestamp of when the latest agent profile was successfully reported.

          • latestAggregatedProfile — (map)

            The time range of latest aggregated profile available.

            • period — (String)

              The aggregation period of the aggregated profile.

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

              The start time of the aggregated profile.

        • updatedAt — (Date)

          The timestamp of when the profiling group was last updated.

Returns:

  • (AWS.Request)

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

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

Get the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it will be expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For instance, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20.

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 profile to return. Supports application/json or application/x-amzn-ion. Defaults to application/x-amzn-ion.

    • endTime — (Date)

      The end time of the profile to get. Either period or endTime must be specified. Must be greater than start and the overall time range to be in the past and not larger than a week.

    • maxDepth — (Integer)

      Limit the max depth of the profile.

    • period — (String)

      The period of the profile to get. Exactly two of startTime, period and endTime must be specified. Must be positive and the overall time range to be in the past and not larger than a week.

    • profilingGroupName — (String)

      The name of the profiling group.

    • startTime — (Date)

      The start time of the profile to get.

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 in the payload.

      • contentType — (String)

        The content type of the profile in the payload. Will be application/json or application/x-amzn-ion based on Accept header in the request.

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

        The profile representing the aggregation of agent profiles of the profiling group for a time range.

Returns:

  • (AWS.Request)

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

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

List 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 to list profiles until.

    • maxResults — (Integer)

      Upper bound on the number of results to list in a single call.

    • nextToken — (String)

      Token for paginating results.

    • orderBy — (String)

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

      Possible values include:
      • "TimestampAscending"
      • "TimestampDescending"
    • period — (String)

      The aggregation period to list the profiles for.

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

      The name of the profiling group.

    • startTime — (Date)

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

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)

        Token for paginating results.

      • profileTimes — (Array<map>)

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

        • start — (Date)

          The start time of the profile.

Returns:

  • (AWS.Request)

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

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

List profiling groups in the account.

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)

      If set to true, returns the full description of the profiling groups instead of the names. Defaults to false.

    • maxResults — (Integer)

      Upper bound on the number of results to list in a single call.

    • nextToken — (String)

      Token for paginating results.

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)

        Token for paginating results.

      • profilingGroupNames — (Array<String>)

        List of profiling group names.

      • profilingGroups — (Array<map>)

        List of profiling group descriptions.

        • agentOrchestrationConfig — (map)

          Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

          • profilingEnabledrequired — (Boolean)

            If the agents should be enabled to create and report profiles.

        • arn — (String)

          The ARN of the profiling group.

        • createdAt — (Date)

          The timestamp of when the profiling group was created.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          The status of profiling of a profiling group.

          • latestAgentOrchestratedAt — (Date)

            Timestamp of when the last interaction of the agent with configureAgent API for orchestration.

          • latestAgentProfileReportedAt — (Date)

            Timestamp of when the latest agent profile was successfully reported.

          • latestAggregatedProfile — (map)

            The time range of latest aggregated profile available.

            • period — (String)

              The aggregation period of the aggregated profile.

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

              The start time of the aggregated profile.

        • updatedAt — (Date)

          The timestamp of when the profiling group was last updated.

Returns:

  • (AWS.Request)

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

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

Submit profile collected by an agent belonging to a profiling group for aggregation.

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 profile collected by an agent for a time range.

    • contentType — (String)

      The content type of the agent profile in the payload. Recommended to send the profile gzipped with content-type application/octet-stream. Other accepted values are application/x-amzn-ion and application/json for unzipped Ion and JSON respectively.

    • profileToken — (String)

      Client generated token to deduplicate the agent profile during aggregation.

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

Returns:

  • (AWS.Request)

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

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

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

      Remote configuration to configure the agents of the profiling group.

      • profilingEnabledrequired — (Boolean)

        If the agents should be enabled to create and report profiles.

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

      • profilingGroup — (map)

        The description of a profiling group.

        • agentOrchestrationConfig — (map)

          Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

          • profilingEnabledrequired — (Boolean)

            If the agents should be enabled to create and report profiles.

        • arn — (String)

          The ARN of the profiling group.

        • createdAt — (Date)

          The timestamp of when the profiling group was created.

        • name — (String)

          The name of the profiling group.

        • profilingStatus — (map)

          The status of profiling of a profiling group.

          • latestAgentOrchestratedAt — (Date)

            Timestamp of when the last interaction of the agent with configureAgent API for orchestration.

          • latestAgentProfileReportedAt — (Date)

            Timestamp of when the latest agent profile was successfully reported.

          • latestAggregatedProfile — (map)

            The time range of latest aggregated profile available.

            • period — (String)

              The aggregation period of the aggregated profile.

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

              The start time of the aggregated profile.

        • updatedAt — (Date)

          The timestamp of when the profiling group was last updated.

Returns:

  • (AWS.Request)

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