Struct Client 

pub struct Client { /* private fields */ }

Client for AWS User Notifications

Client for invoking operations on AWS User Notifications. Each operation on AWS User Notifications is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_notifications::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_notifications::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateChannel operation has a Client::associate_channel, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_channel()
    .arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_channel(&self) -> AssociateChannelFluentBuilder

Constructs a fluent builder for the AssociateChannel operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.

    Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.

    
    
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The ARN of the NotificationConfiguration to associate with the Channel.

    
    
• On success, responds with AssociateChannelOutput
• On failure, responds with SdkError<AssociateChannelError>

impl Client

pub fn associate_managed_notification_account_contact( &self, ) -> AssociateManagedNotificationAccountContactFluentBuilder

Constructs a fluent builder for the AssociateManagedNotificationAccountContact operation.

• The fluent builder is configurable:
  • contact_identifier(AccountContactType) / set_contact_identifier(Option<AccountContactType>):
    required: true
    

    A unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.

    
    
  • managed_notification_configuration_arn(impl Into<String>) / set_managed_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.

    
    
• On success, responds with AssociateManagedNotificationAccountContactOutput
• On failure, responds with SdkError<AssociateManagedNotificationAccountContactError>

impl Client

pub fn associate_managed_notification_additional_channel( &self, ) -> AssociateManagedNotificationAdditionalChannelFluentBuilder

Constructs a fluent builder for the AssociateManagedNotificationAdditionalChannel operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

    Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and email (notifications-contacts).

    
    
  • managed_notification_configuration_arn(impl Into<String>) / set_managed_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the additional Channel.

    
    
• On success, responds with AssociateManagedNotificationAdditionalChannelOutput
• On failure, responds with SdkError<AssociateManagedNotificationAdditionalChannelError>

impl Client

pub fn associate_organizational_unit( &self, ) -> AssociateOrganizationalUnitFluentBuilder

Constructs a fluent builder for the AssociateOrganizationalUnit operation.

• The fluent builder is configurable:
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: true
    

    The unique identifier of the organizational unit to associate.

    
    
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the notification configuration to associate with the organizational unit.

    
    
• On success, responds with AssociateOrganizationalUnitOutput
• On failure, responds with SdkError<AssociateOrganizationalUnitError>

impl Client

pub fn create_event_rule(&self) -> CreateEventRuleFluentBuilder

Constructs a fluent builder for the CreateEventRule operation.

• The fluent builder is configurable:
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: true
    

    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.

    
    
  • event_type(impl Into<String>) / set_event_type(Option<String>):
    required: true
    

    The event type to match.

    Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

    
    
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: false
    

    An additional event pattern used to further filter the events this EventRule receives.

    For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: true
    

    A list of Amazon Web Services Regions that send events to this EventRule.

    
    
• On success, responds with CreateEventRuleOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • notification_configuration_arn(String):

    The ARN of a NotificationConfiguration.

  • status_summary_by_region(HashMap::<String, EventRuleStatusSummary>):

    A list of an EventRule’s status by Region. Regions are mapped to EventRuleStatusSummary.

• On failure, responds with SdkError<CreateEventRuleError>

impl Client

pub fn create_notification_configuration( &self, ) -> CreateNotificationConfigurationFluentBuilder

Constructs a fluent builder for the CreateNotificationConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the NotificationConfiguration. Supports RFC 3986’s unreserved characters.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    The description of the NotificationConfiguration.

    
    
  • aggregation_duration(AggregationDuration) / set_aggregation_duration(Option<AggregationDuration>):
    required: false
    

    The aggregation preference of the NotificationConfiguration.

    • Values:

      • LONG

        • Aggregate notifications for long periods of time (12 hours).

      • SHORT

        • Aggregate notifications for short periods of time (5 minutes).

      • NONE

        • Don’t aggregate notifications.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

    
    
• On success, responds with CreateNotificationConfigurationOutput with field(s):
  • arn(String):

    The Amazon Resource Name (ARN) of the NotificationConfiguration.

  • status(NotificationConfigurationStatus):

    The current status of this NotificationConfiguration.

• On failure, responds with SdkError<CreateNotificationConfigurationError>

impl Client

pub fn delete_event_rule(&self) -> DeleteEventRuleFluentBuilder

Constructs a fluent builder for the DeleteEventRule operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the EventRule to delete.

    
    
• On success, responds with DeleteEventRuleOutput
• On failure, responds with SdkError<DeleteEventRuleError>

impl Client

pub fn delete_notification_configuration( &self, ) -> DeleteNotificationConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNotificationConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.

    
    
• On success, responds with DeleteNotificationConfigurationOutput
• On failure, responds with SdkError<DeleteNotificationConfigurationError>

impl Client

pub fn deregister_notification_hub( &self, ) -> DeregisterNotificationHubFluentBuilder

Constructs a fluent builder for the DeregisterNotificationHub operation.

• The fluent builder is configurable:
  • notification_hub_region(impl Into<String>) / set_notification_hub_region(Option<String>):
    required: true
    

    The NotificationConfiguration Region.

    
    
• On success, responds with DeregisterNotificationHubOutput with field(s):
  • notification_hub_region(String):

    The NotificationConfiguration Region.

  • status_summary(Option<NotificationHubStatusSummary>):

    NotificationConfiguration status information.

• On failure, responds with SdkError<DeregisterNotificationHubError>

impl Client

pub fn disable_notifications_access_for_organization( &self, ) -> DisableNotificationsAccessForOrganizationFluentBuilder

Constructs a fluent builder for the DisableNotificationsAccessForOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisableNotificationsAccessForOrganizationOutput
• On failure, responds with SdkError<DisableNotificationsAccessForOrganizationError>

impl Client

pub fn disassociate_channel(&self) -> DisassociateChannelFluentBuilder

Constructs a fluent builder for the DisassociateChannel operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

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

    
    
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The ARN of the NotificationConfiguration to disassociate.

    
    
• On success, responds with DisassociateChannelOutput
• On failure, responds with SdkError<DisassociateChannelError>

impl Client

pub fn disassociate_managed_notification_account_contact( &self, ) -> DisassociateManagedNotificationAccountContactFluentBuilder

Constructs a fluent builder for the DisassociateManagedNotificationAccountContact operation.

• The fluent builder is configurable:
  • contact_identifier(AccountContactType) / set_contact_identifier(Option<AccountContactType>):
    required: true
    

    The unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.

    
    
  • managed_notification_configuration_arn(impl Into<String>) / set_managed_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.

    
    
• On success, responds with DisassociateManagedNotificationAccountContactOutput
• On failure, responds with SdkError<DisassociateManagedNotificationAccountContactError>

impl Client

pub fn disassociate_managed_notification_additional_channel( &self, ) -> DisassociateManagedNotificationAdditionalChannelFluentBuilder

Constructs a fluent builder for the DisassociateManagedNotificationAdditionalChannel operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

    
    
  • managed_notification_configuration_arn(impl Into<String>) / set_managed_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel.

    
    
• On success, responds with DisassociateManagedNotificationAdditionalChannelOutput
• On failure, responds with SdkError<DisassociateManagedNotificationAdditionalChannelError>

impl Client

pub fn disassociate_organizational_unit( &self, ) -> DisassociateOrganizationalUnitFluentBuilder

Constructs a fluent builder for the DisassociateOrganizationalUnit operation.

• The fluent builder is configurable:
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: true
    

    The unique identifier of the organizational unit to disassociate.

    
    
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the notification configuration to disassociate from the organizational unit.

    
    
• On success, responds with DisassociateOrganizationalUnitOutput
• On failure, responds with SdkError<DisassociateOrganizationalUnitError>

impl Client

pub fn enable_notifications_access_for_organization( &self, ) -> EnableNotificationsAccessForOrganizationFluentBuilder

Constructs a fluent builder for the EnableNotificationsAccessForOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with EnableNotificationsAccessForOrganizationOutput
• On failure, responds with SdkError<EnableNotificationsAccessForOrganizationError>

impl Client

pub fn get_event_rule(&self) -> GetEventRuleFluentBuilder

Constructs a fluent builder for the GetEventRule operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the EventRule to return.

    
    
• On success, responds with GetEventRuleOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • notification_configuration_arn(String):

    The ARN of a NotificationConfiguration.

  • creation_time(DateTime):

    The date when the EventRule was created.

  • source(String):

    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.

  • event_type(String):

    The event type to match.

    Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

  • event_pattern(String):

    An additional event pattern used to further filter the events this EventRule receives.

    For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

  • regions(Vec::<String>):

    A list of Amazon Web Services Regions that send events to this EventRule.

  • managed_rules(Vec::<String>):

    A list of managed rules from EventBridge that are associated with this EventRule.

    These are created by User Notifications within your account so this EventRule functions.

  • status_summary_by_region(HashMap::<String, EventRuleStatusSummary>):

    A list of an EventRule’s status by Region. Regions are mapped to EventRuleStatusSummary.

• On failure, responds with SdkError<GetEventRuleError>

impl Client

pub fn get_managed_notification_child_event( &self, ) -> GetManagedNotificationChildEventFluentBuilder

Constructs a fluent builder for the GetManagedNotificationChildEvent operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent to return.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved ManagedNotificationChildEvent. The default locale is English en_US.

    
    
• On success, responds with GetManagedNotificationChildEventOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • managed_notification_configuration_arn(String):

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration associated with the ManagedNotificationChildEvent.

  • creation_time(DateTime):

    The creation time of the ManagedNotificationChildEvent.

  • content(Option<ManagedNotificationChildEvent>):

    The content of the ManagedNotificationChildEvent.

• On failure, responds with SdkError<GetManagedNotificationChildEventError>

impl Client

pub fn get_managed_notification_configuration( &self, ) -> GetManagedNotificationConfigurationFluentBuilder

Constructs a fluent builder for the GetManagedNotificationConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to return.

    
    
• On success, responds with GetManagedNotificationConfigurationOutput with field(s):
  • arn(String):

    The ARN of the ManagedNotificationConfiguration resource.

  • name(String):

    The name of the ManagedNotificationConfiguration.

  • description(String):

    The description of the ManagedNotificationConfiguration.

  • category(String):

    The category of the ManagedNotificationConfiguration.

  • sub_category(String):

    The subCategory of the ManagedNotificationConfiguration.

• On failure, responds with SdkError<GetManagedNotificationConfigurationError>

impl Client

pub fn get_managed_notification_event( &self, ) -> GetManagedNotificationEventFluentBuilder

Constructs a fluent builder for the GetManagedNotificationEvent operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationEvent to return.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).

    
    
• On success, responds with GetManagedNotificationEventOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • managed_notification_configuration_arn(String):

    The ARN of the ManagedNotificationConfiguration.

  • creation_time(DateTime):

    The creation time of the ManagedNotificationEvent.

  • content(Option<ManagedNotificationEvent>):

    The content of the ManagedNotificationEvent.

• On failure, responds with SdkError<GetManagedNotificationEventError>

impl Client

pub fn get_notification_configuration( &self, ) -> GetNotificationConfigurationFluentBuilder

Constructs a fluent builder for the GetNotificationConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationConfiguration to return.

    
    
• On success, responds with GetNotificationConfigurationOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • name(String):

    The name of the NotificationConfiguration.

  • description(String):

    The description of the NotificationConfiguration.

  • status(NotificationConfigurationStatus):

    The status of this NotificationConfiguration.

  • creation_time(DateTime):

    The creation time of the NotificationConfiguration.

  • aggregation_duration(Option<AggregationDuration>):

    The aggregation preference of the NotificationConfiguration.

    • Values:

      • LONG

        • Aggregate notifications for long periods of time (12 hours).

      • SHORT

        • Aggregate notifications for short periods of time (5 minutes).

      • NONE

        • Don’t aggregate notifications.

  • subtype(Option<NotificationConfigurationSubtype>):

    The subtype of the notification configuration returned in the response.

• On failure, responds with SdkError<GetNotificationConfigurationError>

impl Client

pub fn get_notification_event(&self) -> GetNotificationEventFluentBuilder

Constructs a fluent builder for the GetNotificationEvent operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationEvent to return.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.

    
    
• On success, responds with GetNotificationEventOutput with field(s):
  • arn(String):

    The ARN of the resource.

  • notification_configuration_arn(String):

    The ARN of the NotificationConfiguration.

  • creation_time(DateTime):

    The creation time of the NotificationEvent.

  • content(Option<NotificationEventSchema>):

    The content of the NotificationEvent.

• On failure, responds with SdkError<GetNotificationEventError>

impl Client

pub fn get_notifications_access_for_organization( &self, ) -> GetNotificationsAccessForOrganizationFluentBuilder

Constructs a fluent builder for the GetNotificationsAccessForOrganization operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetNotificationsAccessForOrganizationOutput with field(s):
  • notifications_access_for_organization(Option<NotificationsAccessForOrganization>):

    The AccessStatus of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.

• On failure, responds with SdkError<GetNotificationsAccessForOrganizationError>

impl Client

pub fn list_channels(&self) -> ListChannelsFluentBuilder

Constructs a fluent builder for the ListChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationConfiguration.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned in this call. The default value is 20.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListChannelsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • channels(Vec::<String>):

    A list of Channels.

• On failure, responds with SdkError<ListChannelsError>

impl Client

pub fn list_event_rules(&self) -> ListEventRulesFluentBuilder

Constructs a fluent builder for the ListEventRules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the NotificationConfiguration.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned in this call. The default value is 20.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListEventRulesOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • event_rules(Vec::<EventRuleStructure>):

    A list of EventRules.

• On failure, responds with SdkError<ListEventRulesError>

impl Client

pub fn list_managed_notification_channel_associations( &self, ) -> ListManagedNotificationChannelAssociationsFluentBuilder

Constructs a fluent builder for the ListManagedNotificationChannelAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • managed_notification_configuration_arn(impl Into<String>) / set_managed_notification_configuration_arn(Option<String>):
    required: true
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call.

    
    
• On success, responds with ListManagedNotificationChannelAssociationsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • channel_associations(Vec::<ManagedNotificationChannelAssociationSummary>):

    A list that contains the following information about a channel association.

• On failure, responds with SdkError<ListManagedNotificationChannelAssociationsError>

impl Client

pub fn list_managed_notification_child_events( &self, ) -> ListManagedNotificationChildEventsFluentBuilder

Constructs a fluent builder for the ListManagedNotificationChildEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • aggregate_managed_notification_event_arn(impl Into<String>) / set_aggregate_managed_notification_event_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The earliest time of events to return from this call.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    Latest time of events to return from this call.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved NotificationEvent. The default locale is English.en_US.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • related_account(impl Into<String>) / set_related_account(Option<String>):
    required: false
    

    The Amazon Web Services account ID associated with the Managed Notification Child Events.

    
    
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: false
    

    The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListManagedNotificationChildEventsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • managed_notification_child_events(Vec::<ManagedNotificationChildEventOverview>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

• On failure, responds with SdkError<ListManagedNotificationChildEventsError>

impl Client

pub fn list_managed_notification_configurations( &self, ) -> ListManagedNotificationConfigurationsFluentBuilder

Constructs a fluent builder for the ListManagedNotificationConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_identifier(impl Into<String>) / set_channel_identifier(Option<String>):
    required: false
    

    The identifier or ARN of the notification channel to filter configurations by.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListManagedNotificationConfigurationsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • managed_notification_configurations(Vec::<ManagedNotificationConfigurationStructure>):

    A list of Managed Notification Configurations matching the request criteria.

• On failure, responds with SdkError<ListManagedNotificationConfigurationsError>

impl Client

pub fn list_managed_notification_events( &self, ) -> ListManagedNotificationEventsFluentBuilder

Constructs a fluent builder for the ListManagedNotificationEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The earliest time of events to return from this call.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    Latest time of events to return from this call.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    The Amazon Web Services service the event originates from. For example aws.cloudwatch.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: false
    

    The Organizational Unit Id that an Amazon Web Services account belongs to.

    
    
  • related_account(impl Into<String>) / set_related_account(Option<String>):
    required: false
    

    The Amazon Web Services account ID associated with the Managed Notification Events.

    
    
• On success, responds with ListManagedNotificationEventsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • managed_notification_events(Vec::<ManagedNotificationEventOverview>):

    A list of Managed Notification Events matching the request criteria.

• On failure, responds with SdkError<ListManagedNotificationEventsError>

impl Client

pub fn list_member_accounts(&self) -> ListMemberAccountsFluentBuilder

Constructs a fluent builder for the ListMemberAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the notification configuration used to filter the member accounts.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. Valid values are 1-100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results. Use the value returned in the previous response.

    
    
  • member_account(impl Into<String>) / set_member_account(Option<String>):
    required: false
    

    The member account identifier used to filter the results.

    
    
  • status(MemberAccountNotificationConfigurationStatus) / set_status(Option<MemberAccountNotificationConfigurationStatus>):
    required: false
    

    The status used to filter the member accounts.

    
    
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: false
    

    The organizational unit ID used to filter the member accounts.

    
    
• On success, responds with ListMemberAccountsOutput with field(s):
  • member_accounts(Vec::<MemberAccount>):

    The list of member accounts that match the specified criteria.

  • next_token(Option<String>):

    The token to use for the next page of results.

• On failure, responds with SdkError<ListMemberAccountsError>

impl Client

pub fn list_notification_configurations( &self, ) -> ListNotificationConfigurationsFluentBuilder

Constructs a fluent builder for the ListNotificationConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • event_rule_source(impl Into<String>) / set_event_rule_source(Option<String>):
    required: false
    

    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(impl Into<String>) / set_channel_arn(Option<String>):
    required: false
    

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

    
    
  • status(NotificationConfigurationStatus) / set_status(Option<NotificationConfigurationStatus>):
    required: false
    

    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(NotificationConfigurationSubtype) / set_subtype(Option<NotificationConfigurationSubtype>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListNotificationConfigurationsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • notification_configurations(Vec::<NotificationConfigurationStructure>):

    The NotificationConfigurations in the account.

• On failure, responds with SdkError<ListNotificationConfigurationsError>

impl Client

pub fn list_notification_events(&self) -> ListNotificationEventsFluentBuilder

Constructs a fluent builder for the ListNotificationEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The earliest time of events to return from this call.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    Latest time of events to return from this call.

    
    
  • locale(LocaleCode) / set_locale(Option<LocaleCode>):
    required: false
    

    The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    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.

    
    
  • include_child_events(bool) / set_include_child_events(Option<bool>):
    required: false
    

    Include aggregated child events in the result.

    
    
  • aggregate_notification_event_arn(impl Into<String>) / set_aggregate_notification_event_arn(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • organizational_unit_id(impl Into<String>) / set_organizational_unit_id(Option<String>):
    required: false
    

    The unique identifier of the organizational unit used to filter notification events.

    
    
• On success, responds with ListNotificationEventsOutput with field(s):
  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • notification_events(Vec::<NotificationEventOverview>):

    The list of notification events.

• On failure, responds with SdkError<ListNotificationEventsError>

impl Client

pub fn list_notification_hubs(&self) -> ListNotificationHubsFluentBuilder

Constructs a fluent builder for the ListNotificationHubs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of records to list in a single response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A pagination token. Set to null to start listing notification hubs from the start.

    
    
• On success, responds with ListNotificationHubsOutput with field(s):
  • notification_hubs(Vec::<NotificationHubOverview>):

    The NotificationHubs in the account.

  • next_token(Option<String>):

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

• On failure, responds with SdkError<ListNotificationHubsError>

impl Client

pub fn list_organizational_units(&self) -> ListOrganizationalUnitsFluentBuilder

Constructs a fluent builder for the ListOrganizationalUnits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • notification_configuration_arn(impl Into<String>) / set_notification_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the notification configuration used to filter the organizational units.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of organizational units to return in a single call. Valid values are 1-100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results. Use the value returned in the previous response.

    
    
• On success, responds with ListOrganizationalUnitsOutput with field(s):
  • organizational_units(Vec::<String>):

    The list of organizational units that match the specified criteria.

  • next_token(Option<String>):

    The token to use for the next page of results. If there are no additional results, this value is null.

• On failure, responds with SdkError<ListOrganizationalUnitsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) to use to list tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    A list of tags for the specified ARN.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn register_notification_hub(&self) -> RegisterNotificationHubFluentBuilder

Constructs a fluent builder for the RegisterNotificationHub operation.

• The fluent builder is configurable:
  • notification_hub_region(impl Into<String>) / set_notification_hub_region(Option<String>):
    required: true
    

    The Region of the NotificationHub.

    
    
• On success, responds with RegisterNotificationHubOutput with field(s):
  • notification_hub_region(String):

    The Region of the NotificationHub.

  • status_summary(Option<NotificationHubStatusSummary>):

    Provides additional information about the current NotificationConfiguration status information.

  • creation_time(DateTime):

    The date the resource was created.

  • last_activation_time(Option<DateTime>):

    The date the resource was last activated.

• On failure, responds with SdkError<RegisterNotificationHubError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) to use to tag a resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) to use to untag a resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys to use to untag a resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_event_rule(&self) -> UpdateEventRuleFluentBuilder

Constructs a fluent builder for the UpdateEventRule operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) to use to update the EventRule.

    
    
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: false
    

    An additional event pattern used to further filter the events this EventRule receives.

    For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: false
    

    A list of Amazon Web Services Regions that sends events to this EventRule.

    
    
• On success, responds with UpdateEventRuleOutput with field(s):
  • arn(String):

    The Amazon Resource Name (ARN) to use to update the EventRule.

  • notification_configuration_arn(String):

    The ARN of the NotificationConfiguration.

  • status_summary_by_region(HashMap::<String, EventRuleStatusSummary>):

    The status of the action by Region.

• On failure, responds with SdkError<UpdateEventRuleError>

impl Client

pub fn update_notification_configuration( &self, ) -> UpdateNotificationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateNotificationConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) used to update the NotificationConfiguration.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the NotificationConfiguration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the NotificationConfiguration.

    
    
  • aggregation_duration(AggregationDuration) / set_aggregation_duration(Option<AggregationDuration>):
    required: false
    

    The aggregation preference of the NotificationConfiguration.

    • Values:

      • LONG

        • Aggregate notifications for long periods of time (12 hours).

      • SHORT

        • Aggregate notifications for short periods of time (5 minutes).

      • NONE

        • Don’t aggregate notifications.

    
    
• On success, responds with UpdateNotificationConfigurationOutput with field(s):
  • arn(String):

    The ARN used to update the NotificationConfiguration.

• On failure, responds with SdkError<UpdateNotificationConfigurationError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.