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:
-
next_token
(Optional[NextToken], default:
None
)
–
Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.
-
aws_account_id
(Optional[AwsAccountId], default:
None
)
–
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.
-
include_linked_accounts
(Optional[bool], default:
None
)
–
If you are using this operation in a monitoring account, specify true to include grouping attributes from source accounts in the returned data.
Raises:
Source code in docs_src/capo_application_signals/_services/application_signals.py
| def list_grouping_attribute_definitions(
self,
*,
config_overrides: Optional[ApplicationSignalsClientConfig] = None,
next_token: Optional[
"capo_application_signals.types.next_token.NextToken"
] = None,
aws_account_id: Optional[
"capo_application_signals.types.aws_account_id.AwsAccountId"
] = None,
include_linked_accounts: Optional[bool] = None,
) -> "capo_application_signals.types.list_grouping_attribute_definitions_output.ListGroupingAttributeDefinitionsOutput":
"""<p>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.</p>
Args:
next_token: <p>Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.</p>
aws_account_id: <p>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.</p>
include_linked_accounts: <p>If you are using this operation in a monitoring account, specify <code>true</code> to include grouping attributes from source accounts in the returned data.</p>
Raises:
capo_application_signals.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
capo_application_signals.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
capo_application_signals.errors.validation_exception.ValidationException: <p>The resource is not valid.</p>
capo_application_signals.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_application_signals.types.list_grouping_attribute_definitions_input.ListGroupingAttributeDefinitionsInput]",
) -> OperationResponse[
"capo_application_signals.types.list_grouping_attribute_definitions_output.ListGroupingAttributeDefinitionsOutput"
]:
import capo_application_signals._operations.application_signals.list_grouping_attribute_definitions
output, http_response = (
capo_application_signals._operations.application_signals.list_grouping_attribute_definitions.list_grouping_attribute_definitions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListGroupingAttributeDefinitions")
)
input_: capo_application_signals.types.list_grouping_attribute_definitions_input.ListGroupingAttributeDefinitionsInput = {}
if next_token is not None:
input_["next_token"] = next_token
if aws_account_id is not None:
input_["aws_account_id"] = aws_account_id
if include_linked_accounts is not None:
input_["include_linked_accounts"] = include_linked_accounts
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|