Class: Aws::SSMContacts::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-ssmcontacts/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.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :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[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_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.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

  • :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 https://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.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. 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.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

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

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



345
346
347
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 345

def initialize(*args)
  super
end

Instance Method Details

#accept_page(params = {}) ⇒ Struct

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

Examples:

Example: To accept a page during and engagement


# The following accept-page operation uses an accept code sent to the contact channel to accept a page.

resp = client.accept_page({
  accept_code: "425440", 
  accept_type: "READ", 
  page_id: "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3", 
})

resp.to_h outputs the following:
{
}

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

    The accept code is 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:



413
414
415
416
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 413

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:

Example: Activate a contact's contact channel


# The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.

resp = client.activate_contact_channel({
  activation_code: "466136", 
  contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
})

resp.to_h outputs the following:
{
}

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:



455
456
457
458
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 455

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

Example: To create a contact


# The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated
# after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you
# have created contact channels for this contact use update-contact to update the plan.

resp = client.create_contact({
  alias: "akuam", 
  display_name: "Akua Mansa", 
  plan: {
    stages: [
    ], 
  }, 
  type: "PERSONAL", 
})

resp.to_h outputs the following:
{
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
}

Request syntax with placeholder values


resp = client.create_contact({
  alias: "ContactAlias", # required
  display_name: "ContactName",
  type: "PERSONAL", # required, accepts PERSONAL, ESCALATION
  plan: { # required
    stages: [ # required
      {
        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
            },
          },
        ],
      },
    ],
  },
  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:



559
560
561
562
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 559

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:

Example: To create a contact channel


# Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or
# VOICE.

resp = client.create_contact_channel({
  contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  delivery_address: {
    simple_address: "+15005550199", 
  }, 
  name: "akuas sms-test", 
  type: "SMS", 
})

resp.to_h outputs the following:
{
  contact_channel_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024", 
}

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:



651
652
653
654
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 651

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

Example: To deactivate a contact channel


# The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means
# the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time
# using the activate-contact-channel operation.

resp = client.deactivate_contact_channel({
  contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
})

resp.to_h outputs the following:
{
}

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:



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

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:

Example: To delete a contact


# The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan
# that refers to them.

resp = client.delete_contact({
  contact_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr", 
})

resp.to_h outputs the following:
{
}

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:



730
731
732
733
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 730

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:

Example: To delete a contact channel


# The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact
# channel will not be paged during an incident.

resp = client.delete_contact_channel({
  contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2", 
})

resp.to_h outputs the following:
{
}

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:



770
771
772
773
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 770

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

Example: To describe the details of an engagement


# The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The
# subject and content are sent to the contact channels.

resp = client.describe_engagement({
  engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
})

resp.to_h outputs the following:
{
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
  content: "Testing engagements", 
  engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
  public_content: "Testing engagements", 
  public_subject: "test", 
  sender: "tester", 
  start_time: Time.parse("$2021-05-18T18:25:41.151000+00:00"), 
  subject: "test", 
}

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:



841
842
843
844
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 841

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:

Example: To list the details of a page to a contact channel


# The following describe-page example lists details of a page to a contact channel. The page will include the subject and
# content provided.

resp = client.describe_page({
  page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
})

resp.to_h outputs the following:
{
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  content: "Testing engagements", 
  delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"), 
  engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
  page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
  public_content: "Testing engagements", 
  public_subject: "test", 
  read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"), 
  sender: "tester", 
  sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"), 
  subject: "test", 
}

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:



916
917
918
919
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 916

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:

Example: Example 1: To describe a contact plan


# The following get-contact example describes a contact.

resp = client.get_contact({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
})

resp.to_h outputs the following:
{
  alias: "akuam", 
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  display_name: "Akua Mansa", 
  plan: {
    stages: [
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
    ], 
  }, 
  type: "PERSONAL", 
}

Example: Example 2: To describe an escalation plan


# The following get-contact example describes an escalation plan.

resp = client.get_contact({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
})

resp.to_h outputs the following:
{
  alias: "example_escalation", 
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
  display_name: "Example Escalation Plan", 
  plan: {
    stages: [
      {
        duration_in_minutes: 5, 
        targets: [
          {
            contact_target_info: {
              contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
              is_essential: true, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 5, 
        targets: [
          {
            contact_target_info: {
              contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
              is_essential: false, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 0, 
        targets: [
          {
            contact_target_info: {
              contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
              is_essential: false, 
            }, 
          }, 
        ], 
      }, 
    ], 
  }, 
  type: "ESCALATION", 
}

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"
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

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:



1065
1066
1067
1068
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1065

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:

Example: To list the details of a contact channel


# The following get-contact-channel example lists the details of a contact channel.

resp = client.get_contact_channel({
  contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
})

resp.to_h outputs the following:
{
  activation_status: "ACTIVATED", 
  contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
  delivery_address: {
    simple_address: "+15005550199", 
  }, 
  name: "akuas sms", 
  type: "SMS", 
}

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:



1125
1126
1127
1128
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1125

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:

Example: To list the resource policies of a contact


# The following get-contact-policy example lists the resource policies associated with the specified contact.

resp = client.get_contact_policy({
  contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
})

resp.to_h outputs the following:
{
  contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}", 
}

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:



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

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

Example: To list the contact channels of a contact


# The following list-contact-channels example lists the available contact channels of the specified contact.

resp = client.list_contact_channels({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
})

resp.to_h outputs the following:
{
  contact_channels: [
    {
      activation_status: "ACTIVATED", 
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      delivery_address: {
        simple_address: "+15005550100", 
      }, 
      name: "akuas sms", 
      type: "SMS", 
    }, 
  ], 
}

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:



1242
1243
1244
1245
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1242

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:

Example: To list all escalation plans and contacts


# The following list-contacts example lists the contacts and escalation plans in your account.

resp = client.list_contacts({
})

resp.to_h outputs the following:
{
  contacts: [
    {
      alias: "akuam", 
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      display_name: "Akua Mansa", 
      type: "PERSONAL", 
    }, 
    {
      alias: "alejr", 
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
      display_name: "Alejandro Rosalez", 
      type: "PERSONAL", 
    }, 
    {
      alias: "anasi", 
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
      display_name: "Ana Carolina Silva", 
      type: "PERSONAL", 
    }, 
    {
      alias: "example_escalation", 
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
      display_name: "Example Escalation", 
      type: "ESCALATION", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_contacts({
  next_token: "PaginationToken",
  max_results: 1,
  alias_prefix: "ContactAlias",
  type: "PERSONAL", # accepts PERSONAL, ESCALATION
})

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"

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:



1331
1332
1333
1334
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1331

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:

Example: To list all engagements


# The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements
# for a single incident.

resp = client.list_engagements({
})

resp.to_h outputs the following:
{
  engagements: [
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", 
      sender: "cli", 
      start_time: Time.parse("2021-05-18T20:37:50.300000+00:00"), 
    }, 
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      sender: "cli", 
      start_time: Time.parse("2021-05-18T18:40:26.666000+00:00"), 
    }, 
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
      sender: "cli", 
      start_time: Time.parse("2021-05-18T18:25:41.151000+00:00"), 
    }, 
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 
      sender: "cli", 
      start_time: Time.parse("2021-05-18T18:20:58.093000+00:00"), 
    }, 
  ], 
}

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:



1424
1425
1426
1427
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1424

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:

Example: To list page receipts


# The following command-name example lists whether a page was received or not by a contact.

resp = client.list_page_receipts({
  page_id: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3", 
})

resp.to_h outputs the following:
{
  receipts: [
    {
      contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      receipt_info: "425440", 
      receipt_time: Time.parse("2021-05-18T20:42:57.485000+00:00"), 
      receipt_type: "DELIVERED", 
    }, 
    {
      contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      receipt_info: "425440", 
      receipt_time: Time.parse("2021-05-18T20:42:57.907000+00:00"), 
      receipt_type: "READ", 
    }, 
    {
      contact_channel_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      receipt_info: "SM6656c19132f1465f9c9c1123a5dde7c9", 
      receipt_time: Time.parse("2021-05-18T20:40:52.962000+00:00"), 
      receipt_type: "SENT", 
    }, 
  ], 
}

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:



1503
1504
1505
1506
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1503

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

Example: To list pages by contact


# The following list-pages-by-contact example lists all pages to the specified contact.

resp = client.list_pages_by_contact({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
})

resp.to_h outputs the following:
{
  pages: [
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      delivery_time: Time.parse("2021-05-18T18:43:55.265000+00:00"), 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
      read_time: Time.parse("2021-05-18T18:43:55.708000+00:00"), 
      sender: "cli", 
      sent_time: Time.parse("2021-05-18T18:43:29.301000+00:00"), 
    }, 
  ], 
}

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:



1577
1578
1579
1580
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1577

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:

Example: To list pages to contact channels started from an engagement.


# The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.

resp = client.list_pages_by_engagement({
  engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
})

resp.to_h outputs the following:
{
  pages: [
    {
      contact_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      page_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
      sender: "cli", 
      sent_time: Time.parse("2021-05-18T18:40:27.245000+00:00"), 
    }, 
  ], 
}

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:



1649
1650
1651
1652
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1649

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

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

Lists the tags of an escalation plan or contact.

Examples:

Example: To list tags for a contact


# The following list-tags-for-resource example lists the tags of the specified contact.

resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "group1", 
      value: "1", 
    }, 
  ], 
}

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:



1698
1699
1700
1701
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1698

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 to the specified contact or escalation plan.

Examples:

Example: To share a contact and engagements


# The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related
# engagements with the principal.

resp = client.put_contact_policy({
  contact_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}", 
})

resp.to_h outputs the following:
{
}

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:



1739
1740
1741
1742
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1739

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:

Example: To send an activation code


# The following send-activation-code example sends an activation code and message to the specified contact channel.

resp = client.send_activation_code({
  contact_channel_id: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400", 
})

resp.to_h outputs the following:
{
}

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:



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

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:

Example: Example 1: To page a contact's contact channels


# The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are
# all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels.
# Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to
# track who started the engagement.

resp = client.start_engagement({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  content: "Testing engagements", 
  public_content: "Testing engagements", 
  public_subject: "test", 
  sender: "tester", 
  subject: "test", 
})

resp.to_h outputs the following:
{
  engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 
}

Example: Example 2: To page a contact in the provided escalation plan.


# The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their
# engagement plan.

resp = client.start_engagement({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
  content: "Testing engagements", 
  public_content: "Testing engagements", 
  public_subject: "test", 
  sender: "tester", 
  subject: "test", 
})

resp.to_h outputs the following:
{
  engagement_arn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
}

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:



1883
1884
1885
1886
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1883

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:

Example: To stop an engagement


# The following stop-engagement example stops an engagement from paging further contacts and contact channels.

resp = client.stop_engagement({
  engagement_id: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
})

resp.to_h outputs the following:
{
}

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:



1923
1924
1925
1926
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1923

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:

Example: To tag a contact


# The following tag-resource example tags a specified contact with the provided tag key value pair.

resp = client.tag_resource({
  resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  tags: [
    {
      key: "group1", 
      value: "1", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

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:



1974
1975
1976
1977
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 1974

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:

Example: To remove tags from a contact


# The following untag-resource example removes the group1 tag from the specified contact.

resp = client.untag_resource({
  resource_arn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  tag_keys: [
    "group1", 
  ], 
})

resp.to_h outputs the following:
{
}

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:



2016
2017
2018
2019
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2016

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:

Example: To update the engagement plan of contact


# The following update-contact example updates the engagement plan of the contact Akua to include the three types of
# contacts channels. This is done after creating contact channels for Akua.

resp = client.update_contact({
  contact_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  plan: {
    stages: [
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
      {
        duration_in_minutes: 5, 
        targets: [
          {
            channel_target_info: {
              contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
              retry_interval_in_minutes: 1, 
            }, 
          }, 
        ], 
      }, 
    ], 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_contact({
  contact_id: "SsmContactsArn", # required
  display_name: "ContactName",
  plan: {
    stages: [ # required
      {
        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
            },
          },
        ],
      },
    ],
  },
})

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:



2118
2119
2120
2121
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2118

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:

Example: To update a contact channel


# The following update-contact-channel example updates the name and delivery address of a contact channel.

resp = client.update_contact_channel({
  contact_channel_id: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
  delivery_address: {
    simple_address: "+15005550198", 
  }, 
  name: "akuas voice channel", 
})

resp.to_h outputs the following:
{
}

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:



2169
2170
2171
2172
 
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/client.rb', line 2169

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