2025/02/26 - Amazon CloudWatch Application Signals - 6 updated api methods
Changes This release adds API support for reading Service Level Objectives and Services from monitoring accounts, from SLO and Service-scoped operations, including ListServices and ListServiceLevelObjectives.
{'Service': {'MetricReferences': {'AccountId': 'string'}}}
Returns information about a service discovered by Application Signals.
See also: AWS API Documentation
Request Syntax
client.get_service(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
}
)
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.
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.
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) --
dict
Response Syntax
{
'Service': {
'KeyAttributes': {
'string': 'string'
},
'AttributeMaps': [
{
'string': 'string'
},
],
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': 'string'
},
],
'LogGroupReferences': [
{
'string': 'string'
},
]
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'LogGroupReferences': [
{
'string': 'string'
},
]
}
Response Structure
(dict) --
Service (dict) --
A structure containing information about the service.
KeyAttributes (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) --
AttributeMaps (list) --
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
(dict) --
(string) --
(string) --
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service.
(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.
AccountId (string) --
Amazon Web Services account ID.
LogGroupReferences (list) --
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
"Type": "AWS::Resource"
"ResourceType": "AWS::Logs::LogGroup"
"Identifier": "name-of-log-group"
(dict) --
(string) --
(string) --
StartTime (datetime) --
The start time of the data included in the response. 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 time of the data included in the response. 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.
LogGroupReferences (list) --
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
"Type": "AWS::Resource"
"ResourceType": "AWS::Logs::LogGroup"
"Identifier": "name-of-log-group"
(dict) --
(string) --
(string) --
{'ServiceDependencies': {'MetricReferences': {'AccountId': 'string'}}}
Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
See also: AWS API Documentation
Request Syntax
client.list_service_dependencies(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='string'
)
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.
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 end time will be rounded to the nearest hour.
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) --
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of service dependencies.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceDependencies': [
{
'OperationName': 'string',
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string',
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': '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.
ServiceDependencies (list) --
An array, where each object in the array contains information about one of the dependencies of this service.
(dict) --
This structure contains information about one dependency of this service.
OperationName (string) --
The name of the operation in this service that calls the dependency.
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.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service dependency 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.
AccountId (string) --
Amazon Web Services account ID.
NextToken (string) --
Include this value in your next use of this API to get next set of service dependencies.
{'ServiceDependents': {'MetricReferences': {'AccountId': 'string'}}}
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.
See also: AWS API Documentation
Request Syntax
client.list_service_dependents(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='string'
)
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.
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.
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) --
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of service dependents.
dict
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',
'AccountId': '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.
AccountId (string) --
Amazon Web Services account ID.
NextToken (string) --
Include this value in your next use of this API to get next set of service dependents.
{'IncludeLinkedAccounts': 'boolean', 'SloOwnerAwsAccountId': 'string'}
Returns a list of SLOs created in this account.
See also: AWS API Documentation
Request Syntax
client.list_service_level_objectives(
KeyAttributes={
'string': 'string'
},
OperationName='string',
MaxResults=123,
NextToken='string',
IncludeLinkedAccounts=True|False,
SloOwnerAwsAccountId='string'
)
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) --
string
The name of the operation that this SLO is associated with.
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
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>
string
SLO's Amazon Web Services account ID.
dict
Response Syntax
{
'SloSummaries': [
{
'Arn': 'string',
'Name': 'string',
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'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.
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.
NextToken (string) --
Include this value in your next use of this API to get next set of service level objectives.
{'ServiceOperations': {'MetricReferences': {'AccountId': 'string'}}}
Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.
See also: AWS API Documentation
Request Syntax
client.list_service_operations(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='string'
)
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.
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 end time will be rounded to the nearest hour.
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) --
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of service operations.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceOperations': [
{
'Name': 'string',
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': '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.
ServiceOperations (list) --
An array of structures that each contain information about one operation of this service.
(dict) --
This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.
Name (string) --
The name of the operation, discovered by Application Signals.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service operation 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.
AccountId (string) --
Amazon Web Services account ID.
NextToken (string) --
Include this value in your next use of this API to get next set of service operations.
{'AwsAccountId': 'string', 'IncludeLinkedAccounts': 'boolean'}
Response {'ServiceSummaries': {'MetricReferences': {'AccountId': 'string'}}}
Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
See also: AWS API Documentation
Request Syntax
client.list_services(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
IncludeLinkedAccounts=True|False,
AwsAccountId='string'
)
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.
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.
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of services.
boolean
If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data. </p>
string
Amazon Web Services Account ID.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceSummaries': [
{
'KeyAttributes': {
'string': 'string'
},
'AttributeMaps': [
{
'string': 'string'
},
],
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': '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.
ServiceSummaries (list) --
An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.
(dict) --
This structure contains information about one of your services that was discovered by Application Signals
KeyAttributes (dict) --
This is a string-to-string map that help identify the objects discovered by Application Signals. 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) --
AttributeMaps (list) --
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
(dict) --
(string) --
(string) --
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service.
(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.
AccountId (string) --
Amazon Web Services account ID.
NextToken (string) --
Include this value in your next use of this API to get next set of services.