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',
    IncludeLinkedAccounts=True|False,
    SloOwnerAwsAccountId='string',
    MetricSourceTypes=[
        'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency',
    ]
)
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.

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

  • 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

    • CloudWatch metric

    • (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'
        },
    ],
    '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

          • CloudWatch metric

    • NextToken (string) –

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

Exceptions

  • CloudWatchApplicationSignals.Client.exceptions.ValidationException

  • CloudWatchApplicationSignals.Client.exceptions.ThrottlingException