Skip to content

list_telemetry_rules_for_organization

list_telemetry_rules_for_organization(
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
    rule_name_prefix: Optional[str] = None,
    source_account_ids: Optional[AccountIdentifiers] = None,
    source_organization_unit_ids: Optional[OrganizationUnitIdentifiers] = None,
    max_results: Optional[ListTelemetryRulesForOrganizationMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListTelemetryRulesForOrganizationOutput

Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

  • rule_name_prefix (Optional[str], default: None ) –

    A string to filter organization telemetry rules whose names begin with the specified prefix.

  • source_account_ids (Optional[AccountIdentifiers], default: None ) –

    The list of account IDs to filter organization telemetry rules by their source accounts.

  • source_organization_unit_ids (Optional[OrganizationUnitIdentifiers], default: None ) –

    The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.

  • max_results (Optional[ListTelemetryRulesForOrganizationMaxResults], default: None ) –

    The maximum number of organization 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_for_organization(
    self,
    *,
    config_overrides: Optional[ObservabilityAdminClientConfig] = None,
    rule_name_prefix: Optional[str] = None,
    source_account_ids: Optional[
        "capo_observabilityadmin.types.account_identifiers.AccountIdentifiers"
    ] = None,
    source_organization_unit_ids: Optional[
        "capo_observabilityadmin.types.organization_unit_identifiers.OrganizationUnitIdentifiers"
    ] = None,
    max_results: Optional[
        "capo_observabilityadmin.types.list_telemetry_rules_for_organization_max_results.ListTelemetryRulesForOrganizationMaxResults"
    ] = None,
    next_token: Optional[
        "capo_observabilityadmin.types.next_token.NextToken"
    ] = None,
) -> "capo_observabilityadmin.types.list_telemetry_rules_for_organization_output.ListTelemetryRulesForOrganizationOutput":
    """<p> Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account. </p>

    Args:
        rule_name_prefix: <p> A string to filter organization telemetry rules whose names begin with the specified prefix. </p>
        source_account_ids: <p> The list of account IDs to filter organization telemetry rules by their source accounts. </p>
        source_organization_unit_ids: <p> The list of organizational unit IDs to filter organization telemetry rules by their source organizational units. </p>
        max_results: <p> The maximum number of organization 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_for_organization_input.ListTelemetryRulesForOrganizationInput]",
    ) -> OperationResponse[
        "capo_observabilityadmin.types.list_telemetry_rules_for_organization_output.ListTelemetryRulesForOrganizationOutput"
    ]:
        import capo_observabilityadmin._operations.observability_admin.list_telemetry_rules_for_organization

        output, http_response = (
            capo_observabilityadmin._operations.observability_admin.list_telemetry_rules_for_organization.list_telemetry_rules_for_organization(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTelemetryRulesForOrganization")
    )
    input_: capo_observabilityadmin.types.list_telemetry_rules_for_organization_input.ListTelemetryRulesForOrganizationInput = {}
    if rule_name_prefix is not None:
        input_["rule_name_prefix"] = rule_name_prefix
    if source_account_ids is not None:
        input_["source_account_ids"] = source_account_ids
    if source_organization_unit_ids is not None:
        input_["source_organization_unit_ids"] = source_organization_unit_ids
    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