Class: Aws::SSMContacts::Client

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

Overview

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

client = Aws::SSMContacts::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. This can be an 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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

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

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

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

    A Bearer Token Provider. This can be an 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::SSMContacts::EndpointProvider) —

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



451
452
453
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 451

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. 



2427
2428
2429
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2427

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. 



2430
2431
2432
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2430

def errors_module
  Errors
end

Instance Method Details

#accept_page(params = {}) ⇒ Struct

Used to acknowledge an engagement to a contact channel during an incident.

Examples:

Request syntax with placeholder values


resp = client.accept_page({
  page_id: "SsmContactsArn", # required
  contact_channel_id: "SsmContactsArn",
  accept_type: "DELIVERED", # required, accepts DELIVERED, READ
  note: "ReceiptInfo",
  accept_code: "AcceptCode", # required
  accept_code_validation: "IGNORE", # accepts IGNORE, ENFORCE
})

Parameters:

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

    ({})

Options Hash (params):

  • :page_id (required, String) —

    The Amazon Resource Name (ARN) of the engagement to a contact channel.

  • :contact_channel_id (String) —

    The ARN of the contact channel.

  • :accept_type (required, String) —

    The type indicates if the page was ‘DELIVERED` or `READ`.

  • :note (String) —

    Information provided by the user when the user acknowledges the page.

  • :accept_code (required, String) —

    A 6-digit code used to acknowledge the page.

  • :accept_code_validation (String) —

    An optional field that Incident Manager uses to ‘ENFORCE` `AcceptCode` validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

    Incident Manager can also ‘IGNORE` `AcceptCode` validation. Ignoring `AcceptCode` validation causes Incident Manager to accept any value entered for the `AcceptCode`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



504
505
506
507
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 504

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

#activate_contact_channel(params = {}) ⇒ Struct

Activates a contact’s contact channel. Incident Manager can’t engage a contact until the contact channel has been activated.

Examples:

Request syntax with placeholder values


resp = client.activate_contact_channel({
  contact_channel_id: "SsmContactsArn", # required
  activation_code: "ActivationCode", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel.

  • :activation_code (required, String) —

    The code sent to the contact channel when it was created in the contact.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



532
533
534
535
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 532

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


2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2400

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

#create_contact(params = {}) ⇒ Types::CreateContactResult

Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.

Examples:

Request syntax with placeholder values


resp = client.create_contact({
  alias: "ContactAlias", # required
  display_name: "ContactName",
  type: "PERSONAL", # required, accepts PERSONAL, ESCALATION, ONCALL_SCHEDULE
  plan: { # required
    stages: [
      {
        duration_in_minutes: 1, # required
        targets: [ # required
          {
            channel_target_info: {
              contact_channel_id: "SsmContactsArn", # required
              retry_interval_in_minutes: 1,
            },
            contact_target_info: {
              contact_id: "SsmContactsArn",
              is_essential: false, # required
            },
          },
        ],
      },
    ],
    rotation_ids: ["SsmContactsArn"],
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.contact_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias (required, String) —

    The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

  • :display_name (String) —

    The full name of the contact or escalation plan.

  • :type (required, String) —

    To create an escalation plan use ‘ESCALATION`. To create a contact use `PERSONAL`.

  • :plan (required, Types::Plan) —

    A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

  • :tags (Array<Types::Tag>) —

    Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

  • :idempotency_token (String) —

    A token ensuring that the operation is called only once with the specified details.

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

Returns:

See Also:



615
616
617
618
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 615

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

#create_contact_channel(params = {}) ⇒ Types::CreateContactChannelResult

A contact channel is the method that Incident Manager uses to engage your contact.

Examples:

Request syntax with placeholder values


resp = client.create_contact_channel({
  contact_id: "SsmContactsArn", # required
  name: "ChannelName", # required
  type: "SMS", # required, accepts SMS, VOICE, EMAIL
  delivery_address: { # required
    simple_address: "SimpleAddress",
  },
  defer_activation: false,
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.contact_channel_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

  • :name (required, String) —

    The name of the contact channel.

  • :type (required, String) —

    Incident Manager supports three types of contact channels:

    • ‘SMS`

    • ‘VOICE`

    • ‘EMAIL`

  • :delivery_address (required, Types::ContactChannelAddress) —

    The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

    • SMS - ‘+’ followed by the country code and phone number

    • VOICE - ‘+’ followed by the country code and phone number

    • EMAIL - any standard email format

  • :defer_activation (Boolean) —

    If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can’t engage your contact channel until it has been activated.

  • :idempotency_token (String) —

    A token ensuring that the operation is called only once with the specified details.

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

Returns:

See Also:



687
688
689
690
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 687

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

#create_rotation(params = {}) ⇒ Types::CreateRotationResult

Creates a rotation in an on-call schedule.

Examples:

Request syntax with placeholder values


resp = client.create_rotation({
  name: "RotationName", # required
  contact_ids: ["SsmContactsArn"], # required
  start_time: Time.now,
  time_zone_id: "TimeZoneId", # required
  recurrence: { # required
    monthly_settings: [
      {
        day_of_month: 1, # required
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    weekly_settings: [
      {
        day_of_week: "MON", # required, accepts MON, TUE, WED, THU, FRI, SAT, SUN
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    daily_settings: [
      {
        hour_of_day: 1, # required
        minute_of_hour: 1, # required
      },
    ],
    number_of_on_calls: 1, # required
    shift_coverages: {
      "MON" => [
        {
          start: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
          end: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
        },
      ],
    },
    recurrence_multiplier: 1, # required
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.rotation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the rotation.

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

    The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

    The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact’s shifts, use the UpdateRotation operation.

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

    The date and time that the rotation goes into effect.

  • :time_zone_id (required, String) —

    The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the [Time Zone Database] on the IANA website.

    <note markdown=“1”> Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.

    </note>

    [1]: www.iana.org/time-zones

  • :recurrence (required, Types::RecurrenceSettings) —

    Information about the rule that specifies when a shift’s team members rotate.

  • :tags (Array<Types::Tag>) —

    Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see [Tagging Incident Manager resources] in the *Incident Manager User Guide*.

    [1]: docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html

  • :idempotency_token (String) —

    A token that ensures that the operation is called only once with the specified details.

Returns:

See Also:



812
813
814
815
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 812

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

#create_rotation_override(params = {}) ⇒ Types::CreateRotationOverrideResult

Creates an override for a rotation in an on-call schedule.

Examples:

Request syntax with placeholder values


resp = client.create_rotation_override({
  rotation_id: "SsmContactsArn", # required
  new_contact_ids: ["SsmContactsArn"], # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.rotation_override_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the rotation to create an override for.

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

    The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with.

    If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.

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

    The date and time when the override goes into effect.

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

    The date and time when the override ends.

  • :idempotency_token (String) —

    A token that ensures that the operation is called only once with the specified details.

Returns:

See Also:



862
863
864
865
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 862

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

#deactivate_contact_channel(params = {}) ⇒ Struct

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Examples:

Request syntax with placeholder values


resp = client.deactivate_contact_channel({
  contact_channel_id: "SsmContactsArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel you’re deactivating.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



886
887
888
889
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 886

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

#delete_contact(params = {}) ⇒ Struct

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

Examples:

Request syntax with placeholder values


resp = client.delete_contact({
  contact_id: "SsmContactsArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact that you’re deleting.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 912

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

#delete_contact_channel(params = {}) ⇒ Struct

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact’s engagement plan. If you delete the only contact channel for a contact, you won’t be able to engage that contact during an incident.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_channel({
  contact_channel_id: "SsmContactsArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



938
939
940
941
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 938

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

#delete_rotation(params = {}) ⇒ Struct

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

Examples:

Request syntax with placeholder values


resp = client.delete_rotation({
  rotation_id: "SsmContactsArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the on-call rotation to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_rotation_override(params = {}) ⇒ Struct

Deletes an existing override for an on-call rotation.

Examples:

Request syntax with placeholder values


resp = client.delete_rotation_override({
  rotation_id: "SsmContactsArn", # required
  rotation_override_id: "Uuid", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the rotation that was overridden.

  • :rotation_override_id (required, String) —

    The Amazon Resource Name (ARN) of the on-call rotation override to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



988
989
990
991
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 988

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

#describe_engagement(params = {}) ⇒ Types::DescribeEngagementResult

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Examples:

Request syntax with placeholder values


resp = client.describe_engagement({
  engagement_id: "SsmContactsArn", # required
})

Response structure


resp.contact_arn #=> String
resp.engagement_arn #=> String
resp.sender #=> String
resp.subject #=> String
resp.content #=> String
resp.public_subject #=> String
resp.public_content #=> String
resp.incident_id #=> String
resp.start_time #=> Time
resp.stop_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :engagement_id (required, String) —

    The Amazon Resource Name (ARN) of the engagement you want the details of.

Returns:

See Also:



1037
1038
1039
1040
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1037

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

#describe_page(params = {}) ⇒ Types::DescribePageResult

Lists details of the engagement to a contact channel.

Examples:

Request syntax with placeholder values


resp = client.describe_page({
  page_id: "SsmContactsArn", # required
})

Response structure


resp.page_arn #=> String
resp.engagement_arn #=> String
resp.contact_arn #=> String
resp.sender #=> String
resp.subject #=> String
resp.content #=> String
resp.public_subject #=> String
resp.public_content #=> String
resp.incident_id #=> String
resp.sent_time #=> Time
resp.read_time #=> Time
resp.delivery_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :page_id (required, String) —

    The ID of the engagement to a contact channel.

Returns:

See Also:



1087
1088
1089
1090
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1087

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

#get_contact(params = {}) ⇒ Types::GetContactResult

Retrieves information about the specified contact or escalation plan.

Examples:

Request syntax with placeholder values


resp = client.get_contact({
  contact_id: "SsmContactsArn", # required
})

Response structure


resp.contact_arn #=> String
resp.alias #=> String
resp.display_name #=> String
resp.type #=> String, one of "PERSONAL", "ESCALATION", "ONCALL_SCHEDULE"
resp.plan.stages #=> Array
resp.plan.stages[0].duration_in_minutes #=> Integer
resp.plan.stages[0].targets #=> Array
resp.plan.stages[0].targets[0].channel_target_info.contact_channel_id #=> String
resp.plan.stages[0].targets[0].channel_target_info.retry_interval_in_minutes #=> Integer
resp.plan.stages[0].targets[0].contact_target_info.contact_id #=> String
resp.plan.stages[0].targets[0].contact_target_info.is_essential #=> Boolean
resp.plan.rotation_ids #=> Array
resp.plan.rotation_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

Returns:

See Also:



1131
1132
1133
1134
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1131

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

#get_contact_channel(params = {}) ⇒ Types::GetContactChannelResult

List details about a specific contact channel.

Examples:

Request syntax with placeholder values


resp = client.get_contact_channel({
  contact_channel_id: "SsmContactsArn", # required
})

Response structure


resp.contact_arn #=> String
resp.contact_channel_arn #=> String
resp.name #=> String
resp.type #=> String, one of "SMS", "VOICE", "EMAIL"
resp.delivery_address.simple_address #=> String
resp.activation_status #=> String, one of "ACTIVATED", "NOT_ACTIVATED"

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel you want information about.

Returns:

See Also:



1170
1171
1172
1173
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1170

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

#get_contact_policy(params = {}) ⇒ Types::GetContactPolicyResult

Retrieves the resource policies attached to the specified contact or escalation plan.

Examples:

Request syntax with placeholder values


resp = client.get_contact_policy({
  contact_arn: "SsmContactsArn", # required
})

Response structure


resp.contact_arn #=> String
resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_arn (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

Returns:

See Also:



1201
1202
1203
1204
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1201

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

#get_rotation(params = {}) ⇒ Types::GetRotationResult

Retrieves information about an on-call rotation.

Examples:

Request syntax with placeholder values


resp = client.get_rotation({
  rotation_id: "SsmContactsArn", # required
})

Response structure


resp.rotation_arn #=> String
resp.name #=> String
resp.contact_ids #=> Array
resp.contact_ids[0] #=> String
resp.start_time #=> Time
resp.time_zone_id #=> String
resp.recurrence.monthly_settings #=> Array
resp.recurrence.monthly_settings[0].day_of_month #=> Integer
resp.recurrence.monthly_settings[0].hand_off_time.hour_of_day #=> Integer
resp.recurrence.monthly_settings[0].hand_off_time.minute_of_hour #=> Integer
resp.recurrence.weekly_settings #=> Array
resp.recurrence.weekly_settings[0].day_of_week #=> String, one of "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"
resp.recurrence.weekly_settings[0].hand_off_time.hour_of_day #=> Integer
resp.recurrence.weekly_settings[0].hand_off_time.minute_of_hour #=> Integer
resp.recurrence.daily_settings #=> Array
resp.recurrence.daily_settings[0].hour_of_day #=> Integer
resp.recurrence.daily_settings[0].minute_of_hour #=> Integer
resp.recurrence.number_of_on_calls #=> Integer
resp.recurrence.shift_coverages #=> Hash
resp.recurrence.shift_coverages["DayOfWeek"] #=> Array
resp.recurrence.shift_coverages["DayOfWeek"][0].start.hour_of_day #=> Integer
resp.recurrence.shift_coverages["DayOfWeek"][0].start.minute_of_hour #=> Integer
resp.recurrence.shift_coverages["DayOfWeek"][0].end.hour_of_day #=> Integer
resp.recurrence.shift_coverages["DayOfWeek"][0].end.minute_of_hour #=> Integer
resp.recurrence.recurrence_multiplier #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.

Returns:

See Also:



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

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

#get_rotation_override(params = {}) ⇒ Types::GetRotationOverrideResult

Retrieves information about an override to an on-call rotation.

Examples:

Request syntax with placeholder values


resp = client.get_rotation_override({
  rotation_id: "SsmContactsArn", # required
  rotation_override_id: "Uuid", # required
})

Response structure


resp.rotation_override_id #=> String
resp.rotation_arn #=> String
resp.new_contact_ids #=> Array
resp.new_contact_ids[0] #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.create_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.

  • :rotation_override_id (required, String) —

    The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.

Returns:

See Also:



1304
1305
1306
1307
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1304

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

#list_contact_channels(params = {}) ⇒ Types::ListContactChannelsResult

Lists all contact channels for the specified contact.

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_contact_channels({
  contact_id: "SsmContactsArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.contact_channels #=> Array
resp.contact_channels[0].contact_channel_arn #=> String
resp.contact_channels[0].contact_arn #=> String
resp.contact_channels[0].name #=> String
resp.contact_channels[0].type #=> String, one of "SMS", "VOICE", "EMAIL"
resp.contact_channels[0].delivery_address.simple_address #=> String
resp.contact_channels[0].activation_status #=> String, one of "ACTIVATED", "NOT_ACTIVATED"

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact.

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of contact channels per page.

Returns:

See Also:



1350
1351
1352
1353
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1350

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

#list_contacts(params = {}) ⇒ Types::ListContactsResult

Lists all contacts and escalation plans in Incident Manager.

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_contacts({
  next_token: "PaginationToken",
  max_results: 1,
  alias_prefix: "ContactAlias",
  type: "PERSONAL", # accepts PERSONAL, ESCALATION, ONCALL_SCHEDULE
})

Response structure


resp.next_token #=> String
resp.contacts #=> Array
resp.contacts[0].contact_arn #=> String
resp.contacts[0].alias #=> String
resp.contacts[0].display_name #=> String
resp.contacts[0].type #=> String, one of "PERSONAL", "ESCALATION", "ONCALL_SCHEDULE"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of contacts and escalation plans per page of results.

  • :alias_prefix (String) —

    Used to list only contacts who’s aliases start with the specified prefix.

  • :type (String) —

    The type of contact. A contact is type ‘PERSONAL` and an escalation plan is type `ESCALATION`.

Returns:

See Also:



1401
1402
1403
1404
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1401

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

#list_engagements(params = {}) ⇒ Types::ListEngagementsResult

Lists all engagements that have happened in an incident.

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_engagements({
  next_token: "PaginationToken",
  max_results: 1,
  incident_id: "IncidentId",
  time_range_value: {
    start_time: Time.now,
    end_time: Time.now,
  },
})

Response structure


resp.next_token #=> String
resp.engagements #=> Array
resp.engagements[0].engagement_arn #=> String
resp.engagements[0].contact_arn #=> String
resp.engagements[0].sender #=> String
resp.engagements[0].incident_id #=> String
resp.engagements[0].start_time #=> Time
resp.engagements[0].stop_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of engagements per page of results.

  • :incident_id (String) —

    The Amazon Resource Name (ARN) of the incident you’re listing engagements for.

  • :time_range_value (Types::TimeRange) —

    The time range to lists engagements for an incident.

Returns:

See Also:



1455
1456
1457
1458
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1455

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

#list_page_receipts(params = {}) ⇒ Types::ListPageReceiptsResult

Lists all of the engagements to contact channels that have been acknowledged.

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_page_receipts({
  page_id: "SsmContactsArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.receipts #=> Array
resp.receipts[0].contact_channel_arn #=> String
resp.receipts[0].receipt_type #=> String, one of "DELIVERED", "ERROR", "READ", "SENT", "STOP"
resp.receipts[0].receipt_info #=> String
resp.receipts[0].receipt_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :page_id (required, String) —

    The Amazon Resource Name (ARN) of the engagement to a specific contact channel.

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of acknowledgements per page of results.

Returns:

See Also:



1501
1502
1503
1504
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1501

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

#list_page_resolutions(params = {}) ⇒ Types::ListPageResolutionsResult

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of *escalation plan &gt; on-call schedule &gt; contact*.

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_page_resolutions({
  next_token: "PaginationToken",
  page_id: "SsmContactsArn", # required
})

Response structure


resp.next_token #=> String
resp.page_resolutions #=> Array
resp.page_resolutions[0].contact_arn #=> String
resp.page_resolutions[0].type #=> String, one of "PERSONAL", "ESCALATION", "ONCALL_SCHEDULE"
resp.page_resolutions[0].stage_index #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :page_id (required, String) —

    The Amazon Resource Name (ARN) of the contact engaged for the incident.

Returns:

See Also:



1547
1548
1549
1550
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1547

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

#list_pages_by_contact(params = {}) ⇒ Types::ListPagesByContactResult

Lists the engagements to a contact’s contact channels.

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_pages_by_contact({
  contact_id: "SsmContactsArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.pages #=> Array
resp.pages[0].page_arn #=> String
resp.pages[0].engagement_arn #=> String
resp.pages[0].contact_arn #=> String
resp.pages[0].sender #=> String
resp.pages[0].incident_id #=> String
resp.pages[0].sent_time #=> Time
resp.pages[0].delivery_time #=> Time
resp.pages[0].read_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of engagements to contact channels to list per page of results.

Returns:

See Also:



1597
1598
1599
1600
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1597

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

#list_pages_by_engagement(params = {}) ⇒ Types::ListPagesByEngagementResult

Lists the engagements to contact channels that occurred by engaging a contact.

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_pages_by_engagement({
  engagement_id: "SsmContactsArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.pages #=> Array
resp.pages[0].page_arn #=> String
resp.pages[0].engagement_arn #=> String
resp.pages[0].contact_arn #=> String
resp.pages[0].sender #=> String
resp.pages[0].incident_id #=> String
resp.pages[0].sent_time #=> Time
resp.pages[0].delivery_time #=> Time
resp.pages[0].read_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :engagement_id (required, String) —

    The Amazon Resource Name (ARN) of the engagement.

  • :next_token (String) —

    The pagination token to continue to the next page of results.

  • :max_results (Integer) —

    The maximum number of engagements to contact channels to list per page of results.

Returns:

See Also:



1647
1648
1649
1650
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1647

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

#list_preview_rotation_shifts(params = {}) ⇒ Types::ListPreviewRotationShiftsResult

Returns a list of shifts based on rotation configuration parameters.

<note markdown=“1”> The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

</note>

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_preview_rotation_shifts({
  rotation_start_time: Time.now,
  start_time: Time.now,
  end_time: Time.now, # required
  members: ["Member"], # required
  time_zone_id: "TimeZoneId", # required
  recurrence: { # required
    monthly_settings: [
      {
        day_of_month: 1, # required
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    weekly_settings: [
      {
        day_of_week: "MON", # required, accepts MON, TUE, WED, THU, FRI, SAT, SUN
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    daily_settings: [
      {
        hour_of_day: 1, # required
        minute_of_hour: 1, # required
      },
    ],
    number_of_on_calls: 1, # required
    shift_coverages: {
      "MON" => [
        {
          start: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
          end: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
        },
      ],
    },
    recurrence_multiplier: 1, # required
  },
  overrides: [
    {
      new_members: ["Member"],
      start_time: Time.now,
      end_time: Time.now,
    },
  ],
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.rotation_shifts #=> Array
resp.rotation_shifts[0].contact_ids #=> Array
resp.rotation_shifts[0].contact_ids[0] #=> String
resp.rotation_shifts[0].start_time #=> Time
resp.rotation_shifts[0].end_time #=> Time
resp.rotation_shifts[0].type #=> String, one of "REGULAR", "OVERRIDDEN"
resp.rotation_shifts[0].shift_details.overridden_contact_ids #=> Array
resp.rotation_shifts[0].shift_details.overridden_contact_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The date and time a rotation would begin. The first shift is calculated from this date and time.

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

    Used to filter the range of calculated shifts before sending the response back to the user.

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

    The date and time a rotation shift would end.

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

    The contacts that would be assigned to a rotation.

  • :time_zone_id (required, String) —

    The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”.

  • :recurrence (required, Types::RecurrenceSettings) —

    Information about how long a rotation would last before restarting at the beginning of the shift order.

  • :overrides (Array<Types::PreviewOverride>) —

    Information about changes that would be made in a rotation override.

  • :next_token (String) —

    A token to start the list. This token is used to get the next set of results.

  • :max_results (Integer) —

    The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.

Returns:

See Also:



1778
1779
1780
1781
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1778

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

#list_rotation_overrides(params = {}) ⇒ Types::ListRotationOverridesResult

Retrieves a list of overrides currently specified for an on-call rotation.

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_rotation_overrides({
  rotation_id: "SsmContactsArn", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.rotation_overrides #=> Array
resp.rotation_overrides[0].rotation_override_id #=> String
resp.rotation_overrides[0].new_contact_ids #=> Array
resp.rotation_overrides[0].new_contact_ids[0] #=> String
resp.rotation_overrides[0].start_time #=> Time
resp.rotation_overrides[0].end_time #=> Time
resp.rotation_overrides[0].create_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the rotation to retrieve information about.

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

    The date and time for the beginning of a time range for listing overrides.

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

    The date and time for the end of a time range for listing overrides.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :max_results (Integer) —

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

See Also:



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

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

#list_rotation_shifts(params = {}) ⇒ Types::ListRotationShiftsResult

Returns a list of shifts generated by an existing rotation in the system.

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_rotation_shifts({
  rotation_id: "SsmContactsArn", # required
  start_time: Time.now,
  end_time: Time.now, # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.rotation_shifts #=> Array
resp.rotation_shifts[0].contact_ids #=> Array
resp.rotation_shifts[0].contact_ids[0] #=> String
resp.rotation_shifts[0].start_time #=> Time
resp.rotation_shifts[0].end_time #=> Time
resp.rotation_shifts[0].type #=> String, one of "REGULAR", "OVERRIDDEN"
resp.rotation_shifts[0].shift_details.overridden_contact_ids #=> Array
resp.rotation_shifts[0].shift_details.overridden_contact_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.

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

    The date and time for the beginning of the time range to list shifts for.

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

    The date and time for the end of the time range to list shifts for.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :max_results (Integer) —

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

See Also:



1899
1900
1901
1902
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1899

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

#list_rotations(params = {}) ⇒ Types::ListRotationsResult

Retrieves a list of on-call rotations.

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_rotations({
  rotation_name_prefix: "RotationName",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.rotations #=> Array
resp.rotations[0].rotation_arn #=> String
resp.rotations[0].name #=> String
resp.rotations[0].contact_ids #=> Array
resp.rotations[0].contact_ids[0] #=> String
resp.rotations[0].start_time #=> Time
resp.rotations[0].time_zone_id #=> String
resp.rotations[0].recurrence.monthly_settings #=> Array
resp.rotations[0].recurrence.monthly_settings[0].day_of_month #=> Integer
resp.rotations[0].recurrence.monthly_settings[0].hand_off_time.hour_of_day #=> Integer
resp.rotations[0].recurrence.monthly_settings[0].hand_off_time.minute_of_hour #=> Integer
resp.rotations[0].recurrence.weekly_settings #=> Array
resp.rotations[0].recurrence.weekly_settings[0].day_of_week #=> String, one of "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"
resp.rotations[0].recurrence.weekly_settings[0].hand_off_time.hour_of_day #=> Integer
resp.rotations[0].recurrence.weekly_settings[0].hand_off_time.minute_of_hour #=> Integer
resp.rotations[0].recurrence.daily_settings #=> Array
resp.rotations[0].recurrence.daily_settings[0].hour_of_day #=> Integer
resp.rotations[0].recurrence.daily_settings[0].minute_of_hour #=> Integer
resp.rotations[0].recurrence.number_of_on_calls #=> Integer
resp.rotations[0].recurrence.shift_coverages #=> Hash
resp.rotations[0].recurrence.shift_coverages["DayOfWeek"] #=> Array
resp.rotations[0].recurrence.shift_coverages["DayOfWeek"][0].start.hour_of_day #=> Integer
resp.rotations[0].recurrence.shift_coverages["DayOfWeek"][0].start.minute_of_hour #=> Integer
resp.rotations[0].recurrence.shift_coverages["DayOfWeek"][0].end.hour_of_day #=> Integer
resp.rotations[0].recurrence.shift_coverages["DayOfWeek"][0].end.minute_of_hour #=> Integer
resp.rotations[0].recurrence.recurrence_multiplier #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_name_prefix (String) —

    A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with ‘prod`, such as `production` and `prod-1`.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :max_results (Integer) —

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

See Also:



1969
1970
1971
1972
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1969

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

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

Lists the tags of an escalation plan or contact.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 1999

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

#put_contact_policy(params = {}) ⇒ Struct

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see [Setting up cross-account functionality].

[1]: docs.aws.amazon.com/incident-manager/latest/userguide/xa.html

Examples:

Request syntax with placeholder values


resp = client.put_contact_policy({
  contact_arn: "SsmContactsArn", # required
  policy: "Policy", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_arn (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

  • :policy (required, String) —

    Details of the resource policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2033
2034
2035
2036
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2033

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

#send_activation_code(params = {}) ⇒ Struct

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ‘ActivateChannel` operation. Incident Manager can’t engage a contact channel until it has been activated.

Examples:

Request syntax with placeholder values


resp = client.send_activation_code({
  contact_channel_id: "SsmContactsArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2058
2059
2060
2061
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2058

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

#start_engagement(params = {}) ⇒ Types::StartEngagementResult

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Examples:

Request syntax with placeholder values


resp = client.start_engagement({
  contact_id: "SsmContactsArn", # required
  sender: "Sender", # required
  subject: "Subject", # required
  content: "Content", # required
  public_subject: "PublicSubject",
  public_content: "PublicContent",
  incident_id: "IncidentId",
  idempotency_token: "IdempotencyToken",
})

Response structure


resp.engagement_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact being engaged.

  • :sender (required, String) —

    The user that started the engagement.

  • :subject (required, String) —

    The secure subject of the message that was sent to the contact. Use this field for engagements to ‘VOICE` or `EMAIL`.

  • :content (required, String) —

    The secure content of the message that was sent to the contact. Use this field for engagements to ‘VOICE` or `EMAIL`.

  • :public_subject (String) —

    The insecure subject of the message that was sent to the contact. Use this field for engagements to ‘SMS`.

  • :public_content (String) —

    The insecure content of the message that was sent to the contact. Use this field for engagements to ‘SMS`.

  • :incident_id (String) —

    The ARN of the incident that the engagement is part of.

  • :idempotency_token (String) —

    A token ensuring that the operation is called only once with the specified details.

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

Returns:

See Also:



2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2123

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

#stop_engagement(params = {}) ⇒ Struct

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren’t engaged.

Examples:

Request syntax with placeholder values


resp = client.stop_engagement({
  engagement_id: "SsmContactsArn", # required
  reason: "StopReason",
})

Parameters:

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

    ({})

Options Hash (params):

  • :engagement_id (required, String) —

    The Amazon Resource Name (ARN) of the engagement.

  • :reason (String) —

    The reason that you’re stopping the engagement.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

  • :tags (required, Array<Types::Tag>) —

    A list of tags that you are adding to the contact or escalation plan.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2182

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan.

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

    The key of the tag that you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2208
2209
2210
2211
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2208

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

#update_contact(params = {}) ⇒ Struct

Updates the contact or escalation plan specified.

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  contact_id: "SsmContactsArn", # required
  display_name: "ContactName",
  plan: {
    stages: [
      {
        duration_in_minutes: 1, # required
        targets: [ # required
          {
            channel_target_info: {
              contact_channel_id: "SsmContactsArn", # required
              retry_interval_in_minutes: 1,
            },
            contact_target_info: {
              contact_id: "SsmContactsArn",
              is_essential: false, # required
            },
          },
        ],
      },
    ],
    rotation_ids: ["SsmContactsArn"],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    The Amazon Resource Name (ARN) of the contact or escalation plan you’re updating.

  • :display_name (String) —

    The full name of the contact or escalation plan.

  • :plan (Types::Plan) —

    A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2260
2261
2262
2263
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2260

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

#update_contact_channel(params = {}) ⇒ Struct

Updates a contact’s contact channel.

Examples:

Request syntax with placeholder values


resp = client.update_contact_channel({
  contact_channel_id: "SsmContactsArn", # required
  name: "ChannelName",
  delivery_address: {
    simple_address: "SimpleAddress",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :contact_channel_id (required, String) —

    The Amazon Resource Name (ARN) of the contact channel you want to update.

  • :name (String) —

    The name of the contact channel.

  • :delivery_address (Types::ContactChannelAddress) —

    The details that Incident Manager uses when trying to engage the contact channel.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2294
2295
2296
2297
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2294

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

#update_rotation(params = {}) ⇒ Struct

Updates the information specified for an on-call rotation.

Examples:

Request syntax with placeholder values


resp = client.update_rotation({
  rotation_id: "SsmContactsArn", # required
  contact_ids: ["SsmContactsArn"],
  start_time: Time.now,
  time_zone_id: "TimeZoneId",
  recurrence: { # required
    monthly_settings: [
      {
        day_of_month: 1, # required
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    weekly_settings: [
      {
        day_of_week: "MON", # required, accepts MON, TUE, WED, THU, FRI, SAT, SUN
        hand_off_time: { # required
          hour_of_day: 1, # required
          minute_of_hour: 1, # required
        },
      },
    ],
    daily_settings: [
      {
        hour_of_day: 1, # required
        minute_of_hour: 1, # required
      },
    ],
    number_of_on_calls: 1, # required
    shift_coverages: {
      "MON" => [
        {
          start: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
          end: {
            hour_of_day: 1, # required
            minute_of_hour: 1, # required
          },
        },
      ],
    },
    recurrence_multiplier: 1, # required
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :rotation_id (required, String) —

    The Amazon Resource Name (ARN) of the rotation to update.

  • :contact_ids (Array<String>) —

    The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

    The order in which you list the contacts is their shift order in the rotation schedule.

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

    The date and time the rotation goes into effect.

  • :time_zone_id (String) —

    The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the [Time Zone Database] on the IANA website.

    <note markdown=“1”> Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren’t supported.

    </note>

    [1]: www.iana.org/time-zones

  • :recurrence (required, Types::RecurrenceSettings) —

    Information about how long the updated rotation lasts before restarting at the beginning of the shift order.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2391
2392
2393
2394
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2391

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


2420
2421
2422
 
# File 'lib/aws-sdk-ssmcontacts/client.rb', line 2420

def waiter_names
  []
end