list_alarm_mute_rules `async` ¶

list_alarm_mute_rules(
    *,
    config_overrides: Optional[AsyncCloudWatchClientConfig] = None,
    alarm_name: Optional[Name] = None,
    statuses: Optional[AlarmMuteRuleStatuses] = None,
    max_records: Optional[MaxRecords] = None,
    next_token: Optional[NextToken] = None,
) -> ListAlarmMuteRulesOutput

Lists alarm mute rules in your Amazon Web Services account and region.

You can filter the results by alarm name to find all mute rules targeting a specific alarm, or by status to find rules that are scheduled, active, or expired.

This operation supports pagination for accounts with many mute rules. Use the MaxRecords and NextToken parameters to retrieve results in multiple calls.

Permissions

To list mute rules, you need the cloudwatch:ListAlarmMuteRules permission.

Parameters:

alarm_name (Optional[Name], default: None ) –

Filter results to show only mute rules that target the specified alarm name.
statuses (Optional[AlarmMuteRuleStatuses], default: None ) –

Filter results to show only mute rules with the specified statuses. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
max_records (Optional[MaxRecords], default: None ) –

The maximum number of mute rules to return in one call. The default is 50.
next_token (Optional[NextToken], default: None ) –

The token returned from a previous call to indicate where to continue retrieving results.

Raises:

InvalidNextToken –

The next token specified is invalid.
ResourceNotFoundException –

The named resource does not exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cloudwatch/_services/async_cloud_watch.py

async def list_alarm_mute_rules(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchClientConfig] = None,
    alarm_name: Optional["capo_cloudwatch.types.name.Name"] = None,
    statuses: Optional[
        "capo_cloudwatch.types.alarm_mute_rule_statuses.AlarmMuteRuleStatuses"
    ] = None,
    max_records: Optional["capo_cloudwatch.types.max_records.MaxRecords"] = None,
    next_token: Optional["capo_cloudwatch.types.next_token.NextToken"] = None,
) -> "capo_cloudwatch.types.list_alarm_mute_rules_output.ListAlarmMuteRulesOutput":
    """<p>Lists alarm mute rules in your Amazon Web Services account and region.</p> <p>You can filter the results by alarm name to find all mute rules targeting a specific alarm, or by status to find rules that are scheduled, active, or expired.</p> <p>This operation supports pagination for accounts with many mute rules. Use the <code>MaxRecords</code> and <code>NextToken</code> parameters to retrieve results in multiple calls.</p> <p> <b>Permissions</b> </p> <p>To list mute rules, you need the <code>cloudwatch:ListAlarmMuteRules</code> permission.</p>

    Args:
        alarm_name: <p>Filter results to show only mute rules that target the specified alarm name.</p>
        statuses: <p>Filter results to show only mute rules with the specified statuses. Valid values are <code>SCHEDULED</code>, <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
        max_records: <p>The maximum number of mute rules to return in one call. The default is 50.</p>
        next_token: <p>The token returned from a previous call to indicate where to continue retrieving results.</p>

    Raises:
        capo_cloudwatch.errors.invalid_next_token.InvalidNextToken: <p>The next token specified is invalid.</p>
        capo_cloudwatch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The named resource does not exist.</p>
        capo_cloudwatch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch.types.list_alarm_mute_rules_input.ListAlarmMuteRulesInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch.types.list_alarm_mute_rules_output.ListAlarmMuteRulesOutput"
    ]:
        import capo_cloudwatch._operations.granite_service_version20100801.list_alarm_mute_rules

        (
            output,
            http_response,
        ) = await capo_cloudwatch._operations.granite_service_version20100801.list_alarm_mute_rules.async_list_alarm_mute_rules(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAlarmMuteRules")
    )
    input_: capo_cloudwatch.types.list_alarm_mute_rules_input.ListAlarmMuteRulesInput = {}
    if alarm_name is not None:
        input_["alarm_name"] = alarm_name
    if statuses is not None:
        input_["statuses"] = statuses
    if max_records is not None:
        input_["max_records"] = max_records
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_alarm_mute_rules async ¶

list_alarm_mute_rules `async` ¶