CloudWatchApplicationSignals / Client / list_service_level_objectives

list_service_level_objectives

CloudWatchApplicationSignals.Client.list_service_level_objectives(**kwargs)

Returns a list of SLOs created in this account.

See also: AWS API Documentation

Request Syntax

response = client.list_service_level_objectives(
    KeyAttributes={
        'string': 'string'
    },
    OperationName='string',
    DependencyConfig={
        'DependencyKeyAttributes': {
            'string': 'string'
        },
        'DependencyOperationName': 'string'
    },
    MaxResults=123,
    NextToken='string',
    MetricSourceTypes=[
        'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency'|'AppMonitor'|'Canary'|'Service',
    ],
    IncludeLinkedAccounts=True|False,
    SloOwnerAwsAccountId='string',
    MetricSource={
        'MetricSourceKeyAttributes': {
            'string': 'string'
        },
        'MetricSourceAttributes': {
            'string': 'string'
        }
    }
)
Parameters:

  • KeyAttributes (dict) –

    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.

    • (string) –

      • (string) –

  • OperationName (string) – The name of the operation that this SLO is associated with.

  • DependencyConfig (dict) –

    Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

    • DependencyKeyAttributes (dict) – [REQUIRED]

      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.

      • (string) –

        • (string) –

    • DependencyOperationName (string) – [REQUIRED]

      The name of the called operation in the dependency.

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

  • MetricSourceTypes (list) –

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

    • Service operation

    • Service dependency

    • Service

    • CloudWatch metric

    • AppMonitor

    • Canary

    • (string) –

  • IncludeLinkedAccounts (boolean) –

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

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

  • SloOwnerAwsAccountId (string) – SLO’s Amazon Web Services account ID.

  • MetricSource (dict) –

    Identifies the metric source to filter SLOs by.

    • MetricSourceKeyAttributes (dict) – [REQUIRED]

      Key attributes that identify the metric source.

      • (string) –

        • (string) –

    • MetricSourceAttributes (dict) –

      Additional attributes for the metric source.

      • (string) –

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SloSummaries': [
        {
            'Arn': 'string',
            'Name': 'string',
            'KeyAttributes': {
                'string': 'string'
            },
            'OperationName': 'string',
            'DependencyConfig': {
                'DependencyKeyAttributes': {
                    'string': 'string'
                },
                'DependencyOperationName': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1),
            'EvaluationType': 'PeriodBased'|'RequestBased',
            'MetricSourceType': 'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency'|'AppMonitor'|'Canary'|'Service',
            'MetricSource': {
                'MetricSourceKeyAttributes': {
                    'string': 'string'
                },
                'MetricSourceAttributes': {
                    'string': 'string'
                }
            },
            'CompositeSliConfig': {
                'SelectionConfig': {
                    'Type': 'EXPLICIT'|'PREFIX'|'REGEX',
                    'Pattern': 'string'
                },
                'Components': [
                    {
                        'OperationName': 'string'
                    },
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SloSummaries (list) –

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

      • (dict) –

        A structure that contains information about one service level objective (SLO) created in Application Signals.

        • Arn (string) –

          The ARN of this service level objective.

        • Name (string) –

          The name of the service level objective.

        • KeyAttributes (dict) –

          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.

          • (string) –

            • (string) –

        • OperationName (string) –

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

        • DependencyConfig (dict) –

          Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

          • DependencyKeyAttributes (dict) –

            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.

            • (string) –

              • (string) –

          • DependencyOperationName (string) –

            The name of the called operation in the dependency.

        • CreatedTime (datetime) –

          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.

        • EvaluationType (string) –

          Displays whether this is a period-based SLO or a request-based SLO.

        • MetricSourceType (string) –

          Displays the SLI metric source type for this SLO. Supported types are:

          • Service operation

          • Service dependency

          • Service

          • CloudWatch metric

          • AppMonitor

          • Canary

        • MetricSource (dict) –

          Identifies the metric source for SLOs on resources other than Application Signals services.

          • MetricSourceKeyAttributes (dict) –

            Key attributes that identify the metric source.

            • (string) –

              • (string) –

          • MetricSourceAttributes (dict) –

            Additional attributes for the metric source.

            • (string) –

              • (string) –

        • CompositeSliConfig (dict) –

          The composite SLI configuration for service-level SLOs that monitor multiple operations of a service.

          • SelectionConfig (dict) –

            Specifies how operations are selected for this service-level SLO. Operations can be selected explicitly by listing them, by specifying a prefix to match operation names, or by providing a regular expression pattern.

            • Type (string) –

              The strategy for selecting operations to include in a service-level SLO.

              • EXPLICIT — You provide a specific list of operations in the Components field of CompositeSliConfig.

              • PREFIX — You provide a prefix string in the Pattern field of SelectionConfig, and all operations whose names start with the prefix are included.

              • REGEX — You provide a regular expression in the Pattern field of SelectionConfig, and all operations whose names match the pattern are included.

            • Pattern (string) –

              A prefix string or regular expression that specifies which operations to include in a service-level SLO. When SelectionType is PREFIX, this value is a prefix string that matches the beginning of operation names. When SelectionType is REGEX, this value is a regular expression that matches operation names.

          • Components (list) –

            The list of operations included in this composite SLI. You must specify between 2 and 20 components. Each component is a CompositeSliComponent that identifies a single operation by its OperationName.

            • (dict) –

              Identifies a single operation to include in a composite SLI for a service-level SLO. Used as an element of the Components list in CompositeSliConfig.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: OperationName. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • OperationName (string) –

                The name of the operation to include in the composite SLI.

    • NextToken (string) –

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

Exceptions