grouping_attribute_definitions
Creates, updates, deletes, gets or lists a grouping_attribute_definitions resource.
Overview
| Name | grouping_attribute_definitions |
| Type | Resource |
| Id | aws.application_signals.grouping_attribute_definitions |
Fields
The following fields are returned by SELECT queries:
- list_grouping_attribute_definitions
| Name | Datatype | Description |
|---|---|---|
grouping_attribute_definitions | array | An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values. |
next_token | string | Include this value in your next use of this API to get the next set of grouping attribute definitions. |
updated_at | string (date-time) | The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_grouping_attribute_definitions | select | region | NextToken, AwsAccountId, IncludeLinkedAccounts | Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
AwsAccountId | string | The Amazon Web Services account ID to retrieve grouping attribute definitions for. Use this when accessing grouping configurations from a different account in cross-account monitoring scenarios. |
IncludeLinkedAccounts | boolean | If you are using this operation in a monitoring account, specify true to include grouping attributes from source accounts in the returned data. |
NextToken | string | Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions. |
SELECT examples
- list_grouping_attribute_definitions
Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.
SELECT
grouping_attribute_definitions,
next_token,
updated_at
FROM aws.application_signals.grouping_attribute_definitions
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND AwsAccountId = '{{ AwsAccountId }}'
AND IncludeLinkedAccounts = '{{ IncludeLinkedAccounts }}'
;