CloudWatchApplicationSignals / Client / list_service_dependents

list_service_dependents#

CloudWatchApplicationSignals.Client.list_service_dependents(**kwargs)#

Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

Request Syntax

response = client.list_service_dependents(
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    KeyAttributes={
        'string': 'string'
    },
    MaxResults=123,
    NextToken='string'
)

Parameters:

StartTime (datetime) –
[REQUIRED]

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 (datetime) –
[REQUIRED]

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 (dict) –
[REQUIRED]

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.
- (string) –
  - (string) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'ServiceDependents': [
        {
            'OperationName': 'string',
            'DependentKeyAttributes': {
                'string': 'string'
            },
            'DependentOperationName': 'string',
            'MetricReferences': [
                {
                    'Namespace': 'string',
                    'MetricType': 'string',
                    'Dimensions': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ],
                    'MetricName': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- StartTime (datetime) –
  
  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 (datetime) –
  
  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 (list) –
  
  An array, where each object in the array contains information about one of the dependents of this service.
  - (dict) –
    
    This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
    - OperationName (string) –
      
      If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
    - DependentKeyAttributes (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) –
    - 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 (list) –
      
      An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
      - (dict) –
        
        This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
        
        Namespace (string) –
        
        The namespace of the metric. For more information, see CloudWatchNamespaces.
        
        MetricType (string) –
        
        Used to display the appropriate statistics in the CloudWatch console.
        
        Dimensions (list) –
        
        An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
        
        (dict) –
        
        A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
        
        You can assign up to 30 dimensions to a metric.
        
        Name (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 (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 (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.

Exceptions

CloudWatchApplicationSignals.Client.exceptions.ValidationException
CloudWatchApplicationSignals.Client.exceptions.ThrottlingException