Skip to content

list_notification_configurations

list_notification_configurations(
    *,
    config_overrides: Optional[NotificationsClientConfig] = None,
    event_rule_source: Optional[Source] = None,
    channel_arn: Optional[ChannelArn] = None,
    status: Optional[NotificationConfigurationStatus] = None,
    subtype: Optional[NotificationConfigurationSubtype] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
) -> ListNotificationConfigurationsResponse

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

Parameters:

  • event_rule_source (Optional[Source], default: None ) –

    The matched event source.

    Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

  • channel_arn (Optional[ChannelArn], default: None ) –

    The Amazon Resource Name (ARN) of the Channel to match.

  • status (Optional[NotificationConfigurationStatus], default: None ) –

    The NotificationConfiguration status to match.

    • Values:

      • ACTIVE

        • All EventRules are ACTIVE and any call can be run.

      • PARTIALLY_ACTIVE

        • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        • Any call can be run.

      • INACTIVE

        • All EventRules are INACTIVE and any call can be run.

      • DELETING

        • This NotificationConfiguration is being deleted.

        • Only GET and LIST calls can be run.

  • subtype (Optional[NotificationConfigurationSubtype], default: None ) –

    The subtype used to filter the notification configurations in the request.

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

    The maximum number of results to be returned in this call. Defaults to 20.

  • next_token (Optional[NextToken], default: None ) –

    The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

Raises:

Source code in docs_src/capo_notifications/_services/notifications.py
def list_notification_configurations(
    self,
    *,
    config_overrides: Optional[NotificationsClientConfig] = None,
    event_rule_source: Optional["capo_notifications.types.source.Source"] = None,
    channel_arn: Optional["capo_notifications.types.channel_arn.ChannelArn"] = None,
    status: Optional[
        "capo_notifications.types.notification_configuration_status.NotificationConfigurationStatus"
    ] = None,
    subtype: Optional[
        "capo_notifications.types.notification_configuration_subtype.NotificationConfigurationSubtype"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_notifications.types.next_token.NextToken"] = None,
) -> "capo_notifications.types.list_notification_configurations_response.ListNotificationConfigurationsResponse":
    """<p>Returns a list of abbreviated <code>NotificationConfigurations</code> according to specified filters, in reverse chronological order (newest first).</p>

    Args:
        event_rule_source: <p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
        channel_arn: <p>The Amazon Resource Name (ARN) of the Channel to match.</p>
        status: <p>The <code>NotificationConfiguration</code> status to match.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This <code>NotificationConfiguration</code> is being deleted.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>
        subtype: <p>The subtype used to filter the notification configurations in the request.</p>
        max_results: <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
        next_token: <p>The start token for paginated calls. Retrieved from the response of a previous <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>

    Raises:
        capo_notifications.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_notifications.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_notifications.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling. </p>
        capo_notifications.errors.validation_exception.ValidationException: <p>This exception is thrown when the notification event fails validation.</p>
        capo_notifications.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_notifications.types.list_notification_configurations_request.ListNotificationConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_notifications.types.list_notification_configurations_response.ListNotificationConfigurationsResponse"
    ]:
        import capo_notifications._operations.notifications.list_notification_configurations

        output, http_response = (
            capo_notifications._operations.notifications.list_notification_configurations.list_notification_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNotificationConfigurations")
    )
    input_: capo_notifications.types.list_notification_configurations_request.ListNotificationConfigurationsRequest = {}
    if event_rule_source is not None:
        input_["event_rule_source"] = event_rule_source
    if channel_arn is not None:
        input_["channel_arn"] = channel_arn
    if status is not None:
        input_["status"] = status
    if subtype is not None:
        input_["subtype"] = subtype
    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