CloudWatchApplicationSignals / Paginator / ListServiceLevelObjectives

ListServiceLevelObjectives¶

class CloudWatchApplicationSignals.Paginator.ListServiceLevelObjectives¶

paginator = client.get_paginator('list_service_level_objectives')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudWatchApplicationSignals.Client.list_service_level_objectives().

Request Syntax

response_iterator = paginator.paginate(
    KeyAttributes={
        'string': 'string'
    },
    OperationName='string',
    DependencyConfig={
        'DependencyKeyAttributes': {
            'string': 'string'
        },
        'DependencyOperationName': 'string'
    },
    MetricSourceTypes=[
        'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency',
    ],
    IncludeLinkedAccounts=True|False,
    SloOwnerAwsAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.
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) –
IncludeLinkedAccounts (boolean) – 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 (string) – SLO’s Amazon Web Services account ID.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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

}

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