Class: Aws::Notifications::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-notifications/client.rb

Overview

An API client for Notifications. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::Notifications::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Notifications::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Notifications::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-notifications/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2449
2450
2451
 
# File 'lib/aws-sdk-notifications/client.rb', line 2449

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2452
2453
2454
 
# File 'lib/aws-sdk-notifications/client.rb', line 2452

def errors_module
  Errors
end

Instance Method Details

#associate_channel(params = {}) ⇒ Struct

Associates a delivery [Channel] with a particular ‘NotificationConfiguration`. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

[1]: docs.aws.amazon.com/notifications/latest/userguide/managing-delivery-channels.html

Examples:

Request syntax with placeholder values


resp = client.associate_channel({
  arn: "ChannelArn", # required
  notification_configuration_arn: "NotificationConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    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 (required, String) —

    The ARN of the ‘NotificationConfiguration` to associate with the Channel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



512
513
514
515
 
# File 'lib/aws-sdk-notifications/client.rb', line 512

def associate_channel(params = {}, options = {})
  req = build_request(:associate_channel, params)
  req.send_request(options)
end

#associate_managed_notification_account_contact(params = {}) ⇒ Struct

Associates an Account Contact with a particular ‘ManagedNotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.({
  contact_identifier: "ACCOUNT_PRIMARY", # required, accepts ACCOUNT_PRIMARY, ACCOUNT_ALTERNATE_BILLING, ACCOUNT_ALTERNATE_OPERATIONS, ACCOUNT_ALTERNATE_SECURITY
  managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_identifier (required, String) —

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

  • :managed_notification_configuration_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



542
543
544
545
 
# File 'lib/aws-sdk-notifications/client.rb', line 542

def (params = {}, options = {})
  req = build_request(:associate_managed_notification_account_contact, params)
  req.send_request(options)
end

#associate_managed_notification_additional_channel(params = {}) ⇒ Struct

Associates an additional Channel with a particular ‘ManagedNotificationConfiguration`.

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

Examples:

Request syntax with placeholder values


resp = client.associate_managed_notification_additional_channel({
  channel_arn: "ChannelArn", # required
  managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

    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 (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



578
579
580
581
 
# File 'lib/aws-sdk-notifications/client.rb', line 578

def associate_managed_notification_additional_channel(params = {}, options = {})
  req = build_request(:associate_managed_notification_additional_channel, params)
  req.send_request(options)
end

#associate_organizational_unit(params = {}) ⇒ Struct

Associates an organizational unit with a notification configuration.

Examples:

Request syntax with placeholder values


resp = client.associate_organizational_unit({
  organizational_unit_id: "OrganizationalUnitId", # required
  notification_configuration_arn: "NotificationConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organizational_unit_id (required, String) —

    The unique identifier of the organizational unit to associate.

  • :notification_configuration_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



605
606
607
608
 
# File 'lib/aws-sdk-notifications/client.rb', line 605

def associate_organizational_unit(params = {}, options = {})
  req = build_request(:associate_organizational_unit, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
 
# File 'lib/aws-sdk-notifications/client.rb', line 2422

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Notifications')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-notifications'
  context[:gem_version] = '1.16.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_event_rule(params = {}) ⇒ Types::CreateEventRuleResponse

Creates an [ ‘EventRule` ][1] that is associated with a specified `NotificationConfiguration`.

[1]: docs.aws.amazon.com/notifications/latest/userguide/glossary.html

Examples:

Request syntax with placeholder values


resp = client.create_event_rule({
  notification_configuration_arn: "NotificationConfigurationArn", # required
  source: "Source", # required
  event_type: "EventType", # required
  event_pattern: "EventRuleEventPattern",
  regions: ["Region"], # required
})

Response structure


resp.arn #=> String
resp.notification_configuration_arn #=> String
resp.status_summary_by_region #=> Hash
resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
resp.status_summary_by_region["Region"].reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



690
691
692
693
 
# File 'lib/aws-sdk-notifications/client.rb', line 690

def create_event_rule(params = {}, options = {})
  req = build_request(:create_event_rule, params)
  req.send_request(options)
end

#create_notification_configuration(params = {}) ⇒ Types::CreateNotificationConfigurationResponse

Creates a new ‘NotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.create_notification_configuration({
  name: "NotificationConfigurationName", # required
  description: "NotificationConfigurationDescription", # required
  aggregation_duration: "LONG", # accepts LONG, SHORT, NONE
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :description (required, String) —

    The description of the ‘NotificationConfiguration`.

  • :aggregation_duration (String) —

    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 (Hash<String,String>) —

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

Returns:

See Also:



754
755
756
757
 
# File 'lib/aws-sdk-notifications/client.rb', line 754

def create_notification_configuration(params = {}, options = {})
  req = build_request(:create_notification_configuration, params)
  req.send_request(options)
end

#delete_event_rule(params = {}) ⇒ Struct

Deletes an ‘EventRule`.

Examples:

Request syntax with placeholder values


resp = client.delete_event_rule({
  arn: "EventRuleArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



776
777
778
779
 
# File 'lib/aws-sdk-notifications/client.rb', line 776

def delete_event_rule(params = {}, options = {})
  req = build_request(:delete_event_rule, params)
  req.send_request(options)
end

#delete_notification_configuration(params = {}) ⇒ Struct

Deletes a ‘NotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.delete_notification_configuration({
  arn: "NotificationConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



799
800
801
802
 
# File 'lib/aws-sdk-notifications/client.rb', line 799

def delete_notification_configuration(params = {}, options = {})
  req = build_request(:delete_notification_configuration, params)
  req.send_request(options)
end

#deregister_notification_hub(params = {}) ⇒ Types::DeregisterNotificationHubResponse

Deregisters a ‘NotificationConfiguration` in the specified Region.

<note markdown=“1”> You can’t deregister the last ‘NotificationHub` in the account. `NotificationEvents` stored in the deregistered `NotificationConfiguration` are no longer be visible. Recreating a new `NotificationConfiguration` in the same Region restores access to those `NotificationEvents`.

</note>

Examples:

Request syntax with placeholder values


resp = client.deregister_notification_hub({
  notification_hub_region: "Region", # required
})

Response structure


resp.notification_hub_region #=> String
resp.status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
resp.status_summary.reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_hub_region (required, String) —

    The ‘NotificationConfiguration` Region.

Returns:

See Also:



838
839
840
841
 
# File 'lib/aws-sdk-notifications/client.rb', line 838

def deregister_notification_hub(params = {}, options = {})
  req = build_request(:deregister_notification_hub, params)
  req.send_request(options)
end

#disable_notifications_access_for_organization(params = {}) ⇒ Struct

Disables service trust between User Notifications and Amazon Web Services Organizations.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



852
853
854
855
 
# File 'lib/aws-sdk-notifications/client.rb', line 852

def disable_notifications_access_for_organization(params = {}, options = {})
  req = build_request(:disable_notifications_access_for_organization, params)
  req.send_request(options)
end

#disassociate_channel(params = {}) ⇒ Struct

Disassociates a Channel from a specified ‘NotificationConfiguration`. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Examples:

Request syntax with placeholder values


resp = client.disassociate_channel({
  arn: "ChannelArn", # required
  notification_configuration_arn: "NotificationConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :notification_configuration_arn (required, String) —

    The ARN of the ‘NotificationConfiguration` to disassociate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



880
881
882
883
 
# File 'lib/aws-sdk-notifications/client.rb', line 880

def disassociate_channel(params = {}, options = {})
  req = build_request(:disassociate_channel, params)
  req.send_request(options)
end

#disassociate_managed_notification_account_contact(params = {}) ⇒ Struct

Disassociates an Account Contact with a particular ‘ManagedNotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.({
  contact_identifier: "ACCOUNT_PRIMARY", # required, accepts ACCOUNT_PRIMARY, ACCOUNT_ALTERNATE_BILLING, ACCOUNT_ALTERNATE_OPERATIONS, ACCOUNT_ALTERNATE_SECURITY
  managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_identifier (required, String) —

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

  • :managed_notification_configuration_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



910
911
912
913
 
# File 'lib/aws-sdk-notifications/client.rb', line 910

def (params = {}, options = {})
  req = build_request(:disassociate_managed_notification_account_contact, params)
  req.send_request(options)
end

#disassociate_managed_notification_additional_channel(params = {}) ⇒ Struct

Disassociates an additional Channel from a particular ‘ManagedNotificationConfiguration`.

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

Examples:

Request syntax with placeholder values


resp = client.disassociate_managed_notification_additional_channel({
  channel_arn: "ChannelArn", # required
  managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_arn (required, String) —

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

  • :managed_notification_configuration_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



942
943
944
945
 
# File 'lib/aws-sdk-notifications/client.rb', line 942

def disassociate_managed_notification_additional_channel(params = {}, options = {})
  req = build_request(:disassociate_managed_notification_additional_channel, params)
  req.send_request(options)
end

#disassociate_organizational_unit(params = {}) ⇒ Struct

Removes the association between an organizational unit and a notification configuration.

Examples:

Request syntax with placeholder values


resp = client.disassociate_organizational_unit({
  organizational_unit_id: "OrganizationalUnitId", # required
  notification_configuration_arn: "NotificationConfigurationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organizational_unit_id (required, String) —

    The unique identifier of the organizational unit to disassociate.

  • :notification_configuration_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



970
971
972
973
 
# File 'lib/aws-sdk-notifications/client.rb', line 970

def disassociate_organizational_unit(params = {}, options = {})
  req = build_request(:disassociate_organizational_unit, params)
  req.send_request(options)
end

#enable_notifications_access_for_organization(params = {}) ⇒ Struct

Enables service trust between User Notifications and Amazon Web Services Organizations.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



984
985
986
987
 
# File 'lib/aws-sdk-notifications/client.rb', line 984

def enable_notifications_access_for_organization(params = {}, options = {})
  req = build_request(:enable_notifications_access_for_organization, params)
  req.send_request(options)
end

#get_event_rule(params = {}) ⇒ Types::GetEventRuleResponse

Returns a specified ‘EventRule`.

Examples:

Request syntax with placeholder values


resp = client.get_event_rule({
  arn: "EventRuleArn", # required
})

Response structure


resp.arn #=> String
resp.notification_configuration_arn #=> String
resp.creation_time #=> Time
resp.source #=> String
resp.event_type #=> String
resp.event_pattern #=> String
resp.regions #=> Array
resp.regions[0] #=> String
resp.managed_rules #=> Array
resp.managed_rules[0] #=> String
resp.status_summary_by_region #=> Hash
resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
resp.status_summary_by_region["Region"].reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



1032
1033
1034
1035
 
# File 'lib/aws-sdk-notifications/client.rb', line 1032

def get_event_rule(params = {}, options = {})
  req = build_request(:get_event_rule, params)
  req.send_request(options)
end

#get_managed_notification_child_event(params = {}) ⇒ Types::GetManagedNotificationChildEventResponse

Returns the child event of a specific given ‘ManagedNotificationEvent`.

Examples:

Request syntax with placeholder values


resp = client.get_managed_notification_child_event({
  arn: "ManagedNotificationChildEventArn", # required
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
})

Response structure


resp.arn #=> String
resp.managed_notification_configuration_arn #=> String
resp.creation_time #=> Time
resp.content.schema_version #=> String, one of "v1.0"
resp.content.id #=> String
resp.content.message_components.headline #=> String
resp.content.message_components.paragraph_summary #=> String
resp.content.message_components.complete_description #=> String
resp.content.message_components.dimensions #=> Array
resp.content.message_components.dimensions[0].name #=> String
resp.content.message_components.dimensions[0].value #=> String
resp.content.source_event_detail_url #=> String
resp.content.source_event_detail_url_display_text #=> String
resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.content.aggregate_managed_notification_event_arn #=> String
resp.content.start_time #=> Time
resp.content.end_time #=> Time
resp.content.text_parts #=> Hash
resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
resp.content.text_parts["TextPartId"].display_text #=> String
resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
resp.content.text_parts["TextPartId"].url #=> String
resp.content.organizational_unit_id #=> String
resp.content.aggregation_detail.summarization_dimensions #=> Array
resp.content.aggregation_detail.summarization_dimensions[0].name #=> String
resp.content.aggregation_detail.summarization_dimensions[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :locale (String) —

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

Returns:

See Also:



1098
1099
1100
1101
 
# File 'lib/aws-sdk-notifications/client.rb', line 1098

def get_managed_notification_child_event(params = {}, options = {})
  req = build_request(:get_managed_notification_child_event, params)
  req.send_request(options)
end

#get_managed_notification_configuration(params = {}) ⇒ Types::GetManagedNotificationConfigurationResponse

Returns a specified ‘ManagedNotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.get_managed_notification_configuration({
  arn: "ManagedNotificationConfigurationOsArn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.category #=> String
resp.sub_category #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



1135
1136
1137
1138
 
# File 'lib/aws-sdk-notifications/client.rb', line 1135

def get_managed_notification_configuration(params = {}, options = {})
  req = build_request(:get_managed_notification_configuration, params)
  req.send_request(options)
end

#get_managed_notification_event(params = {}) ⇒ Types::GetManagedNotificationEventResponse

Returns a specified ‘ManagedNotificationEvent`.

Examples:

Request syntax with placeholder values


resp = client.get_managed_notification_event({
  arn: "ManagedNotificationEventArn", # required
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
})

Response structure


resp.arn #=> String
resp.managed_notification_configuration_arn #=> String
resp.creation_time #=> Time
resp.content.schema_version #=> String, one of "v1.0"
resp.content.id #=> String
resp.content.message_components.headline #=> String
resp.content.message_components.paragraph_summary #=> String
resp.content.message_components.complete_description #=> String
resp.content.message_components.dimensions #=> Array
resp.content.message_components.dimensions[0].name #=> String
resp.content.message_components.dimensions[0].value #=> String
resp.content.source_event_detail_url #=> String
resp.content.source_event_detail_url_display_text #=> String
resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.content.aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
resp.content.aggregation_summary.event_count #=> Integer
resp.content.aggregation_summary.aggregated_by #=> Array
resp.content.aggregation_summary.aggregated_by[0].name #=> String
resp.content.aggregation_summary.aggregated_by[0].value #=> String
resp.content.aggregation_summary.aggregated_accounts.name #=> String
resp.content.aggregation_summary.aggregated_accounts.count #=> Integer
resp.content.aggregation_summary.aggregated_accounts.sample_values #=> Array
resp.content.aggregation_summary.aggregated_accounts.sample_values[0] #=> String
resp.content.aggregation_summary.aggregated_regions.name #=> String
resp.content.aggregation_summary.aggregated_regions.count #=> Integer
resp.content.aggregation_summary.aggregated_regions.sample_values #=> Array
resp.content.aggregation_summary.aggregated_regions.sample_values[0] #=> String
resp.content.aggregation_summary.aggregated_organizational_units.name #=> String
resp.content.aggregation_summary.aggregated_organizational_units.count #=> Integer
resp.content.aggregation_summary.aggregated_organizational_units.sample_values #=> Array
resp.content.aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
resp.content.aggregation_summary.additional_summarization_dimensions #=> Array
resp.content.aggregation_summary.additional_summarization_dimensions[0].name #=> String
resp.content.aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
resp.content.start_time #=> Time
resp.content.end_time #=> Time
resp.content.text_parts #=> Hash
resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
resp.content.text_parts["TextPartId"].display_text #=> String
resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
resp.content.text_parts["TextPartId"].url #=> String
resp.content.organizational_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :locale (String) —

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

Returns:

See Also:



1217
1218
1219
1220
 
# File 'lib/aws-sdk-notifications/client.rb', line 1217

def get_managed_notification_event(params = {}, options = {})
  req = build_request(:get_managed_notification_event, params)
  req.send_request(options)
end

#get_notification_configuration(params = {}) ⇒ Types::GetNotificationConfigurationResponse

Returns a specified ‘NotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.get_notification_configuration({
  arn: "NotificationConfigurationArn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"
resp.creation_time #=> Time
resp.aggregation_duration #=> String, one of "LONG", "SHORT", "NONE"
resp.subtype #=> String, one of "ACCOUNT", "ADMIN_MANAGED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



1258
1259
1260
1261
 
# File 'lib/aws-sdk-notifications/client.rb', line 1258

def get_notification_configuration(params = {}, options = {})
  req = build_request(:get_notification_configuration, params)
  req.send_request(options)
end

#get_notification_event(params = {}) ⇒ Types::GetNotificationEventResponse

Returns a specified ‘NotificationEvent`.

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ‘GetNotificationEvent` only returns notifications stored in the same Region in which the action is called. User Notifications doesn’t backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see [Notification hubs] in the *Amazon Web Services User Notifications User Guide*.

[1]: docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html

Examples:

Request syntax with placeholder values


resp = client.get_notification_event({
  arn: "NotificationEventArn", # required
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
})

Response structure


resp.arn #=> String
resp.notification_configuration_arn #=> String
resp.creation_time #=> Time
resp.content.schema_version #=> String, one of "v1.0"
resp.content.id #=> String
resp.content.source_event_metadata.event_type_version #=> String
resp.content.source_event_metadata.source_event_id #=> String
resp.content.source_event_metadata.event_origin_region #=> String
resp.content.source_event_metadata. #=> String
resp.content.source_event_metadata.source #=> String
resp.content.source_event_metadata.event_occurrence_time #=> Time
resp.content.source_event_metadata.event_type #=> String
resp.content.source_event_metadata.related_resources #=> Array
resp.content.source_event_metadata.related_resources[0].id #=> String
resp.content.source_event_metadata.related_resources[0].arn #=> String
resp.content.source_event_metadata.related_resources[0].detail_url #=> String
resp.content.source_event_metadata.related_resources[0].tags #=> Array
resp.content.source_event_metadata.related_resources[0].tags[0] #=> String
resp.content.message_components.headline #=> String
resp.content.message_components.paragraph_summary #=> String
resp.content.message_components.complete_description #=> String
resp.content.message_components.dimensions #=> Array
resp.content.message_components.dimensions[0].name #=> String
resp.content.message_components.dimensions[0].value #=> String
resp.content.source_event_detail_url #=> String
resp.content.source_event_detail_url_display_text #=> String
resp.content.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.content.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.content.aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
resp.content.aggregate_notification_event_arn #=> String
resp.content.aggregation_summary.event_count #=> Integer
resp.content.aggregation_summary.aggregated_by #=> Array
resp.content.aggregation_summary.aggregated_by[0].name #=> String
resp.content.aggregation_summary.aggregated_by[0].value #=> String
resp.content.aggregation_summary.aggregated_accounts.name #=> String
resp.content.aggregation_summary.aggregated_accounts.count #=> Integer
resp.content.aggregation_summary.aggregated_accounts.sample_values #=> Array
resp.content.aggregation_summary.aggregated_accounts.sample_values[0] #=> String
resp.content.aggregation_summary.aggregated_regions.name #=> String
resp.content.aggregation_summary.aggregated_regions.count #=> Integer
resp.content.aggregation_summary.aggregated_regions.sample_values #=> Array
resp.content.aggregation_summary.aggregated_regions.sample_values[0] #=> String
resp.content.aggregation_summary.aggregated_organizational_units.name #=> String
resp.content.aggregation_summary.aggregated_organizational_units.count #=> Integer
resp.content.aggregation_summary.aggregated_organizational_units.sample_values #=> Array
resp.content.aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
resp.content.aggregation_summary.additional_summarization_dimensions #=> Array
resp.content.aggregation_summary.additional_summarization_dimensions[0].name #=> String
resp.content.aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
resp.content.aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
resp.content.start_time #=> Time
resp.content.end_time #=> Time
resp.content.text_parts #=> Hash
resp.content.text_parts["TextPartId"].type #=> String, one of "LOCALIZED_TEXT", "PLAIN_TEXT", "URL"
resp.content.text_parts["TextPartId"].display_text #=> String
resp.content.text_parts["TextPartId"].text_by_locale #=> Hash
resp.content.text_parts["TextPartId"].text_by_locale["LocaleCode"] #=> String
resp.content.text_parts["TextPartId"].url #=> String
resp.content.media #=> Array
resp.content.media[0].media_id #=> String
resp.content.media[0].type #=> String, one of "IMAGE"
resp.content.media[0].url #=> String
resp.content.media[0].caption #=> String
resp.content.organizational_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :locale (String) —

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

Returns:

See Also:



1371
1372
1373
1374
 
# File 'lib/aws-sdk-notifications/client.rb', line 1371

def get_notification_event(params = {}, options = {})
  req = build_request(:get_notification_event, params)
  req.send_request(options)
end

#get_notifications_access_for_organization(params = {}) ⇒ Types::GetNotificationsAccessForOrganizationResponse

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

Examples:

Response structure


resp.notifications_access_for_organization.access_status #=> String, one of "ENABLED", "DISABLED", "PENDING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1391
1392
1393
1394
 
# File 'lib/aws-sdk-notifications/client.rb', line 1391

def get_notifications_access_for_organization(params = {}, options = {})
  req = build_request(:get_notifications_access_for_organization, params)
  req.send_request(options)
end

#list_channels(params = {}) ⇒ Types::ListChannelsResponse

Returns a list of Channels for a ‘NotificationConfiguration`.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_channels({
  notification_configuration_arn: "NotificationConfigurationArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.channels #=> Array
resp.channels[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the ‘NotificationConfiguration`.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1435
1436
1437
1438
 
# File 'lib/aws-sdk-notifications/client.rb', line 1435

def list_channels(params = {}, options = {})
  req = build_request(:list_channels, params)
  req.send_request(options)
end

#list_event_rules(params = {}) ⇒ Types::ListEventRulesResponse

Returns a list of ‘EventRules` according to specified filters, in reverse chronological order (newest first).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_rules({
  notification_configuration_arn: "NotificationConfigurationArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.event_rules #=> Array
resp.event_rules[0].arn #=> String
resp.event_rules[0].notification_configuration_arn #=> String
resp.event_rules[0].creation_time #=> Time
resp.event_rules[0].source #=> String
resp.event_rules[0].event_type #=> String
resp.event_rules[0].event_pattern #=> String
resp.event_rules[0].regions #=> Array
resp.event_rules[0].regions[0] #=> String
resp.event_rules[0].managed_rules #=> Array
resp.event_rules[0].managed_rules[0] #=> String
resp.event_rules[0].status_summary_by_region #=> Hash
resp.event_rules[0].status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
resp.event_rules[0].status_summary_by_region["Region"].reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_configuration_arn (required, String) —

    The Amazon Resource Name (ARN) of the ‘NotificationConfiguration`.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1491
1492
1493
1494
 
# File 'lib/aws-sdk-notifications/client.rb', line 1491

def list_event_rules(params = {}, options = {})
  req = build_request(:list_event_rules, params)
  req.send_request(options)
end

#list_managed_notification_channel_associations(params = {}) ⇒ Types::ListManagedNotificationChannelAssociationsResponse

Returns a list of Account contacts and Channels associated with a ‘ManagedNotificationConfiguration`, in paginated format.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_notification_channel_associations({
  managed_notification_configuration_arn: "ManagedNotificationConfigurationOsArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.channel_associations #=> Array
resp.channel_associations[0].channel_identifier #=> String
resp.channel_associations[0].channel_type #=> String, one of "MOBILE", "CHATBOT", "EMAIL", "ACCOUNT_CONTACT"
resp.channel_associations[0].override_option #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :managed_notification_configuration_arn (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1538
1539
1540
1541
 
# File 'lib/aws-sdk-notifications/client.rb', line 1538

def list_managed_notification_channel_associations(params = {}, options = {})
  req = build_request(:list_managed_notification_channel_associations, params)
  req.send_request(options)
end

#list_managed_notification_child_events(params = {}) ⇒ Types::ListManagedNotificationChildEventsResponse

Returns a list of ‘ManagedNotificationChildEvents` for a specified aggregate `ManagedNotificationEvent`, ordered by creation time in reverse chronological order (newest first).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_notification_child_events({
  aggregate_managed_notification_event_arn: "ManagedNotificationEventArn", # required
  start_time: Time.now,
  end_time: Time.now,
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
  max_results: 1,
  related_account: "AccountId",
  organizational_unit_id: "OrganizationalUnitId",
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.managed_notification_child_events #=> Array
resp.managed_notification_child_events[0].arn #=> String
resp.managed_notification_child_events[0].managed_notification_configuration_arn #=> String
resp.managed_notification_child_events[0]. #=> String
resp.managed_notification_child_events[0].creation_time #=> Time
resp.managed_notification_child_events[0].child_event.schema_version #=> String, one of "v1.0"
resp.managed_notification_child_events[0].child_event.source_event_metadata.event_origin_region #=> String
resp.managed_notification_child_events[0].child_event.source_event_metadata.source #=> String
resp.managed_notification_child_events[0].child_event.source_event_metadata.event_type #=> String
resp.managed_notification_child_events[0].child_event.message_components.headline #=> String
resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions #=> Array
resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions[0].name #=> String
resp.managed_notification_child_events[0].child_event.aggregation_detail.summarization_dimensions[0].value #=> String
resp.managed_notification_child_events[0].child_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.managed_notification_child_events[0].child_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.managed_notification_child_events[0].aggregate_managed_notification_event_arn #=> String
resp.managed_notification_child_events[0].organizational_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :aggregate_managed_notification_event_arn (required, String) —

    The Amazon Resource Name (ARN) of the ‘ManagedNotificationEvent`.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The earliest time of events to return from this call.

  • :end_time (Time, DateTime, Date, Integer, String) —

    Latest time of events to return from this call.

  • :locale (String) —

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

  • :max_results (Integer) —

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

  • :related_account (String) —

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

  • :organizational_unit_id (String) —

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

  • :next_token (String) —

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

Returns:

See Also:



1622
1623
1624
1625
 
# File 'lib/aws-sdk-notifications/client.rb', line 1622

def list_managed_notification_child_events(params = {}, options = {})
  req = build_request(:list_managed_notification_child_events, params)
  req.send_request(options)
end

#list_managed_notification_configurations(params = {}) ⇒ Types::ListManagedNotificationConfigurationsResponse

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_notification_configurations({
  channel_identifier: "ChannelIdentifier",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.managed_notification_configurations #=> Array
resp.managed_notification_configurations[0].arn #=> String
resp.managed_notification_configurations[0].name #=> String
resp.managed_notification_configurations[0].description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channel_identifier (String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1671
1672
1673
1674
 
# File 'lib/aws-sdk-notifications/client.rb', line 1671

def list_managed_notification_configurations(params = {}, options = {})
  req = build_request(:list_managed_notification_configurations, params)
  req.send_request(options)
end

#list_managed_notification_events(params = {}) ⇒ Types::ListManagedNotificationEventsResponse

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_managed_notification_events({
  start_time: Time.now,
  end_time: Time.now,
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
  source: "Source",
  max_results: 1,
  next_token: "NextToken",
  organizational_unit_id: "OrganizationalUnitId",
  related_account: "AccountId",
})

Response structure


resp.next_token #=> String
resp.managed_notification_events #=> Array
resp.managed_notification_events[0].arn #=> String
resp.managed_notification_events[0].managed_notification_configuration_arn #=> String
resp.managed_notification_events[0]. #=> String
resp.managed_notification_events[0].creation_time #=> Time
resp.managed_notification_events[0].notification_event.schema_version #=> String, one of "v1.0"
resp.managed_notification_events[0].notification_event.source_event_metadata.event_origin_region #=> String
resp.managed_notification_events[0].notification_event.source_event_metadata.source #=> String
resp.managed_notification_events[0].notification_event.source_event_metadata.event_type #=> String
resp.managed_notification_events[0].notification_event.message_components.headline #=> String
resp.managed_notification_events[0].notification_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.managed_notification_events[0].notification_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.managed_notification_events[0].aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
resp.managed_notification_events[0].organizational_unit_id #=> String
resp.managed_notification_events[0].aggregation_summary.event_count #=> Integer
resp.managed_notification_events[0].aggregation_summary.aggregated_by #=> Array
resp.managed_notification_events[0].aggregation_summary.aggregated_by[0].name #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_by[0].value #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.name #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.count #=> Integer
resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.sample_values #=> Array
resp.managed_notification_events[0].aggregation_summary.aggregated_accounts.sample_values[0] #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_regions.name #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_regions.count #=> Integer
resp.managed_notification_events[0].aggregation_summary.aggregated_regions.sample_values #=> Array
resp.managed_notification_events[0].aggregation_summary.aggregated_regions.sample_values[0] #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.name #=> String
resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.count #=> Integer
resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values #=> Array
resp.managed_notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions #=> Array
resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].name #=> String
resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
resp.managed_notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
resp.managed_notification_events[0].aggregated_notification_regions #=> Array
resp.managed_notification_events[0].aggregated_notification_regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The earliest time of events to return from this call.

  • :end_time (Time, DateTime, Date, Integer, String) —

    Latest time of events to return from this call.

  • :locale (String) —

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

  • :source (String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :organizational_unit_id (String) —

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

  • :related_account (String) —

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

Returns:

See Also:



1776
1777
1778
1779
 
# File 'lib/aws-sdk-notifications/client.rb', line 1776

def list_managed_notification_events(params = {}, options = {})
  req = build_request(:list_managed_notification_events, params)
  req.send_request(options)
end

#list_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResponse

Returns a list of member accounts associated with a notification configuration.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_member_accounts({
  notification_configuration_arn: "NotificationConfigurationArn", # required
  max_results: 1,
  next_token: "NextToken",
  member_account: "AccountId",
  status: "ACTIVE", # accepts ACTIVE, PENDING, INACTIVE, CREATING, DELETING
  organizational_unit_id: "OrganizationalUnitId",
})

Response structure


resp.member_accounts #=> Array
resp.member_accounts[0].notification_configuration_arn #=> String
resp.member_accounts[0]. #=> String
resp.member_accounts[0].status #=> String, one of "ACTIVE", "PENDING", "INACTIVE", "CREATING", "DELETING"
resp.member_accounts[0].status_reason #=> String
resp.member_accounts[0].organizational_unit_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_configuration_arn (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :member_account (String) —

    The member account identifier used to filter the results.

  • :status (String) —

    The status used to filter the member accounts.

  • :organizational_unit_id (String) —

    The organizational unit ID used to filter the member accounts.

Returns:

See Also:



1837
1838
1839
1840
 
# File 'lib/aws-sdk-notifications/client.rb', line 1837

def list_member_accounts(params = {}, options = {})
  req = build_request(:list_member_accounts, params)
  req.send_request(options)
end

#list_notification_configurations(params = {}) ⇒ Types::ListNotificationConfigurationsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notification_configurations({
  event_rule_source: "Source",
  channel_arn: "ChannelArn",
  status: "ACTIVE", # accepts ACTIVE, PARTIALLY_ACTIVE, INACTIVE, DELETING
  subtype: "ACCOUNT", # accepts ACCOUNT, ADMIN_MANAGED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.notification_configurations #=> Array
resp.notification_configurations[0].arn #=> String
resp.notification_configurations[0].name #=> String
resp.notification_configurations[0].description #=> String
resp.notification_configurations[0].status #=> String, one of "ACTIVE", "PARTIALLY_ACTIVE", "INACTIVE", "DELETING"
resp.notification_configurations[0].creation_time #=> Time
resp.notification_configurations[0].aggregation_duration #=> String, one of "LONG", "SHORT", "NONE"
resp.notification_configurations[0].subtype #=> String, one of "ACCOUNT", "ADMIN_MANAGED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_rule_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*.

    [1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level

  • :channel_arn (String) —

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

  • :status (String) —

    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 (String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



1934
1935
1936
1937
 
# File 'lib/aws-sdk-notifications/client.rb', line 1934

def list_notification_configurations(params = {}, options = {})
  req = build_request(:list_notification_configurations, params)
  req.send_request(options)
end

#list_notification_events(params = {}) ⇒ Types::ListNotificationEventsResponse

Returns a list of ‘NotificationEvents` according to specified filters, in reverse chronological order (newest first).

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn’t backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see [Notification hubs] in the *Amazon Web Services User Notifications User Guide*.

[1]: docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notification_events({
  start_time: Time.now,
  end_time: Time.now,
  locale: "de_DE", # accepts de_DE, en_CA, en_US, en_UK, es_ES, fr_CA, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, tr_TR, zh_CN, zh_TW
  source: "Source",
  include_child_events: false,
  aggregate_notification_event_arn: "NotificationEventArn",
  max_results: 1,
  next_token: "NextToken",
  organizational_unit_id: "OrganizationalUnitId",
})

Response structure


resp.next_token #=> String
resp.notification_events #=> Array
resp.notification_events[0].arn #=> String
resp.notification_events[0].notification_configuration_arn #=> String
resp.notification_events[0]. #=> String
resp.notification_events[0].creation_time #=> Time
resp.notification_events[0].notification_event.schema_version #=> String, one of "v1.0"
resp.notification_events[0].notification_event.source_event_metadata.event_origin_region #=> String
resp.notification_events[0].notification_event.source_event_metadata.source #=> String
resp.notification_events[0].notification_event.source_event_metadata.event_type #=> String
resp.notification_events[0].notification_event.message_components.headline #=> String
resp.notification_events[0].notification_event.event_status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.notification_events[0].notification_event.notification_type #=> String, one of "ALERT", "WARNING", "ANNOUNCEMENT", "INFORMATIONAL"
resp.notification_events[0].aggregation_event_type #=> String, one of "AGGREGATE", "CHILD", "NONE"
resp.notification_events[0].aggregate_notification_event_arn #=> String
resp.notification_events[0].aggregation_summary.event_count #=> Integer
resp.notification_events[0].aggregation_summary.aggregated_by #=> Array
resp.notification_events[0].aggregation_summary.aggregated_by[0].name #=> String
resp.notification_events[0].aggregation_summary.aggregated_by[0].value #=> String
resp.notification_events[0].aggregation_summary.aggregated_accounts.name #=> String
resp.notification_events[0].aggregation_summary.aggregated_accounts.count #=> Integer
resp.notification_events[0].aggregation_summary.aggregated_accounts.sample_values #=> Array
resp.notification_events[0].aggregation_summary.aggregated_accounts.sample_values[0] #=> String
resp.notification_events[0].aggregation_summary.aggregated_regions.name #=> String
resp.notification_events[0].aggregation_summary.aggregated_regions.count #=> Integer
resp.notification_events[0].aggregation_summary.aggregated_regions.sample_values #=> Array
resp.notification_events[0].aggregation_summary.aggregated_regions.sample_values[0] #=> String
resp.notification_events[0].aggregation_summary.aggregated_organizational_units.name #=> String
resp.notification_events[0].aggregation_summary.aggregated_organizational_units.count #=> Integer
resp.notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values #=> Array
resp.notification_events[0].aggregation_summary.aggregated_organizational_units.sample_values[0] #=> String
resp.notification_events[0].aggregation_summary.additional_summarization_dimensions #=> Array
resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].name #=> String
resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].count #=> Integer
resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values #=> Array
resp.notification_events[0].aggregation_summary.additional_summarization_dimensions[0].sample_values[0] #=> String
resp.notification_events[0].organizational_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The earliest time of events to return from this call.

  • :end_time (Time, DateTime, Date, Integer, String) —

    Latest time of events to return from this call.

  • :locale (String) —

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

  • :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*.

    [1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level

  • :include_child_events (Boolean) —

    Include aggregated child events in the result.

  • :aggregate_notification_event_arn (String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :organizational_unit_id (String) —

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

Returns:

See Also:



2062
2063
2064
2065
 
# File 'lib/aws-sdk-notifications/client.rb', line 2062

def list_notification_events(params = {}, options = {})
  req = build_request(:list_notification_events, params)
  req.send_request(options)
end

#list_notification_hubs(params = {}) ⇒ Types::ListNotificationHubsResponse

Returns a list of ‘NotificationHubs`.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notification_hubs({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.notification_hubs #=> Array
resp.notification_hubs[0].notification_hub_region #=> String
resp.notification_hubs[0].status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
resp.notification_hubs[0].status_summary.reason #=> String
resp.notification_hubs[0].creation_time #=> Time
resp.notification_hubs[0].last_activation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2104
2105
2106
2107
 
# File 'lib/aws-sdk-notifications/client.rb', line 2104

def list_notification_hubs(params = {}, options = {})
  req = build_request(:list_notification_hubs, params)
  req.send_request(options)
end

#list_organizational_units(params = {}) ⇒ Types::ListOrganizationalUnitsResponse

Returns a list of organizational units associated with a notification configuration.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_organizational_units({
  notification_configuration_arn: "NotificationConfigurationArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.organizational_units #=> Array
resp.organizational_units[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_configuration_arn (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



2149
2150
2151
2152
 
# File 'lib/aws-sdk-notifications/client.rb', line 2149

def list_organizational_units(params = {}, options = {})
  req = build_request(:list_organizational_units, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a specified Amazon Resource Name (ARN).

For more information, see [Tagging your Amazon Web Services resources] in the *Tagging Amazon Web Services Resources User Guide*.

<note markdown=“1”> This is only supported for ‘NotificationConfigurations`.

</note>

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  arn: "NotificationConfigurationArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

Returns:

See Also:



2190
2191
2192
2193
 
# File 'lib/aws-sdk-notifications/client.rb', line 2190

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#register_notification_hub(params = {}) ⇒ Types::RegisterNotificationHubResponse

Registers a ‘NotificationConfiguration` in the specified Region.

There is a maximum of one ‘NotificationConfiguration` per Region. You can have a maximum of 3 `NotificationHub` resources at a time.

Examples:

Request syntax with placeholder values


resp = client.register_notification_hub({
  notification_hub_region: "Region", # required
})

Response structure


resp.notification_hub_region #=> String
resp.status_summary.status #=> String, one of "ACTIVE", "REGISTERING", "DEREGISTERING", "INACTIVE"
resp.status_summary.reason #=> String
resp.creation_time #=> Time
resp.last_activation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :notification_hub_region (required, String) —

    The Region of the ‘NotificationHub`.

Returns:

See Also:



2228
2229
2230
2231
 
# File 'lib/aws-sdk-notifications/client.rb', line 2228

def register_notification_hub(params = {}, options = {})
  req = build_request(:register_notification_hub, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags the resource with a tag key and value.

For more information, see [Tagging your Amazon Web Services resources] in the *Tagging Amazon Web Services Resources User Guide*.

<note markdown=“1”> This is only supported for ‘NotificationConfigurations`.

</note>

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  arn: "NotificationConfigurationArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2269
2270
2271
2272
 
# File 'lib/aws-sdk-notifications/client.rb', line 2269

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Untags a resource with a specified Amazon Resource Name (ARN).

For more information, see [Tagging your Amazon Web Services resources] in the *Tagging Amazon Web Services Resources User Guide*.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  arn: "NotificationConfigurationArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The tag keys to use to untag a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2303
2304
2305
2306
 
# File 'lib/aws-sdk-notifications/client.rb', line 2303

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_event_rule(params = {}) ⇒ Types::UpdateEventRuleResponse

Updates an existing ‘EventRule`.

Examples:

Request syntax with placeholder values


resp = client.update_event_rule({
  arn: "EventRuleArn", # required
  event_pattern: "EventRuleEventPattern",
  regions: ["Region"],
})

Response structure


resp.arn #=> String
resp.notification_configuration_arn #=> String
resp.status_summary_by_region #=> Hash
resp.status_summary_by_region["Region"].status #=> String, one of "ACTIVE", "INACTIVE", "CREATING", "UPDATING", "DELETING"
resp.status_summary_by_region["Region"].reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :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.*

    [1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html

  • :regions (Array<String>) —

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

Returns:

See Also:



2354
2355
2356
2357
 
# File 'lib/aws-sdk-notifications/client.rb', line 2354

def update_event_rule(params = {}, options = {})
  req = build_request(:update_event_rule, params)
  req.send_request(options)
end

#update_notification_configuration(params = {}) ⇒ Types::UpdateNotificationConfigurationResponse

Updates a ‘NotificationConfiguration`.

Examples:

Request syntax with placeholder values


resp = client.update_notification_configuration({
  arn: "NotificationConfigurationArn", # required
  name: "NotificationConfigurationName",
  description: "NotificationConfigurationDescription",
  aggregation_duration: "LONG", # accepts LONG, SHORT, NONE
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

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

  • :name (String) —

    The name of the ‘NotificationConfiguration`.

  • :description (String) —

    The description of the ‘NotificationConfiguration`.

  • :aggregation_duration (String) —

    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.

        ^

Returns:

See Also:



2413
2414
2415
2416
 
# File 'lib/aws-sdk-notifications/client.rb', line 2413

def update_notification_configuration(params = {}, options = {})
  req = build_request(:update_notification_configuration, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2442
2443
2444
 
# File 'lib/aws-sdk-notifications/client.rb', line 2442

def waiter_names
  []
end