Skip to content

List Service Level Objectives

cloudwatchapplicationsignals_list_service_level_objectives R Documentation

Returns a list of SLOs created in this account

Description

Returns a list of SLOs created in this account.

Usage

cloudwatchapplicationsignals_list_service_level_objectives(
  KeyAttributes, OperationName, DependencyConfig, MaxResults, NextToken,
  MetricSourceTypes, IncludeLinkedAccounts, SloOwnerAwsAccountId)

Arguments

KeyAttributes

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

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

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
MaxResults

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

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

Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

  • Service operation

  • Service dependency

  • CloudWatch metric
IncludeLinkedAccounts

If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data.

 </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>
SloOwnerAwsAccountId

SLO's Amazon Web Services account ID.

Value

A list with the following syntax:

list(
  SloSummaries = list(
    list(
      Arn = "string",
      Name = "string",
      KeyAttributes = list(
        "string"
      ),
      OperationName = "string",
      DependencyConfig = list(
        DependencyKeyAttributes = list(
          "string"
        ),
        DependencyOperationName = "string"
      ),
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      EvaluationType = "PeriodBased"|"RequestBased",
      MetricSourceType = "ServiceOperation"|"CloudWatchMetric"|"ServiceDependency"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_service_level_objectives(
  KeyAttributes = list(
    "string"
  ),
  OperationName = "string",
  DependencyConfig = list(
    DependencyKeyAttributes = list(
      "string"
    ),
    DependencyOperationName = "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  MetricSourceTypes = list(
    "ServiceOperation"|"CloudWatchMetric"|"ServiceDependency"
  ),
  IncludeLinkedAccounts = TRUE|FALSE,
  SloOwnerAwsAccountId = "string"
)