Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.
Parameters:
-
rule_name_prefix
(Optional[str], default:
None
)
–
A string to filter telemetry rules whose names begin with the specified prefix.
-
max_results
(Optional[ListTelemetryRulesMaxResults], default:
None
)
–
The maximum number of telemetry rules to return in a single call.
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next set of results. A previous call generates this token.
Raises:
Source code in docs_src/capo_observabilityadmin/_services/observability_admin.py
| def list_telemetry_rules(
self,
*,
config_overrides: Optional[ObservabilityAdminClientConfig] = None,
rule_name_prefix: Optional[str] = None,
max_results: Optional[
"capo_observabilityadmin.types.list_telemetry_rules_max_results.ListTelemetryRulesMaxResults"
] = None,
next_token: Optional[
"capo_observabilityadmin.types.next_token.NextToken"
] = None,
) -> "capo_observabilityadmin.types.list_telemetry_rules_output.ListTelemetryRulesOutput":
"""<p> Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix. </p>
Args:
rule_name_prefix: <p> A string to filter telemetry rules whose names begin with the specified prefix. </p>
max_results: <p> The maximum number of telemetry rules to return in a single call. </p>
next_token: <p> The token for the next set of results. A previous call generates this token. </p>
Raises:
capo_observabilityadmin.errors.access_denied_exception.AccessDeniedException: <p> Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
capo_observabilityadmin.errors.internal_server_exception.InternalServerException: <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
capo_observabilityadmin.errors.too_many_requests_exception.TooManyRequestsException: <p> The request throughput limit was exceeded. </p>
capo_observabilityadmin.errors.validation_exception.ValidationException: <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
capo_observabilityadmin.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_observabilityadmin.types.list_telemetry_rules_input.ListTelemetryRulesInput]",
) -> OperationResponse[
"capo_observabilityadmin.types.list_telemetry_rules_output.ListTelemetryRulesOutput"
]:
import capo_observabilityadmin._operations.observability_admin.list_telemetry_rules
output, http_response = (
capo_observabilityadmin._operations.observability_admin.list_telemetry_rules.list_telemetry_rules(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListTelemetryRules")
)
input_: capo_observabilityadmin.types.list_telemetry_rules_input.ListTelemetryRulesInput = {}
if rule_name_prefix is not None:
input_["rule_name_prefix"] = rule_name_prefix
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|