Skip to content

ListNotificationsInput

Source code in docs_src/capo_datazone/types/list_notifications_input.py
class ListNotificationsInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain.</p>"""
    type: "capo_datazone.types.notification_type.NotificationType"
    """<p>The type of notifications.</p>"""
    after_timestamp: NotRequired["datetime.datetime"]
    """<p>The time after which you want to list notifications.</p>"""
    before_timestamp: NotRequired["datetime.datetime"]
    """<p>The time before which you want to list notifications.</p>"""
    subjects: NotRequired[
        "capo_datazone.types.notification_subjects.NotificationSubjects"
    ]
    """<p>The subjects of notifications.</p>"""
    task_status: NotRequired["capo_datazone.types.task_status.TaskStatus"]
    """<p>The task status of notifications.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of notifications to return in a single call to <code>ListNotifications</code>. When the number of notifications to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListNotifications</code> to list the next set of notifications.</p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of notifications is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of notifications, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListNotifications</code> to list the next set of notifications.</p>"""

after_timestamp instance-attribute

after_timestamp: NotRequired[datetime]

The time after which you want to list notifications.

before_timestamp instance-attribute

before_timestamp: NotRequired[datetime]

The time before which you want to list notifications.

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon DataZone domain.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of notifications to return in a single call to ListNotifications. When the number of notifications to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListNotifications to list the next set of notifications.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

subjects instance-attribute

subjects: NotRequired[NotificationSubjects]

The subjects of notifications.

task_status instance-attribute

task_status: NotRequired[TaskStatus]

The task status of notifications.

type instance-attribute

The type of notifications.