Class: Aws::CodeStarNotifications::Client

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

Overview

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

client = Aws::CodeStarNotifications::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 the 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` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :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::CodeStarNotifications::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CodeStarNotifications::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.



471
472
473
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 471

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. 



1127
1128
1129
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1127

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. 



1130
1131
1132
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1130

def errors_module
  Errors
end

Instance Method Details

#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: {}) 


1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1100

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::CodeStarNotifications')
  )
  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-codestarnotifications'
  context[:gem_version] = '1.67.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_notification_rule(params = {}) ⇒ Types::CreateNotificationRuleResult

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients configured for Slack) where you want to receive them.

Examples:

Request syntax with placeholder values


resp = client.create_notification_rule({
  name: "NotificationRuleName", # required
  event_type_ids: ["EventTypeId"], # required
  resource: "NotificationRuleResource", # required
  targets: [ # required
    {
      target_type: "TargetType",
      target_address: "TargetAddress",
    },
  ],
  detail_type: "BASIC", # required, accepts BASIC, FULL
  client_request_token: "ClientRequestToken",
  tags: {
    "TagKey" => "TagValue",
  },
  status: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

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

    A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

  • :resource (required, String) —

    The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

  • :targets (required, Array<Types::Target>) —

    A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the notification rule.

  • :detail_type (required, String) —

    The level of detail to include in the notifications for this resource. ‘BASIC` will include only the contents of the event as it would appear in Amazon CloudWatch. `FULL` will include any supplemental information provided by CodeStar Notifications and/or the service for the resource for which the notification is created.

  • :client_request_token (String) —

    A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

    <note markdown=“1”> The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

    </note>

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

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

    A list of tags to apply to this notification rule. Key names cannot start with “‘aws`”.

  • :status (String) —

    The status of the notification rule. The default value is ‘ENABLED`. If the status is set to `DISABLED`, notifications aren’t sent for the notification rule.

Returns:

See Also:



566
567
568
569
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 566

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

#delete_notification_rule(params = {}) ⇒ Types::DeleteNotificationRuleResult

Deletes a notification rule for a resource.

Examples:

Request syntax with placeholder values


resp = client.delete_notification_rule({
  arn: "NotificationRuleArn", # required
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule you want to delete.

Returns:

See Also:



595
596
597
598
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 595

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

#delete_target(params = {}) ⇒ Struct

Deletes a specified target for notifications.

Examples:

Request syntax with placeholder values


resp = client.delete_target({
  target_address: "TargetAddress", # required
  force_unsubscribe_all: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :target_address (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client to delete.

  • :force_unsubscribe_all (Boolean) —

    A Boolean value that can be used to delete all associations with this Amazon Q Developer in chat applications topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your Amazon Web Services account are deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



626
627
628
629
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 626

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

#describe_notification_rule(params = {}) ⇒ Types::DescribeNotificationRuleResult

Returns information about a specified notification rule.

Examples:

Request syntax with placeholder values


resp = client.describe_notification_rule({
  arn: "NotificationRuleArn", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.event_types #=> Array
resp.event_types[0].event_type_id #=> String
resp.event_types[0].service_name #=> String
resp.event_types[0].event_type_name #=> String
resp.event_types[0].resource_type #=> String
resp.resource #=> String
resp.targets #=> Array
resp.targets[0].target_address #=> String
resp.targets[0].target_type #=> String
resp.targets[0].target_status #=> String, one of "PENDING", "ACTIVE", "UNREACHABLE", "INACTIVE", "DEACTIVATED"
resp.detail_type #=> String, one of "BASIC", "FULL"
resp.created_by #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.created_timestamp #=> Time
resp.last_modified_timestamp #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule.

Returns:

See Also:



682
683
684
685
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 682

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

#list_event_types(params = {}) ⇒ Types::ListEventTypesResult

Returns information about the event types available for configuring notifications.

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_types({
  filters: [
    {
      name: "RESOURCE_TYPE", # required, accepts RESOURCE_TYPE, SERVICE_NAME
      value: "ListEventTypesFilterValue", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.event_types #=> Array
resp.event_types[0].event_type_id #=> String
resp.event_types[0].service_name #=> String
resp.event_types[0].event_type_name #=> String
resp.event_types[0].resource_type #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::ListEventTypesFilter>) —

    The filters to use to return information by service or resource type.

  • :next_token (String) —

    An enumeration token that, when provided in a request, returns the next batch of the results.

  • :max_results (Integer) —

    A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of results that can be returned is 100.

Returns:

See Also:



735
736
737
738
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 735

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

#list_notification_rules(params = {}) ⇒ Types::ListNotificationRulesResult

Returns a list of the notification rules for an Amazon Web Services account.

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_rules({
  filters: [
    {
      name: "EVENT_TYPE_ID", # required, accepts EVENT_TYPE_ID, CREATED_BY, RESOURCE, TARGET_ADDRESS
      value: "ListNotificationRulesFilterValue", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.notification_rules #=> Array
resp.notification_rules[0].id #=> String
resp.notification_rules[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::ListNotificationRulesFilter>) —

    The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter.

    <note markdown=“1”> A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

    </note>
  • :next_token (String) —

    An enumeration token that, when provided in a request, returns the next batch of the results.

  • :max_results (Integer) —

    A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

Returns:

See Also:



792
793
794
795
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 792

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

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

Returns a list of the tags associated with a notification rule.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  arn: "NotificationRuleArn", # 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) for the notification rule.

Returns:

See Also:



821
822
823
824
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 821

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

#list_targets(params = {}) ⇒ Types::ListTargetsResult

Returns a list of the notification rule targets for an Amazon Web Services account.

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_targets({
  filters: [
    {
      name: "TARGET_TYPE", # required, accepts TARGET_TYPE, TARGET_ADDRESS, TARGET_STATUS
      value: "ListTargetsFilterValue", # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.targets #=> Array
resp.targets[0].target_address #=> String
resp.targets[0].target_type #=> String
resp.targets[0].target_status #=> String, one of "PENDING", "ACTIVE", "UNREACHABLE", "INACTIVE", "DEACTIVATED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::ListTargetsFilter>) —

    The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.

    <note markdown=“1”> A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

    </note>
  • :next_token (String) —

    An enumeration token that, when provided in a request, returns the next batch of the results.

  • :max_results (Integer) —

    A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

Returns:

See Also:



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

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

#subscribe(params = {}) ⇒ Types::SubscribeResult

Creates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so that the associated target can receive notifications when the events described in the rule are triggered.

Examples:

Request syntax with placeholder values


resp = client.subscribe({
  arn: "NotificationRuleArn", # required
  target: { # required
    target_type: "TargetType",
    target_address: "TargetAddress",
  },
  client_request_token: "ClientRequestToken",
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

  • :target (required, Types::Target) —

    Information about the Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients associated with a notification rule.

  • :client_request_token (String) —

    An enumeration token that, when provided in a request, returns the next batch of the results.

Returns:

See Also:



925
926
927
928
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 925

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

#tag_resource(params = {}) ⇒ Types::TagResourceResult

Associates a set of provided tags with a notification rule.

Examples:

Request syntax with placeholder values


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

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) of the notification rule to tag.

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

    The list of tags to associate with the resource. Tag key names cannot start with “‘aws`”.

Returns:

See Also:



961
962
963
964
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 961

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

#unsubscribe(params = {}) ⇒ Types::UnsubscribeResult

Removes an association between a notification rule and an Amazon Q Developer in chat applications topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.

Examples:

Request syntax with placeholder values


resp = client.unsubscribe({
  arn: "NotificationRuleArn", # required
  target_address: "TargetAddress", # required
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule.

  • :target_address (required, String) —

    The ARN of the Amazon Q Developer in chat applications topic to unsubscribe from the notification rule.

Returns:

See Also:



997
998
999
1000
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 997

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

#untag_resource(params = {}) ⇒ Struct

Removes the association between one or more provided tags and a notification rule.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.

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

    The key names of the tags to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1025
1026
1027
1028
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1025

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

#update_notification_rule(params = {}) ⇒ Struct

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

<note markdown=“1”> To add or remove tags for a notification rule, you must use TagResource and UntagResource.

</note>

Examples:

Request syntax with placeholder values


resp = client.update_notification_rule({
  arn: "NotificationRuleArn", # required
  name: "NotificationRuleName",
  status: "ENABLED", # accepts ENABLED, DISABLED
  event_type_ids: ["EventTypeId"],
  targets: [
    {
      target_type: "TargetType",
      target_address: "TargetAddress",
    },
  ],
  detail_type: "BASIC", # accepts BASIC, FULL
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the notification rule.

  • :name (String) —

    The name of the notification rule.

  • :status (String) —

    The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

  • :event_type_ids (Array<String>) —

    A list of event types associated with this notification rule. For a complete list of event types and IDs, see [Notification concepts] in the *Developer Tools Console User Guide*.

    [1]: docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api

  • :targets (Array<Types::Target>) —

    The address and type of the targets to receive notifications from this notification rule.

  • :detail_type (String) —

    The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by CodeStar Notifications and/or the service for the resource for which the notification is created.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1091
1092
1093
1094
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1091

def update_notification_rule(params = {}, options = {})
  req = build_request(:update_notification_rule, 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. 


1120
1121
1122
 
# File 'lib/aws-sdk-codestarnotifications/client.rb', line 1120

def waiter_names
  []
end