Class: AWS.XRay

var params = {
  GroupName: 'STRING_VALUE', /* required */
  FilterExpression: 'STRING_VALUE',
  InsightsConfiguration: {
    InsightsEnabled: true || false,
    NotificationsEnabled: true || false
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
xray.createGroup(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: {}) —
  • GroupName — (String)

    The case-sensitive name of the new group. Default is a reserved name and names must be unique.

  • FilterExpression — (String)

    The filter expression defining criteria by which to group traces.

  • InsightsConfiguration — (map)

    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

    • The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

    • InsightsEnabled — (Boolean)

      Set the InsightsEnabled value to true to enable insights or false to disable insights.

    • NotificationsEnabled — (Boolean)

      Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

  • Tags — (Array<map>)

    A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

    The following restrictions apply to tags:

    • Maximum number of user-applied tags per resource: 50

    • Maximum tag key length: 128 Unicode characters

    • Maximum tag value length: 256 Unicode characters

    • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

    • Tag keys and values are case sensitive.

    • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

    • Key — required — (String)

      A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • Value — required — (String)

      An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

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:

    • Group — (map)

      The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.

      • GroupName — (String)

        The unique case-sensitive name of the group.

      • GroupARN — (String)

        The Amazon Resource Name (ARN) of the group generated based on the GroupName.

      • FilterExpression — (String)

        The filter expression defining the parameters to include traces.

      • InsightsConfiguration — (map)

        The structure containing configurations related to insights.

        • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.

        • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.

        • InsightsEnabled — (Boolean)

          Set the InsightsEnabled value to true to enable insights or false to disable insights.

        • NotificationsEnabled — (Boolean)

          Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Returns:

• (AWS.Request) —

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

var params = {
  SamplingRule: { /* required */
    FixedRate: 'NUMBER_VALUE', /* required */
    HTTPMethod: 'STRING_VALUE', /* required */
    Host: 'STRING_VALUE', /* required */
    Priority: 'NUMBER_VALUE', /* required */
    ReservoirSize: 'NUMBER_VALUE', /* required */
    ResourceARN: 'STRING_VALUE', /* required */
    ServiceName: 'STRING_VALUE', /* required */
    ServiceType: 'STRING_VALUE', /* required */
    URLPath: 'STRING_VALUE', /* required */
    Version: 'NUMBER_VALUE', /* required */
    Attributes: {
      '<AttributeKey>': 'STRING_VALUE',
      /* '<AttributeKey>': ... */
    },
    RuleARN: 'STRING_VALUE',
    RuleName: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
xray.createSamplingRule(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: {}) —
  • SamplingRule — (map)

    The rule definition.

    • RuleName — (String)

      The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    • RuleARN — (String)

      The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    • ResourceARN — required — (String)

      Matches the ARN of the Amazon Web Services resource on which the service runs.

    • Priority — required — (Integer)

      The priority of the sampling rule.

    • FixedRate — required — (Float)

      The percentage of matching requests to instrument, after the reservoir is exhausted.

    • ReservoirSize — required — (Integer)

      A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    • ServiceName — required — (String)

      Matches the name that the service uses to identify itself in segments.

    • ServiceType — required — (String)

      Matches the origin that the service uses to identify its type in segments.

    • Host — required — (String)

      Matches the hostname from a request URL.

    • HTTPMethod — required — (String)

      Matches the HTTP method of a request.

    • URLPath — required — (String)

      Matches the path from a request URL.

    • Version — required — (Integer)

      The version of the sampling rule format (1).

    • Attributes — (map<String>)

      Matches attributes derived from the request.

  • Tags — (Array<map>)

    A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

    The following restrictions apply to tags:

    • Maximum number of user-applied tags per resource: 50

    • Maximum tag key length: 128 Unicode characters

    • Maximum tag value length: 256 Unicode characters

    • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

    • Tag keys and values are case sensitive.

    • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

    • Key — required — (String)

      A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • Value — required — (String)

      An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

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:

    • SamplingRuleRecord — (map)

      The saved rule definition and metadata.

      • SamplingRule — (map)

        The sampling rule.

        • RuleName — (String)

          The name of the sampling rule. Specify a rule by either name or ARN, but not both.

        • RuleARN — (String)

          The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

        • ResourceARN — required — (String)

          Matches the ARN of the Amazon Web Services resource on which the service runs.

        • Priority — required — (Integer)

          The priority of the sampling rule.

        • FixedRate — required — (Float)

          The percentage of matching requests to instrument, after the reservoir is exhausted.

        • ReservoirSize — required — (Integer)

          A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

        • ServiceName — required — (String)

          Matches the name that the service uses to identify itself in segments.

        • ServiceType — required — (String)

          Matches the origin that the service uses to identify its type in segments.

        • Host — required — (String)

          Matches the hostname from a request URL.

        • HTTPMethod — required — (String)

          Matches the HTTP method of a request.

        • URLPath — required — (String)

          Matches the path from a request URL.

        • Version — required — (Integer)

          The version of the sampling rule format (1).

        • Attributes — (map<String>)

          Matches attributes derived from the request.

      • CreatedAt — (Date)

        When the rule was created.

      • ModifiedAt — (Date)

        When the rule was last modified.

Returns:

• (AWS.Request) —

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

var params = {
  GroupARN: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
xray.deleteGroup(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: {}) —
  • GroupName — (String)

    The case-sensitive name of the group.

  • GroupARN — (String)

    The ARN of the group that was generated on creation.

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 = {
  PolicyName: 'STRING_VALUE', /* required */
  PolicyRevisionId: 'STRING_VALUE'
};
xray.deleteResourcePolicy(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: {}) —
  • PolicyName — (String)

    The name of the resource policy to delete.

  • PolicyRevisionId — (String)

    Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned.

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 = {
  RuleARN: 'STRING_VALUE',
  RuleName: 'STRING_VALUE'
};
xray.deleteSamplingRule(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: {}) —
  • RuleName — (String)

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

  • RuleARN — (String)

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

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:

    • SamplingRuleRecord — (map)

      The deleted rule definition and metadata.

      • SamplingRule — (map)

        The sampling rule.

        • RuleName — (String)

          The name of the sampling rule. Specify a rule by either name or ARN, but not both.

        • RuleARN — (String)

          The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

        • ResourceARN — required — (String)

          Matches the ARN of the Amazon Web Services resource on which the service runs.

        • Priority — required — (Integer)

          The priority of the sampling rule.

        • FixedRate — required — (Float)

          The percentage of matching requests to instrument, after the reservoir is exhausted.

        • ReservoirSize — required — (Integer)

          A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

        • ServiceName — required — (String)

          Matches the name that the service uses to identify itself in segments.

        • ServiceType — required — (String)

          Matches the origin that the service uses to identify its type in segments.

        • Host — required — (String)

          Matches the hostname from a request URL.

        • HTTPMethod — required — (String)

          Matches the HTTP method of a request.

        • URLPath — required — (String)

          Matches the path from a request URL.

        • Version — required — (Integer)

          The version of the sampling rule format (1).

        • Attributes — (map<String>)

          Matches attributes derived from the request.

      • CreatedAt — (Date)

        When the rule was created.

      • ModifiedAt — (Date)

        When the rule was last modified.

Returns:

• (AWS.Request) —

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

var params = {
};
xray.getEncryptionConfig(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: {})

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:

    • EncryptionConfig — (map)

      The encryption configuration document.

      • KeyId — (String)

        The ID of the KMS key used for encryption, if applicable.

      • Status — (String)

        The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

        Possible values include:
        • "UPDATING"
        • "ACTIVE"
      • Type — (String)

        The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption.

        Possible values include:
        • "NONE"
        • "KMS"

Returns:

• (AWS.Request) —

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

var params = {
  GroupARN: 'STRING_VALUE',
  GroupName: 'STRING_VALUE'
};
xray.getGroup(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: {}) —
  • GroupName — (String)

    The case-sensitive name of the group.

  • GroupARN — (String)

    The ARN of the group that was generated on creation.

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:

    • Group — (map)

      The group that was requested. Contains the name of the group, the ARN of the group, the filter expression, and the insight configuration assigned to the group.

      • GroupName — (String)

        The unique case-sensitive name of the group.

      • GroupARN — (String)

        The Amazon Resource Name (ARN) of the group generated based on the GroupName.

      • FilterExpression — (String)

        The filter expression defining the parameters to include traces.

      • InsightsConfiguration — (map)

        The structure containing configurations related to insights.

        • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.

        • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.

        • InsightsEnabled — (Boolean)

          Set the InsightsEnabled value to true to enable insights or false to disable insights.

        • NotificationsEnabled — (Boolean)

          Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Returns:

• (AWS.Request) —

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

var params = {
  NextToken: 'STRING_VALUE'
};
xray.getGroups(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: {}) —
  • NextToken — (String)

    Pagination token.

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:

    • Groups — (Array<map>)

      The collection of all active groups.

      • GroupName — (String)

        The unique case-sensitive name of the group.

      • GroupARN — (String)

        The ARN of the group generated based on the GroupName.

      • FilterExpression — (String)

        The filter expression defining the parameters to include traces.

      • InsightsConfiguration — (map)

        The structure containing configurations related to insights.

        • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.

        • The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

        • InsightsEnabled — (Boolean)

          Set the InsightsEnabled value to true to enable insights or false to disable insights.

        • NotificationsEnabled — (Boolean)

          Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

    • NextToken — (String)

      Pagination token.

Returns:

• (AWS.Request) —

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

var params = {
  InsightId: 'STRING_VALUE' /* required */
};
xray.getInsight(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: {}) —
  • InsightId — (String)

    The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

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:

    • Insight — (map)

      The summary information of an insight.

      • InsightId — (String)

        The insights unique identifier.

      • GroupARN — (String)

        The Amazon Resource Name (ARN) of the group that the insight belongs to.

      • GroupName — (String)

        The name of the group that the insight belongs to.

      • RootCauseServiceId — (map)
        • Name — (String)

        • Names — (Array<String>)

        • AccountId — (String)

        • Type — (String)

      • Categories — (Array<String>)

        The categories that label and describe the type of insight.

      • State — (String)

        The current state of the insight.

        Possible values include:
        • "ACTIVE"
        • "CLOSED"
      • StartTime — (Date)

        The time, in Unix seconds, at which the insight began.

      • EndTime — (Date)

        The time, in Unix seconds, at which the insight ended.

      • Summary — (String)

        A brief description of the insight.

      • ClientRequestImpactStatistics — (map)

        The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • RootCauseServiceRequestImpactStatistics — (map)

        The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • TopAnomalousServices — (Array<map>)

        The service within the insight that is most impacted by the incident.

        • ServiceId — (map)
          • Name — (String)

          • Names — (Array<String>)

          • AccountId — (String)

          • Type — (String)

Returns:

• (AWS.Request) —

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

var params = {
  InsightId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
xray.getInsightEvents(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: {}) —
  • InsightId — (String)

    The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

  • MaxResults — (Integer)

    Used to retrieve at most the specified value of events.

  • NextToken — (String)

    Specify the pagination token returned by a previous request to retrieve the next page of events.

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:

    • InsightEvents — (Array<map>)

      A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

      • Summary — (String)

        A brief description of the event.

      • EventTime — (Date)

        The time, in Unix seconds, at which the event was recorded.

      • ClientRequestImpactStatistics — (map)

        The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • RootCauseServiceRequestImpactStatistics — (map)

        The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • TopAnomalousServices — (Array<map>)

        The service during the event that is most impacted by the incident.

        • ServiceId — (map)
          • Name — (String)

          • Names — (Array<String>)

          • AccountId — (String)

          • Type — (String)

    • NextToken — (String)

      Use this token to retrieve the next page of insight events.

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 */
  InsightId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  NextToken: 'STRING_VALUE'
};
xray.getInsightImpactGraph(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: {}) —
  • InsightId — (String)

    The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

  • StartTime — (Date)

    The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.

  • EndTime — (Date)

    The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours.

  • NextToken — (String)

    Specify the pagination token returned by a previous request to retrieve the next page of 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:

    • InsightId — (String)

      The insight's unique identifier.

    • StartTime — (Date)

      The provided start time.

    • EndTime — (Date)

      The provided end time.

    • ServiceGraphStartTime — (Date)

      The time, in Unix seconds, at which the service graph started.

    • ServiceGraphEndTime — (Date)

      The time, in Unix seconds, at which the service graph ended.

    • Services — (Array<map>)

      The Amazon Web Services instrumented services related to the insight.

      • ReferenceId — (Integer)

        Identifier for the service. Unique within the service map.

      • Type — (String)

        Identifier for the service. Unique within the service map.

        • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

        • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

        • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

        • remote - A downstream service of indeterminate type.

      • Name — (String)

        The canonical name of the service.

      • Names — (Array<String>)

        A list of names for the service, including the canonical name.

      • AccountId — (String)

        Identifier of the Amazon Web Services account in which the service runs.

      • Edges — (Array<map>)

        Connections to downstream services.

        • ReferenceId — (Integer)

          Identifier of the edge. Unique within a service map.

    • NextToken — (String)

      Pagination token.

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 */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  GroupARN: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  States: [
    ACTIVE | CLOSED,
    /* more items */
  ]
};
xray.getInsightSummaries(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: {}) —
  • States — (Array<String>)

    The list of insight states.

  • GroupARN — (String)

    The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.

  • GroupName — (String)

    The name of the group. Required if the GroupARN isn't provided.

  • StartTime — (Date)

    The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

  • EndTime — (Date)

    The end of the time frame in which the insights ended. The end time can't be more than 30 days old.

  • MaxResults — (Integer)

    The maximum number of results to display.

  • NextToken — (String)

    Pagination token.

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:

    • InsightSummaries — (Array<map>)

      The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.

      • InsightId — (String)

        The insights unique identifier.

      • GroupARN — (String)

        The Amazon Resource Name (ARN) of the group that the insight belongs to.

      • GroupName — (String)

        The name of the group that the insight belongs to.

      • RootCauseServiceId — (map)
        • Name — (String)

        • Names — (Array<String>)

        • AccountId — (String)

        • Type — (String)

      • Categories — (Array<String>)

        Categories The categories that label and describe the type of insight.

      • State — (String)

        The current state of the insight.

        Possible values include:
        • "ACTIVE"
        • "CLOSED"
      • StartTime — (Date)

        The time, in Unix seconds, at which the insight began.

      • EndTime — (Date)

        The time, in Unix seconds, at which the insight ended.

      • Summary — (String)

        A brief description of the insight.

      • ClientRequestImpactStatistics — (map)

        The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • RootCauseServiceRequestImpactStatistics — (map)

        The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

        • FaultCount — (Integer)

          The number of requests that have resulted in a fault,

        • OkCount — (Integer)

          The number of successful requests.

        • TotalCount — (Integer)

          The total number of requests to the service.

      • TopAnomalousServices — (Array<map>)

        The service within the insight that is most impacted by the incident.

        • ServiceId — (map)
          • Name — (String)

          • Names — (Array<String>)

          • AccountId — (String)

          • Type — (String)

      • LastUpdateTime — (Date)

        The time, in Unix seconds, that the insight was last updated.

    • NextToken — (String)

      Pagination token.

Returns:

• (AWS.Request) —

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

var params = {
  NextToken: 'STRING_VALUE'
};
xray.getSamplingRules(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: {}) —
  • NextToken — (String)

    Pagination token.

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:

    • SamplingRuleRecords — (Array<map>)

      Rule definitions and metadata.

      • SamplingRule — (map)

        The sampling rule.

        • RuleName — (String)

          The name of the sampling rule. Specify a rule by either name or ARN, but not both.

        • RuleARN — (String)

          The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

        • ResourceARN — required — (String)

          Matches the ARN of the Amazon Web Services resource on which the service runs.

        • Priority — required — (Integer)

          The priority of the sampling rule.

        • FixedRate — required — (Float)

          The percentage of matching requests to instrument, after the reservoir is exhausted.

        • ReservoirSize — required — (Integer)

          A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

        • ServiceName — required — (String)

          Matches the name that the service uses to identify itself in segments.

        • ServiceType — required — (String)

          Matches the origin that the service uses to identify its type in segments.

        • Host — required — (String)

          Matches the hostname from a request URL.

        • HTTPMethod — required — (String)

          Matches the HTTP method of a request.

        • URLPath — required — (String)

          Matches the path from a request URL.

        • Version — required — (Integer)

          The version of the sampling rule format (1).

        • Attributes — (map<String>)

          Matches attributes derived from the request.

      • CreatedAt — (Date)

        When the rule was created.

      • ModifiedAt — (Date)

        When the rule was last modified.

    • NextToken — (String)

      Pagination token.

Returns:

• (AWS.Request) —

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

var params = {
  NextToken: 'STRING_VALUE'
};
xray.getSamplingStatisticSummaries(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: {}) —
  • NextToken — (String)

    Pagination token.

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:

    • SamplingStatisticSummaries — (Array<map>)

      Information about the number of requests instrumented for each sampling rule.

      • RuleName — (String)

        The name of the sampling rule.

      • Timestamp — (Date)

        The start time of the reporting window.

      • RequestCount — (Integer)

        The number of requests that matched the rule.

      • BorrowCount — (Integer)

        The number of requests recorded with borrowed reservoir quota.

      • SampledCount — (Integer)

        The number of requests recorded.

    • NextToken — (String)

      Pagination token.

Returns:

• (AWS.Request) —

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

var params = {
  SamplingStatisticsDocuments: [ /* required */
    {
      ClientID: 'STRING_VALUE', /* required */
      RequestCount: 'NUMBER_VALUE', /* required */
      RuleName: 'STRING_VALUE', /* required */
      SampledCount: 'NUMBER_VALUE', /* required */
      Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      BorrowCount: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
xray.getSamplingTargets(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: {}) —
  • SamplingStatisticsDocuments — (Array<map>)

    Information about rules that the service is using to sample requests.

    • RuleName — required — (String)

      The name of the sampling rule.

    • ClientID — required — (String)

      A unique identifier for the service in hexadecimal.

    • Timestamp — required — (Date)

      The current time.

    • RequestCount — required — (Integer)

      The number of requests that matched the rule.

    • SampledCount — required — (Integer)

      The number of requests recorded.

    • BorrowCount — (Integer)

      The number of requests recorded with borrowed reservoir quota.

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:

    • SamplingTargetDocuments — (Array<map>)

      Updated rules that the service should use to sample requests.

      • RuleName — (String)

        The name of the sampling rule.

      • FixedRate — (Float)

        The percentage of matching requests to instrument, after the reservoir is exhausted.

      • ReservoirQuota — (Integer)

        The number of requests per second that X-Ray allocated for this service.

      • ReservoirQuotaTTL — (Date)

        When the reservoir quota expires.

      • Interval — (Integer)

        The number of seconds for the service to wait before getting sampling targets again.

    • LastRuleModification — (Date)

      The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

    • UnprocessedStatistics — (Array<map>)

      Information about SamplingStatisticsDocument that X-Ray could not process.

      • RuleName — (String)

        The name of the sampling rule.

      • ErrorCode — (String)

        The error code.

      • Message — (String)

        The error message.

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 */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  GroupARN: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
xray.getServiceGraph(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: {}) —
  • StartTime — (Date)

    The start of the time frame for which to generate a graph.

  • EndTime — (Date)

    The end of the timeframe for which to generate a graph.

  • GroupName — (String)

    The name of a group based on which you want to generate a graph.

  • GroupARN — (String)

    The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

  • NextToken — (String)

    Pagination token.

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