Returns a list of Channels for a NotificationConfiguration.
Parameters:
-
notification_configuration_arn
(NotificationConfigurationArn)
–
The Amazon Resource Name (ARN) of the NotificationConfiguration.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of results to be returned in this call. The default value is 20.
-
next_token
(Optional[NextToken], default:
None
)
–
The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.
Raises:
Source code in docs_src/capo_notifications/_services/notifications.py
| def list_channels(
self,
notification_configuration_arn: "capo_notifications.types.notification_configuration_arn.NotificationConfigurationArn",
*,
config_overrides: Optional[NotificationsClientConfig] = None,
max_results: Optional[int] = None,
next_token: Optional["capo_notifications.types.next_token.NextToken"] = None,
) -> "capo_notifications.types.list_channels_response.ListChannelsResponse":
"""<p>Returns a list of Channels for a <code>NotificationConfiguration</code>.</p>
Args:
notification_configuration_arn: <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>
max_results: <p>The maximum number of results to be returned in this call. The default value is 20.</p>
next_token: <p>The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. <code>NextToken</code> 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.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist. </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_channels_request.ListChannelsRequest]",
) -> OperationResponse[
"capo_notifications.types.list_channels_response.ListChannelsResponse"
]:
import capo_notifications._operations.notifications.list_channels
output, http_response = (
capo_notifications._operations.notifications.list_channels.list_channels(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListChannels")
)
input_: capo_notifications.types.list_channels_request.ListChannelsRequest = {
"notification_configuration_arn": notification_configuration_arn
}
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
|