Class: AWS.ApplicationSignals

var params = {
  Name: 'STRING_VALUE', /* required */
  SliConfig: { /* required */
    ComparisonOperator: GreaterThanOrEqualTo | GreaterThan | LessThan | LessThanOrEqualTo, /* required */
    MetricThreshold: 'NUMBER_VALUE', /* required */
    SliMetricConfig: { /* required */
      KeyAttributes: {
        '<KeyAttributeName>': 'STRING_VALUE',
        /* '<KeyAttributeName>': ... */
      },
      MetricDataQueries: [
        {
          Id: 'STRING_VALUE', /* required */
          AccountId: 'STRING_VALUE',
          Expression: 'STRING_VALUE',
          Label: 'STRING_VALUE',
          MetricStat: {
            Metric: { /* required */
              Dimensions: [
                {
                  Name: 'STRING_VALUE', /* required */
                  Value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              MetricName: 'STRING_VALUE',
              Namespace: 'STRING_VALUE'
            },
            Period: 'NUMBER_VALUE', /* required */
            Stat: 'STRING_VALUE', /* required */
            Unit: Microseconds | Milliseconds | Seconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
          },
          Period: 'NUMBER_VALUE',
          ReturnData: true || false
        },
        /* more items */
      ],
      MetricType: LATENCY | AVAILABILITY,
      OperationName: 'STRING_VALUE',
      PeriodSeconds: 'NUMBER_VALUE',
      Statistic: 'STRING_VALUE'
    }
  },
  Description: 'STRING_VALUE',
  Goal: {
    AttainmentGoal: 'NUMBER_VALUE',
    Interval: {
      CalendarInterval: {
        Duration: 'NUMBER_VALUE', /* required */
        DurationUnit: DAY | MONTH, /* required */
        StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
      },
      RollingInterval: {
        Duration: 'NUMBER_VALUE', /* required */
        DurationUnit: DAY | MONTH /* required */
      }
    },
    WarningThreshold: 'NUMBER_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
applicationsignals.createServiceLevelObjective(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: {}) —
  • Name — (String)

    A name for this SLO.

  • Description — (String)

    An optional description for this SLO.

  • SliConfig — (map)

    A structure that contains information about what service and what performance metric that this SLO will monitor.

    • SliMetricConfig — required — (map)

      Use this structure to specify the metric to be used for the SLO.

      • KeyAttributes — (map<String>)

        If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • OperationName — (String)

        If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

      • MetricType — (String)

        If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

        Possible values include:
        • "LATENCY"
        • "AVAILABILITY"
      • Statistic — (String)

        The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

      • PeriodSeconds — (Integer)

        The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

      • MetricDataQueries — (Array<map>)

        If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

        • Id — required — (String)

          A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

        • MetricStat — (map)

          A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

          Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Metric — required — (map)

            The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

            • Namespace — (String)

              The namespace of the metric. For more information, see Namespaces.

            • MetricName — (String)

              The name of the metric to use.

            • Dimensions — (Array<map>)

              An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

              • Name — required — (String)

                The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

              • Value — required — (String)

                The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

          • Period — required — (Integer)

            The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

          • Stat — required — (String)

            The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

          • Unit — (String)

            If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

            Possible values include:
            • "Microseconds"
            • "Milliseconds"
            • "Seconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Count"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
            • "None"
        • Expression — (String)

          This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

          A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

          Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

        • Label — (String)

          A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

          You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

        • ReturnData — (Boolean)

          Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

        • Period — (Integer)

          The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

          If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

          • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

          • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

          • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

        • AccountId — (String)

          The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

    • MetricThreshold — required — (Float)

      The value that the SLI metric is compared to.

    • ComparisonOperator — required — (String)

      The arithmetic operation to use when comparing the specified metric to the threshold.

      Possible values include:
      • "GreaterThanOrEqualTo"
      • "GreaterThan"
      • "LessThan"
      • "LessThanOrEqualTo"
  • Goal — (map)

    A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.

    • Interval — (map)

      The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

      If you omit this parameter, a rolling interval of 7 days is used.

      • RollingInterval — (map)

        If the interval is a rolling interval, this structure contains the interval specifications.

        • DurationUnit — required — (String)

          Specifies the rolling interval unit.

          Possible values include:
          • "DAY"
          • "MONTH"
        • Duration — required — (Integer)

          Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

      • CalendarInterval — (map)

        If the interval is a calendar interval, this structure contains the interval specifications.

        • StartTime — required — (Date)

          The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

          When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

          As soon as one calendar interval ends, another automatically begins.

        • DurationUnit — required — (String)

          Specifies the calendar interval unit.

          Possible values include:
          • "DAY"
          • "MONTH"
        • Duration — required — (Integer)

          Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

    • AttainmentGoal — (Float)

      The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

      If you omit this parameter, 99 is used to represent 99% as the attainment goal.

    • WarningThreshold — (Float)

      The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

  • Tags — (Array<map>)

    A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    • Key — required — (String)

      A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

    • Value — required — (String)

      The value for the specified tag key.

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:

    • Slo — (map)

      A structure that contains information about the SLO that you just created.

      • Arn — required — (String)

        The ARN of this SLO.

      • Name — required — (String)

        The name of this SLO.

      • Description — (String)

        The description that you created for this SLO.

      • CreatedTime — required — (Date)

        The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • LastUpdatedTime — required — (Date)

        The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • Sli — required — (map)

        A structure containing information about the performance metric that this SLO monitors.

        • SliMetric — required — (map)

          A structure that contains information about the metric that the SLO monitors.

          • KeyAttributes — (map<String>)

            This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

            • Type designates the type of object that this SLO is related to.

            • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

            • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

            • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

            • Environment specifies the location where this object is hosted, or what it belongs to.

          • OperationName — (String)

            If the SLO monitors a specific operation of the service, this field displays that operation name.

          • MetricType — (String)

            If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

            Possible values include:
            • "LATENCY"
            • "AVAILABILITY"
          • MetricDataQueries — required — (Array<map>)

            If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.

            • Id — required — (String)

              A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

            • MetricStat — (map)

              A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

              Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

              • Metric — required — (map)

                The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

                • Namespace — (String)

                  The namespace of the metric. For more information, see Namespaces.

                • MetricName — (String)

                  The name of the metric to use.

                • Dimensions — (Array<map>)

                  An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

                  • Name — required — (String)

                    The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

                  • Value — required — (String)

                    The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

              • Period — required — (Integer)

                The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              • Stat — required — (String)

                The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

              • Unit — (String)

                If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

                Possible values include:
                • "Microseconds"
                • "Milliseconds"
                • "Seconds"
                • "Bytes"
                • "Kilobytes"
                • "Megabytes"
                • "Gigabytes"
                • "Terabytes"
                • "Bits"
                • "Kilobits"
                • "Megabits"
                • "Gigabits"
                • "Terabits"
                • "Percent"
                • "Count"
                • "Bytes/Second"
                • "Kilobytes/Second"
                • "Megabytes/Second"
                • "Gigabytes/Second"
                • "Terabytes/Second"
                • "Bits/Second"
                • "Kilobits/Second"
                • "Megabits/Second"
                • "Gigabits/Second"
                • "Terabits/Second"
                • "Count/Second"
                • "None"
            • Expression — (String)

              This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

              A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

              Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Label — (String)

              A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

              You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

            • ReturnData — (Boolean)

              Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

            • Period — (Integer)

              The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

              • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

              • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

              • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

            • AccountId — (String)

              The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

        • MetricThreshold — required — (Float)

          The value that the SLI metric is compared to.

        • ComparisonOperator — required — (String)

          The arithmetic operation used when comparing the specified metric to the threshold.

          Possible values include:
          • "GreaterThanOrEqualTo"
          • "GreaterThan"
          • "LessThan"
          • "LessThanOrEqualTo"
      • Goal — required — (map)

        This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

        • Interval — (map)

          The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

          If you omit this parameter, a rolling interval of 7 days is used.

          • RollingInterval — (map)

            If the interval is a rolling interval, this structure contains the interval specifications.

            • DurationUnit — required — (String)

              Specifies the rolling interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

          • CalendarInterval — (map)

            If the interval is a calendar interval, this structure contains the interval specifications.

            • StartTime — required — (Date)

              The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

              When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

              As soon as one calendar interval ends, another automatically begins.

            • DurationUnit — required — (String)

              Specifies the calendar interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

        • AttainmentGoal — (Float)

          The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

          If you omit this parameter, 99 is used to represent 99% as the attainment goal.

        • WarningThreshold — (Float)

          The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

Returns:

• (AWS.Request) —

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

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

    The ARN or name of the service level objective 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 = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  KeyAttributes: { /* required */
    '<KeyAttributeName>': 'STRING_VALUE',
    /* '<KeyAttributeName>': ... */
  },
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
applicationsignals.getService(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 period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • EndTime — (Date)

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • KeyAttributes — (map<String>)

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs 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:

    • Service — (map)

      A structure containing information about the service.

      • KeyAttributes — required — (map<String>)

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • AttributeMaps — (Array<map<String>>)

        This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

        Platform attributes contain information the service's platform.

        • PlatformType defines the hosted-in platform.

        • EKS.Cluster is the name of the Amazon EKS cluster.

        • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

        • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

        • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

        • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

        • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

        • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

        • EC2.InstanceId is the ID of the Amazon EC2 instance.

        • Host is the name of the host, for all platform types.

        Applciation attributes contain information about the application.

        • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

        • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

        Telemetry attributes contain telemetry information.

        • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

        • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

        • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

      • MetricReferences — required — (Array<map>)

        An array of structures that each contain information about one metric associated with this service.

        • Namespace — required — (String)

          The namespace of the metric. For more information, see CloudWatchNamespaces.

        • MetricType — required — (String)

          Used to display the appropriate statistics in the CloudWatch console.

        • Dimensions — (Array<map>)

          An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

          • Name — required — (String)

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

          • Value — required — (String)

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

        • MetricName — required — (String)

          The name of the metric.

      • LogGroupReferences — (Array<map<String>>)

        An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

        • "Type": "AWS::Resource"

        • "ResourceType": "AWS::Logs::LogGroup"

        • "Identifier": "name-of-log-group"

    • StartTime — (Date)

      The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • EndTime — (Date)

      The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • LogGroupReferences — (Array<map<String>>)

      An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

      • "Type": "AWS::Resource"

      • "ResourceType": "AWS::Logs::LogGroup"

      • "Identifier": "name-of-log-group"

Returns:

• (AWS.Request) —

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

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

    The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.

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:

    • Slo — (map)

      A structure containing the information about the SLO.

      • Arn — required — (String)

        The ARN of this SLO.

      • Name — required — (String)

        The name of this SLO.

      • Description — (String)

        The description that you created for this SLO.

      • CreatedTime — required — (Date)

        The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • LastUpdatedTime — required — (Date)

        The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • Sli — required — (map)

        A structure containing information about the performance metric that this SLO monitors.

        • SliMetric — required — (map)

          A structure that contains information about the metric that the SLO monitors.

          • KeyAttributes — (map<String>)

            This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

            • Type designates the type of object that this SLO is related to.

            • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

            • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

            • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

            • Environment specifies the location where this object is hosted, or what it belongs to.

          • OperationName — (String)

            If the SLO monitors a specific operation of the service, this field displays that operation name.

          • MetricType — (String)

            If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

            Possible values include:
            • "LATENCY"
            • "AVAILABILITY"
          • MetricDataQueries — required — (Array<map>)

            If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.

            • Id — required — (String)

              A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

            • MetricStat — (map)

              A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

              Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

              • Metric — required — (map)

                The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

                • Namespace — (String)

                  The namespace of the metric. For more information, see Namespaces.

                • MetricName — (String)

                  The name of the metric to use.

                • Dimensions — (Array<map>)

                  An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

                  • Name — required — (String)

                    The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

                  • Value — required — (String)

                    The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

              • Period — required — (Integer)

                The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              • Stat — required — (String)

                The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

              • Unit — (String)

                If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

                Possible values include:
                • "Microseconds"
                • "Milliseconds"
                • "Seconds"
                • "Bytes"
                • "Kilobytes"
                • "Megabytes"
                • "Gigabytes"
                • "Terabytes"
                • "Bits"
                • "Kilobits"
                • "Megabits"
                • "Gigabits"
                • "Terabits"
                • "Percent"
                • "Count"
                • "Bytes/Second"
                • "Kilobytes/Second"
                • "Megabytes/Second"
                • "Gigabytes/Second"
                • "Terabytes/Second"
                • "Bits/Second"
                • "Kilobits/Second"
                • "Megabits/Second"
                • "Gigabits/Second"
                • "Terabits/Second"
                • "Count/Second"
                • "None"
            • Expression — (String)

              This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

              A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

              Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Label — (String)

              A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

              You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

            • ReturnData — (Boolean)

              Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

            • Period — (Integer)

              The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

              • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

              • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

              • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

            • AccountId — (String)

              The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

        • MetricThreshold — required — (Float)

          The value that the SLI metric is compared to.

        • ComparisonOperator — required — (String)

          The arithmetic operation used when comparing the specified metric to the threshold.

          Possible values include:
          • "GreaterThanOrEqualTo"
          • "GreaterThan"
          • "LessThan"
          • "LessThanOrEqualTo"
      • Goal — required — (map)

        This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

        • Interval — (map)

          The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

          If you omit this parameter, a rolling interval of 7 days is used.

          • RollingInterval — (map)

            If the interval is a rolling interval, this structure contains the interval specifications.

            • DurationUnit — required — (String)

              Specifies the rolling interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

          • CalendarInterval — (map)

            If the interval is a calendar interval, this structure contains the interval specifications.

            • StartTime — required — (Date)

              The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

              When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

              As soon as one calendar interval ends, another automatically begins.

            • DurationUnit — required — (String)

              Specifies the calendar interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

        • AttainmentGoal — (Float)

          The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

          If you omit this parameter, 99 is used to represent 99% as the attainment goal.

        • WarningThreshold — (Float)

          The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

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 */
  KeyAttributes: { /* required */
    '<KeyAttributeName>': 'STRING_VALUE',
    /* '<KeyAttributeName>': ... */
  },
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationsignals.listServiceDependencies(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 period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • EndTime — (Date)

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

  • KeyAttributes — (map<String>)

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken — (String)

    Include this value, if it was returned by the previous operation, to get the next set of service dependencies.

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:

    • StartTime — (Date)

      The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • EndTime — (Date)

      The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • ServiceDependencies — (Array<map>)

      An array, where each object in the array contains information about one of the dependencies of this service.

      • OperationName — required — (String)

        The name of the operation in this service that calls the dependency.

      • DependencyKeyAttributes — required — (map<String>)

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • DependencyOperationName — required — (String)

        The name of the called operation in the dependency.

      • MetricReferences — required — (Array<map>)

        An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.

        • Namespace — required — (String)

          The namespace of the metric. For more information, see CloudWatchNamespaces.

        • MetricType — required — (String)

          Used to display the appropriate statistics in the CloudWatch console.

        • Dimensions — (Array<map>)

          An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

          • Name — required — (String)

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

          • Value — required — (String)

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

        • MetricName — required — (String)

          The name of the metric.

    • NextToken — (String)

      Include this value in your next use of this API to get next set of service dependencies.

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 */
  KeyAttributes: { /* required */
    '<KeyAttributeName>': 'STRING_VALUE',
    /* '<KeyAttributeName>': ... */
  },
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationsignals.listServiceDependents(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 period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • EndTime — (Date)

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • KeyAttributes — (map<String>)

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken — (String)

    Include this value, if it was returned by the previous operation, to get the next set of service dependents.

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:

    • StartTime — (Date)

      The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • EndTime — (Date)

      The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • ServiceDependents — (Array<map>)

      An array, where each object in the array contains information about one of the dependents of this service.

      • OperationName — (String)

        If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.

      • DependentKeyAttributes — required — (map<String>)

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • DependentOperationName — (String)

        If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.

      • MetricReferences — required — (Array<map>)

        An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.

        • Namespace — required — (String)

          The namespace of the metric. For more information, see CloudWatchNamespaces.

        • MetricType — required — (String)

          Used to display the appropriate statistics in the CloudWatch console.

        • Dimensions — (Array<map>)

          An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

          • Name — required — (String)

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

          • Value — required — (String)

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

        • MetricName — required — (String)

          The name of the metric.

    • NextToken — (String)

      Include this value in your next use of this API to get next set of service dependents.

Returns:

• (AWS.Request) —

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

var params = {
  KeyAttributes: {
    '<KeyAttributeName>': 'STRING_VALUE',
    /* '<KeyAttributeName>': ... */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OperationName: 'STRING_VALUE'
};
applicationsignals.listServiceLevelObjectives(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: {}) —
  • KeyAttributes — (map<String>)

    You can use this optional field to specify which services you want to retrieve SLO information for.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • OperationName — (String)

    The name of the operation that this SLO is associated with.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken — (String)

    Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

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:

    • SloSummaries — (Array<map>)

      An array of structures, where each structure contains information about one SLO.

      • Arn — required — (String)

        The ARN of this service level objective.

      • Name — required — (String)

        The name of the service level objective.

      • KeyAttributes — (map<String>)

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this service level objective is for.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • OperationName — (String)

        If this service level objective is specific to a single operation, this field displays the name of that operation.

      • CreatedTime — (Date)

        The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

    • NextToken — (String)

      Include this value in your next use of this API to get next set of service level objectives.

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 */
  KeyAttributes: { /* required */
    '<KeyAttributeName>': 'STRING_VALUE',
    /* '<KeyAttributeName>': ... */
  },
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationsignals.listServiceOperations(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 period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • EndTime — (Date)

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

  • KeyAttributes — (map<String>)

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken — (String)

    Include this value, if it was returned by the previous operation, to get the next set of service operations.

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:

    • StartTime — (Date)

      The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • EndTime — (Date)

      The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • ServiceOperations — (Array<map>)

      An array of structures that each contain information about one operation of this service.

      • Name — required — (String)

        The name of the operation, discovered by Application Signals.

      • MetricReferences — required — (Array<map>)

        An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.

        • Namespace — required — (String)

          The namespace of the metric. For more information, see CloudWatchNamespaces.

        • MetricType — required — (String)

          Used to display the appropriate statistics in the CloudWatch console.

        • Dimensions — (Array<map>)

          An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

          • Name — required — (String)

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

          • Value — required — (String)

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

        • MetricName — required — (String)

          The name of the metric.

    • NextToken — (String)

      Include this value in your next use of this API to get next set of service operations.

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 */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationsignals.listServices(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 period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • EndTime — (Date)

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

  • NextToken — (String)

    Include this value, if it was returned by the previous operation, to get the next set of services.

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:

    • StartTime — (Date)

      The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • EndTime — (Date)

      The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

      This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

    • ServiceSummaries — (Array<map>)

      An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.

      • KeyAttributes — required — (map<String>)

        This is a string-to-string map that help identify the objects discovered by Application Signals. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • AttributeMaps — (Array<map<String>>)

        This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

        Platform attributes contain information the service's platform.

        • PlatformType defines the hosted-in platform.

        • EKS.Cluster is the name of the Amazon EKS cluster.

        • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

        • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

        • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

        • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

        • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

        • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

        • EC2.InstanceId is the ID of the Amazon EC2 instance.

        • Host is the name of the host, for all platform types.

        Applciation attributes contain information about the application.

        • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

        • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

        Telemetry attributes contain telemetry information.

        • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

        • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

        • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

      • MetricReferences — required — (Array<map>)

        An array of structures that each contain information about one metric associated with this service.

        • Namespace — required — (String)

          The namespace of the metric. For more information, see CloudWatchNamespaces.

        • MetricType — required — (String)

          Used to display the appropriate statistics in the CloudWatch console.

        • Dimensions — (Array<map>)

          An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

          • Name — required — (String)

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

          • Value — required — (String)

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

        • MetricName — required — (String)

          The name of the metric.

    • NextToken — (String)

      Include this value in your next use of this API to get next set of services.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
applicationsignals.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 CloudWatch resource that you want to view tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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 — (Array<map>)

      The list of tag keys and values associated with the resource you specified.

      • Key — required — (String)

        A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value — required — (String)

        The value for the specified tag key.

Returns:

• (AWS.Request) —

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

var params = {
};
applicationsignals.startDiscovery(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.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
applicationsignals.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 CloudWatch resource that you want to set tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

  • Tags — (Array<map>)

    The list of key-value pairs to associate with the alarm.

    • Key — required — (String)

      A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

    • Value — required — (String)

      The value for the specified tag key.

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 */
  ]
};
applicationsignals.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 CloudWatch resource that you want to delete tags from.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

  • TagKeys — (Array<String>)

    The list of tag keys to remove from the 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 = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Goal: {
    AttainmentGoal: 'NUMBER_VALUE',
    Interval: {
      CalendarInterval: {
        Duration: 'NUMBER_VALUE', /* required */
        DurationUnit: DAY | MONTH, /* required */
        StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
      },
      RollingInterval: {
        Duration: 'NUMBER_VALUE', /* required */
        DurationUnit: DAY | MONTH /* required */
      }
    },
    WarningThreshold: 'NUMBER_VALUE'
  },
  SliConfig: {
    ComparisonOperator: GreaterThanOrEqualTo | GreaterThan | LessThan | LessThanOrEqualTo, /* required */
    MetricThreshold: 'NUMBER_VALUE', /* required */
    SliMetricConfig: { /* required */
      KeyAttributes: {
        '<KeyAttributeName>': 'STRING_VALUE',
        /* '<KeyAttributeName>': ... */
      },
      MetricDataQueries: [
        {
          Id: 'STRING_VALUE', /* required */
          AccountId: 'STRING_VALUE',
          Expression: 'STRING_VALUE',
          Label: 'STRING_VALUE',
          MetricStat: {
            Metric: { /* required */
              Dimensions: [
                {
                  Name: 'STRING_VALUE', /* required */
                  Value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              MetricName: 'STRING_VALUE',
              Namespace: 'STRING_VALUE'
            },
            Period: 'NUMBER_VALUE', /* required */
            Stat: 'STRING_VALUE', /* required */
            Unit: Microseconds | Milliseconds | Seconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
          },
          Period: 'NUMBER_VALUE',
          ReturnData: true || false
        },
        /* more items */
      ],
      MetricType: LATENCY | AVAILABILITY,
      OperationName: 'STRING_VALUE',
      PeriodSeconds: 'NUMBER_VALUE',
      Statistic: 'STRING_VALUE'
    }
  }
};
applicationsignals.updateServiceLevelObjective(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: {}) —
  • Id — (String)

    The Amazon Resource Name (ARN) or name of the service level objective that you want to update.

  • Description — (String)

    An optional description for the SLO.

  • SliConfig — (map)

    A structure that contains information about what performance metric this SLO will monitor.

    • SliMetricConfig — required — (map)

      Use this structure to specify the metric to be used for the SLO.

      • KeyAttributes — (map<String>)

        If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

        This is a string-to-string map. It can include the following fields.

        • Type designates the type of object this is.

        • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

        • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

        • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

        • Environment specifies the location where this object is hosted, or what it belongs to.

      • OperationName — (String)

        If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

      • MetricType — (String)

        If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

        Possible values include:
        • "LATENCY"
        • "AVAILABILITY"
      • Statistic — (String)

        The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

      • PeriodSeconds — (Integer)

        The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

      • MetricDataQueries — (Array<map>)

        If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

        • Id — required — (String)

          A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

        • MetricStat — (map)

          A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

          Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Metric — required — (map)

            The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

            • Namespace — (String)

              The namespace of the metric. For more information, see Namespaces.

            • MetricName — (String)

              The name of the metric to use.

            • Dimensions — (Array<map>)

              An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

              • Name — required — (String)

                The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

              • Value — required — (String)

                The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

          • Period — required — (Integer)

            The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

          • Stat — required — (String)

            The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

          • Unit — (String)

            If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

            Possible values include:
            • "Microseconds"
            • "Milliseconds"
            • "Seconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Count"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
            • "None"
        • Expression — (String)

          This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

          A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

          Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

        • Label — (String)

          A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

          You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

        • ReturnData — (Boolean)

          Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

        • Period — (Integer)

          The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

          If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

          • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

          • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

          • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

        • AccountId — (String)

          The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

    • MetricThreshold — required — (Float)

      The value that the SLI metric is compared to.

    • ComparisonOperator — required — (String)

      The arithmetic operation to use when comparing the specified metric to the threshold.

      Possible values include:
      • "GreaterThanOrEqualTo"
      • "GreaterThan"
      • "LessThan"
      • "LessThanOrEqualTo"
  • Goal — (map)

    A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.

    • Interval — (map)

      The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

      If you omit this parameter, a rolling interval of 7 days is used.

      • RollingInterval — (map)

        If the interval is a rolling interval, this structure contains the interval specifications.

        • DurationUnit — required — (String)

          Specifies the rolling interval unit.

          Possible values include:
          • "DAY"
          • "MONTH"
        • Duration — required — (Integer)

          Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

      • CalendarInterval — (map)

        If the interval is a calendar interval, this structure contains the interval specifications.

        • StartTime — required — (Date)

          The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

          When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

          As soon as one calendar interval ends, another automatically begins.

        • DurationUnit — required — (String)

          Specifies the calendar interval unit.

          Possible values include:
          • "DAY"
          • "MONTH"
        • Duration — required — (Integer)

          Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

    • AttainmentGoal — (Float)

      The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

      If you omit this parameter, 99 is used to represent 99% as the attainment goal.

    • WarningThreshold — (Float)

      The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

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:

    • Slo — (map)

      A structure that contains information about the SLO that you just updated.

      • Arn — required — (String)

        The ARN of this SLO.

      • Name — required — (String)

        The name of this SLO.

      • Description — (String)

        The description that you created for this SLO.

      • CreatedTime — required — (Date)

        The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • LastUpdatedTime — required — (Date)

        The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

      • Sli — required — (map)

        A structure containing information about the performance metric that this SLO monitors.

        • SliMetric — required — (map)

          A structure that contains information about the metric that the SLO monitors.

          • KeyAttributes — (map<String>)

            This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

            • Type designates the type of object that this SLO is related to.

            • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

            • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

            • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

            • Environment specifies the location where this object is hosted, or what it belongs to.

          • OperationName — (String)

            If the SLO monitors a specific operation of the service, this field displays that operation name.

          • MetricType — (String)

            If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

            Possible values include:
            • "LATENCY"
            • "AVAILABILITY"
          • MetricDataQueries — required — (Array<map>)

            If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.

            • Id — required — (String)

              A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

            • MetricStat — (map)

              A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

              Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

              • Metric — required — (map)

                The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

                • Namespace — (String)

                  The namespace of the metric. For more information, see Namespaces.

                • MetricName — (String)

                  The name of the metric to use.

                • Dimensions — (Array<map>)

                  An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

                  • Name — required — (String)

                    The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

                  • Value — required — (String)

                    The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

              • Period — required — (Integer)

                The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              • Stat — required — (String)

                The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

              • Unit — (String)

                If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

                Possible values include:
                • "Microseconds"
                • "Milliseconds"
                • "Seconds"
                • "Bytes"
                • "Kilobytes"
                • "Megabytes"
                • "Gigabytes"
                • "Terabytes"
                • "Bits"
                • "Kilobits"
                • "Megabits"
                • "Gigabits"
                • "Terabits"
                • "Percent"
                • "Count"
                • "Bytes/Second"
                • "Kilobytes/Second"
                • "Megabytes/Second"
                • "Gigabytes/Second"
                • "Terabytes/Second"
                • "Bits/Second"
                • "Kilobits/Second"
                • "Megabits/Second"
                • "Gigabits/Second"
                • "Terabits/Second"
                • "Count/Second"
                • "None"
            • Expression — (String)

              This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

              A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

              Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Label — (String)

              A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

              You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

            • ReturnData — (Boolean)

              Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

            • Period — (Integer)

              The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

              • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

              • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

              • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

            • AccountId — (String)

              The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.

        • MetricThreshold — required — (Float)

          The value that the SLI metric is compared to.

        • ComparisonOperator — required — (String)

          The arithmetic operation used when comparing the specified metric to the threshold.

          Possible values include:
          • "GreaterThanOrEqualTo"
          • "GreaterThan"
          • "LessThan"
          • "LessThanOrEqualTo"
      • Goal — required — (map)

        This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

        • Interval — (map)

          The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

          If you omit this parameter, a rolling interval of 7 days is used.

          • RollingInterval — (map)

            If the interval is a rolling interval, this structure contains the interval specifications.

            • DurationUnit — required — (String)

              Specifies the rolling interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

          • CalendarInterval — (map)

            If the interval is a calendar interval, this structure contains the interval specifications.

            • StartTime — required — (Date)

              The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

              When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

              As soon as one calendar interval ends, another automatically begins.

            • DurationUnit — required — (String)

              Specifies the calendar interval unit.

              Possible values include:
              • "DAY"
              • "MONTH"
            • Duration — required — (Integer)

              Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

        • AttainmentGoal — (Float)

          The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

          If you omit this parameter, 99 is used to represent 99% as the attainment goal.

        • WarningThreshold — (Float)

          The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

Returns:

• (AWS.Request) —

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