aws-sdk-ssmcontacts 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-ssmcontacts.rb +53 -0
- data/lib/aws-sdk-ssmcontacts/client.rb +1495 -0
- data/lib/aws-sdk-ssmcontacts/client_api.rb +919 -0
- data/lib/aws-sdk-ssmcontacts/customizations.rb +0 -0
- data/lib/aws-sdk-ssmcontacts/errors.rb +236 -0
- data/lib/aws-sdk-ssmcontacts/resource.rb +26 -0
- data/lib/aws-sdk-ssmcontacts/types.rb +1974 -0
- metadata +90 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b09cf9054be409711333efd93d6d52a92d50cbd0f432a62152451bdcf7def24c
|
4
|
+
data.tar.gz: 471f83dab230395648e77887bd769c013206053fef642e6445204850b9871968
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ba333db05d2b0c77f3d0cc5e112c5a925d2f5c2bf66e21874c94d67dc92f0f949c632d4c9836319ec9bf916a75c6f9f95ceeb7c02a720e7d1c7a9d3be79175e3
|
7
|
+
data.tar.gz: 7b68116f99b2f6e4bedce30240401cbcb7c095529b37379f9d9e151594735c295a542b846e1d0bf767fb5274edb1ffd400934ffb03186037eaa70f024c23ec38
|
data/CHANGELOG.md
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.0
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-ssmcontacts/types'
|
15
|
+
require_relative 'aws-sdk-ssmcontacts/client_api'
|
16
|
+
require_relative 'aws-sdk-ssmcontacts/client'
|
17
|
+
require_relative 'aws-sdk-ssmcontacts/errors'
|
18
|
+
require_relative 'aws-sdk-ssmcontacts/resource'
|
19
|
+
require_relative 'aws-sdk-ssmcontacts/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Systems Manager Incident Manager Contacts. This module is available in the
|
22
|
+
# `aws-sdk-ssmcontacts` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# ssm_contacts = Aws::SSMContacts::Client.new
|
31
|
+
# resp = ssm_contacts.accept_page(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Systems Manager Incident Manager Contacts are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::SSMContacts::Errors::ServiceError
|
43
|
+
# # rescues all AWS Systems Manager Incident Manager Contacts API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::SSMContacts
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,1495 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:ssmcontacts)
|
34
|
+
|
35
|
+
module Aws::SSMContacts
|
36
|
+
# An API client for SSMContacts. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::SSMContacts::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :ssmcontacts
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :simple_json (false)
|
270
|
+
# Disables request parameter conversion, validation, and formatting.
|
271
|
+
# Also disable response data type conversions. This option is useful
|
272
|
+
# when you want to ensure the highest level of performance by
|
273
|
+
# avoiding overhead of walking request parameters and response data
|
274
|
+
# structures.
|
275
|
+
#
|
276
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
277
|
+
# be formatted exactly as the DynamoDB API expects.
|
278
|
+
#
|
279
|
+
# @option options [Boolean] :stub_responses (false)
|
280
|
+
# Causes the client to return stubbed responses. By default
|
281
|
+
# fake responses are generated and returned. You can specify
|
282
|
+
# the response data to return or errors to raise by calling
|
283
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
284
|
+
#
|
285
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
|
+
# requests are made, and retries are disabled.
|
287
|
+
#
|
288
|
+
# @option options [Boolean] :validate_params (true)
|
289
|
+
# When `true`, request parameters are validated before
|
290
|
+
# sending the request.
|
291
|
+
#
|
292
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
293
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
294
|
+
#
|
295
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
296
|
+
# seconds to wait when opening a HTTP session before raising a
|
297
|
+
# `Timeout::Error`.
|
298
|
+
#
|
299
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
300
|
+
# number of seconds to wait for response data. This value can
|
301
|
+
# safely be set per-request on the session.
|
302
|
+
#
|
303
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
304
|
+
# seconds a connection is allowed to sit idle before it is
|
305
|
+
# considered stale. Stale connections are closed and removed
|
306
|
+
# from the pool before making a request.
|
307
|
+
#
|
308
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
309
|
+
# seconds to wait for a 100-continue response before sending the
|
310
|
+
# request body. This option has no effect unless the request has
|
311
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
312
|
+
# disables this behaviour. This value can safely be set per
|
313
|
+
# request on the session.
|
314
|
+
#
|
315
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
|
+
# HTTP debug output will be sent to the `:logger`.
|
317
|
+
#
|
318
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
319
|
+
# SSL peer certificates are verified when establishing a
|
320
|
+
# connection.
|
321
|
+
#
|
322
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
323
|
+
# certificate authority bundle file that should be used when
|
324
|
+
# verifying peer certificates. If you do not pass
|
325
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
326
|
+
# will be used if available.
|
327
|
+
#
|
328
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
329
|
+
# directory that contains the unbundled SSL certificate
|
330
|
+
# authority files for verifying peer certificates. If you do
|
331
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
332
|
+
# system default will be used if available.
|
333
|
+
#
|
334
|
+
def initialize(*args)
|
335
|
+
super
|
336
|
+
end
|
337
|
+
|
338
|
+
# @!group API Operations
|
339
|
+
|
340
|
+
# Used to acknowledge an engagement to a contact channel during an
|
341
|
+
# incident.
|
342
|
+
#
|
343
|
+
# @option params [required, String] :page_id
|
344
|
+
# The Amazon Resource Name (ARN) of the engagement to a contact channel.
|
345
|
+
#
|
346
|
+
# @option params [String] :contact_channel_id
|
347
|
+
# The ARN of the contact channel.
|
348
|
+
#
|
349
|
+
# @option params [required, String] :accept_type
|
350
|
+
# The type indicates if the page was `DELIVERED` or `READ`.
|
351
|
+
#
|
352
|
+
# @option params [String] :note
|
353
|
+
# Information provided by the user when the user acknowledges the page.
|
354
|
+
#
|
355
|
+
# @option params [required, String] :accept_code
|
356
|
+
# The accept code is a 6-digit code used to acknowledge the page.
|
357
|
+
#
|
358
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
359
|
+
#
|
360
|
+
# @example Request syntax with placeholder values
|
361
|
+
#
|
362
|
+
# resp = client.accept_page({
|
363
|
+
# page_id: "SsmContactsArn", # required
|
364
|
+
# contact_channel_id: "SsmContactsArn",
|
365
|
+
# accept_type: "DELIVERED", # required, accepts DELIVERED, READ
|
366
|
+
# note: "ReceiptInfo",
|
367
|
+
# accept_code: "AcceptCode", # required
|
368
|
+
# })
|
369
|
+
#
|
370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPage AWS API Documentation
|
371
|
+
#
|
372
|
+
# @overload accept_page(params = {})
|
373
|
+
# @param [Hash] params ({})
|
374
|
+
def accept_page(params = {}, options = {})
|
375
|
+
req = build_request(:accept_page, params)
|
376
|
+
req.send_request(options)
|
377
|
+
end
|
378
|
+
|
379
|
+
# Activates a contact's contact channel. Incident Manager can't engage
|
380
|
+
# a contact until the contact channel has been activated.
|
381
|
+
#
|
382
|
+
# @option params [required, String] :contact_channel_id
|
383
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
384
|
+
#
|
385
|
+
# @option params [required, String] :activation_code
|
386
|
+
# The code sent to the contact channel when it was created in the
|
387
|
+
# contact.
|
388
|
+
#
|
389
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
#
|
393
|
+
# resp = client.activate_contact_channel({
|
394
|
+
# contact_channel_id: "SsmContactsArn", # required
|
395
|
+
# activation_code: "ActivationCode", # required
|
396
|
+
# })
|
397
|
+
#
|
398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ActivateContactChannel AWS API Documentation
|
399
|
+
#
|
400
|
+
# @overload activate_contact_channel(params = {})
|
401
|
+
# @param [Hash] params ({})
|
402
|
+
def activate_contact_channel(params = {}, options = {})
|
403
|
+
req = build_request(:activate_contact_channel, params)
|
404
|
+
req.send_request(options)
|
405
|
+
end
|
406
|
+
|
407
|
+
# Contacts are either the contacts that Incident Manager engages during
|
408
|
+
# an incident or the escalation plans that Incident Manager uses to
|
409
|
+
# engage contacts in phases during an incident.
|
410
|
+
#
|
411
|
+
# @option params [required, String] :alias
|
412
|
+
# The short name to quickly identify a contact or escalation plan. The
|
413
|
+
# contact alias must be unique and identifiable.
|
414
|
+
#
|
415
|
+
# @option params [String] :display_name
|
416
|
+
# The full name of the contact or escalation plan.
|
417
|
+
#
|
418
|
+
# @option params [required, String] :type
|
419
|
+
# To create an escalation plan use `ESCALATION`. To create a contact use
|
420
|
+
# `PERSONAL`.
|
421
|
+
#
|
422
|
+
# @option params [required, Types::Plan] :plan
|
423
|
+
# A list of stages. A contact has an engagement plan with stages that
|
424
|
+
# contact specified contact channels. An escalation plan uses stages
|
425
|
+
# that contact specified contacts.
|
426
|
+
#
|
427
|
+
# @option params [Array<Types::Tag>] :tags
|
428
|
+
# Adds a tag to the target. You can only tag resources created in the
|
429
|
+
# first Region of your replication set.
|
430
|
+
#
|
431
|
+
# @option params [String] :idempotency_token
|
432
|
+
# A token ensuring that the action is called only once with the
|
433
|
+
# specified details.
|
434
|
+
#
|
435
|
+
# **A suitable default value is auto-generated.** You should normally
|
436
|
+
# not need to pass this option.**
|
437
|
+
#
|
438
|
+
# @return [Types::CreateContactResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
439
|
+
#
|
440
|
+
# * {Types::CreateContactResult#contact_arn #contact_arn} => String
|
441
|
+
#
|
442
|
+
# @example Request syntax with placeholder values
|
443
|
+
#
|
444
|
+
# resp = client.create_contact({
|
445
|
+
# alias: "ContactAlias", # required
|
446
|
+
# display_name: "ContactName",
|
447
|
+
# type: "PERSONAL", # required, accepts PERSONAL, ESCALATION
|
448
|
+
# plan: { # required
|
449
|
+
# stages: [ # required
|
450
|
+
# {
|
451
|
+
# duration_in_minutes: 1, # required
|
452
|
+
# targets: [ # required
|
453
|
+
# {
|
454
|
+
# channel_target_info: {
|
455
|
+
# contact_channel_id: "SsmContactsArn", # required
|
456
|
+
# retry_interval_in_minutes: 1,
|
457
|
+
# },
|
458
|
+
# contact_target_info: {
|
459
|
+
# contact_id: "SsmContactsArn",
|
460
|
+
# is_essential: false, # required
|
461
|
+
# },
|
462
|
+
# },
|
463
|
+
# ],
|
464
|
+
# },
|
465
|
+
# ],
|
466
|
+
# },
|
467
|
+
# tags: [
|
468
|
+
# {
|
469
|
+
# key: "TagKey",
|
470
|
+
# value: "TagValue",
|
471
|
+
# },
|
472
|
+
# ],
|
473
|
+
# idempotency_token: "IdempotencyToken",
|
474
|
+
# })
|
475
|
+
#
|
476
|
+
# @example Response structure
|
477
|
+
#
|
478
|
+
# resp.contact_arn #=> String
|
479
|
+
#
|
480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContact AWS API Documentation
|
481
|
+
#
|
482
|
+
# @overload create_contact(params = {})
|
483
|
+
# @param [Hash] params ({})
|
484
|
+
def create_contact(params = {}, options = {})
|
485
|
+
req = build_request(:create_contact, params)
|
486
|
+
req.send_request(options)
|
487
|
+
end
|
488
|
+
|
489
|
+
# A contact channel is the method that Incident Manager uses to engage
|
490
|
+
# your contact.
|
491
|
+
#
|
492
|
+
# @option params [required, String] :contact_id
|
493
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
494
|
+
#
|
495
|
+
# @option params [required, String] :name
|
496
|
+
# The name of the contact channel.
|
497
|
+
#
|
498
|
+
# @option params [required, String] :type
|
499
|
+
# Incident Manager supports three types of contact channels:
|
500
|
+
#
|
501
|
+
# * `SMS`
|
502
|
+
#
|
503
|
+
# * `VOICE`
|
504
|
+
#
|
505
|
+
# * `EMAIL`
|
506
|
+
#
|
507
|
+
# @option params [required, Types::ContactChannelAddress] :delivery_address
|
508
|
+
# The details that Incident Manager uses when trying to engage the
|
509
|
+
# contact channel. The format is dependent on the type of the contact
|
510
|
+
# channel. The following are the expected formats:
|
511
|
+
#
|
512
|
+
# * SMS - '+' followed by the country code and phone number
|
513
|
+
#
|
514
|
+
# * VOICE - '+' followed by the country code and phone number
|
515
|
+
#
|
516
|
+
# * EMAIL - any standard email format
|
517
|
+
#
|
518
|
+
# @option params [Boolean] :defer_activation
|
519
|
+
# If you want to activate the channel at a later time, you can choose to
|
520
|
+
# defer activation. Incident Manager can't engage your contact channel
|
521
|
+
# until it has been activated.
|
522
|
+
#
|
523
|
+
# @option params [String] :idempotency_token
|
524
|
+
# A token ensuring that the action is called only once with the
|
525
|
+
# specified details.
|
526
|
+
#
|
527
|
+
# **A suitable default value is auto-generated.** You should normally
|
528
|
+
# not need to pass this option.**
|
529
|
+
#
|
530
|
+
# @return [Types::CreateContactChannelResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
531
|
+
#
|
532
|
+
# * {Types::CreateContactChannelResult#contact_channel_arn #contact_channel_arn} => String
|
533
|
+
#
|
534
|
+
# @example Request syntax with placeholder values
|
535
|
+
#
|
536
|
+
# resp = client.create_contact_channel({
|
537
|
+
# contact_id: "SsmContactsArn", # required
|
538
|
+
# name: "ChannelName", # required
|
539
|
+
# type: "SMS", # required, accepts SMS, VOICE, EMAIL
|
540
|
+
# delivery_address: { # required
|
541
|
+
# simple_address: "SimpleAddress",
|
542
|
+
# },
|
543
|
+
# defer_activation: false,
|
544
|
+
# idempotency_token: "IdempotencyToken",
|
545
|
+
# })
|
546
|
+
#
|
547
|
+
# @example Response structure
|
548
|
+
#
|
549
|
+
# resp.contact_channel_arn #=> String
|
550
|
+
#
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateContactChannel AWS API Documentation
|
552
|
+
#
|
553
|
+
# @overload create_contact_channel(params = {})
|
554
|
+
# @param [Hash] params ({})
|
555
|
+
def create_contact_channel(params = {}, options = {})
|
556
|
+
req = build_request(:create_contact_channel, params)
|
557
|
+
req.send_request(options)
|
558
|
+
end
|
559
|
+
|
560
|
+
# To no longer receive Incident Manager engagements to a contact
|
561
|
+
# channel, you can deactivate the channel.
|
562
|
+
#
|
563
|
+
# @option params [required, String] :contact_channel_id
|
564
|
+
# The Amazon Resource Name (ARN) of the contact channel you're
|
565
|
+
# deactivating.
|
566
|
+
#
|
567
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
568
|
+
#
|
569
|
+
# @example Request syntax with placeholder values
|
570
|
+
#
|
571
|
+
# resp = client.deactivate_contact_channel({
|
572
|
+
# contact_channel_id: "SsmContactsArn", # required
|
573
|
+
# })
|
574
|
+
#
|
575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeactivateContactChannel AWS API Documentation
|
576
|
+
#
|
577
|
+
# @overload deactivate_contact_channel(params = {})
|
578
|
+
# @param [Hash] params ({})
|
579
|
+
def deactivate_contact_channel(params = {}, options = {})
|
580
|
+
req = build_request(:deactivate_contact_channel, params)
|
581
|
+
req.send_request(options)
|
582
|
+
end
|
583
|
+
|
584
|
+
# To remove a contact from Incident Manager, you can delete the contact.
|
585
|
+
# Deleting a contact removes them from all escalation plans and related
|
586
|
+
# response plans. Deleting an escalation plan removes it from all
|
587
|
+
# related response plans. You will have to recreate the contact and its
|
588
|
+
# contact channels before you can use it again.
|
589
|
+
#
|
590
|
+
# @option params [required, String] :contact_id
|
591
|
+
# The Amazon Resource Name (ARN) of the contact that you're deleting.
|
592
|
+
#
|
593
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
594
|
+
#
|
595
|
+
# @example Request syntax with placeholder values
|
596
|
+
#
|
597
|
+
# resp = client.delete_contact({
|
598
|
+
# contact_id: "SsmContactsArn", # required
|
599
|
+
# })
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContact AWS API Documentation
|
602
|
+
#
|
603
|
+
# @overload delete_contact(params = {})
|
604
|
+
# @param [Hash] params ({})
|
605
|
+
def delete_contact(params = {}, options = {})
|
606
|
+
req = build_request(:delete_contact, params)
|
607
|
+
req.send_request(options)
|
608
|
+
end
|
609
|
+
|
610
|
+
# To no longer receive engagements on a contact channel, you can delete
|
611
|
+
# the channel from a contact. Deleting the contact channel removes it
|
612
|
+
# from the contact's engagement plan. If you delete the only contact
|
613
|
+
# channel for a contact, you won't be able to engage that contact
|
614
|
+
# during an incident.
|
615
|
+
#
|
616
|
+
# @option params [required, String] :contact_channel_id
|
617
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
618
|
+
#
|
619
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
620
|
+
#
|
621
|
+
# @example Request syntax with placeholder values
|
622
|
+
#
|
623
|
+
# resp = client.delete_contact_channel({
|
624
|
+
# contact_channel_id: "SsmContactsArn", # required
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteContactChannel AWS API Documentation
|
628
|
+
#
|
629
|
+
# @overload delete_contact_channel(params = {})
|
630
|
+
# @param [Hash] params ({})
|
631
|
+
def delete_contact_channel(params = {}, options = {})
|
632
|
+
req = build_request(:delete_contact_channel, params)
|
633
|
+
req.send_request(options)
|
634
|
+
end
|
635
|
+
|
636
|
+
# Incident Manager uses engagements to engage contacts and escalation
|
637
|
+
# plans during an incident. Use this command to describe the engagement
|
638
|
+
# that occurred during an incident.
|
639
|
+
#
|
640
|
+
# @option params [required, String] :engagement_id
|
641
|
+
# The Amazon Resource Name (ARN) of the engagement you want the details
|
642
|
+
# of.
|
643
|
+
#
|
644
|
+
# @return [Types::DescribeEngagementResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
645
|
+
#
|
646
|
+
# * {Types::DescribeEngagementResult#contact_arn #contact_arn} => String
|
647
|
+
# * {Types::DescribeEngagementResult#engagement_arn #engagement_arn} => String
|
648
|
+
# * {Types::DescribeEngagementResult#sender #sender} => String
|
649
|
+
# * {Types::DescribeEngagementResult#subject #subject} => String
|
650
|
+
# * {Types::DescribeEngagementResult#content #content} => String
|
651
|
+
# * {Types::DescribeEngagementResult#public_subject #public_subject} => String
|
652
|
+
# * {Types::DescribeEngagementResult#public_content #public_content} => String
|
653
|
+
# * {Types::DescribeEngagementResult#incident_id #incident_id} => String
|
654
|
+
# * {Types::DescribeEngagementResult#start_time #start_time} => Time
|
655
|
+
# * {Types::DescribeEngagementResult#stop_time #stop_time} => Time
|
656
|
+
#
|
657
|
+
# @example Request syntax with placeholder values
|
658
|
+
#
|
659
|
+
# resp = client.describe_engagement({
|
660
|
+
# engagement_id: "SsmContactsArn", # required
|
661
|
+
# })
|
662
|
+
#
|
663
|
+
# @example Response structure
|
664
|
+
#
|
665
|
+
# resp.contact_arn #=> String
|
666
|
+
# resp.engagement_arn #=> String
|
667
|
+
# resp.sender #=> String
|
668
|
+
# resp.subject #=> String
|
669
|
+
# resp.content #=> String
|
670
|
+
# resp.public_subject #=> String
|
671
|
+
# resp.public_content #=> String
|
672
|
+
# resp.incident_id #=> String
|
673
|
+
# resp.start_time #=> Time
|
674
|
+
# resp.stop_time #=> Time
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribeEngagement AWS API Documentation
|
677
|
+
#
|
678
|
+
# @overload describe_engagement(params = {})
|
679
|
+
# @param [Hash] params ({})
|
680
|
+
def describe_engagement(params = {}, options = {})
|
681
|
+
req = build_request(:describe_engagement, params)
|
682
|
+
req.send_request(options)
|
683
|
+
end
|
684
|
+
|
685
|
+
# Lists details of the engagement to a contact channel.
|
686
|
+
#
|
687
|
+
# @option params [required, String] :page_id
|
688
|
+
# The ID of the engagement to a contact channel.
|
689
|
+
#
|
690
|
+
# @return [Types::DescribePageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
691
|
+
#
|
692
|
+
# * {Types::DescribePageResult#page_arn #page_arn} => String
|
693
|
+
# * {Types::DescribePageResult#engagement_arn #engagement_arn} => String
|
694
|
+
# * {Types::DescribePageResult#contact_arn #contact_arn} => String
|
695
|
+
# * {Types::DescribePageResult#sender #sender} => String
|
696
|
+
# * {Types::DescribePageResult#subject #subject} => String
|
697
|
+
# * {Types::DescribePageResult#content #content} => String
|
698
|
+
# * {Types::DescribePageResult#public_subject #public_subject} => String
|
699
|
+
# * {Types::DescribePageResult#public_content #public_content} => String
|
700
|
+
# * {Types::DescribePageResult#incident_id #incident_id} => String
|
701
|
+
# * {Types::DescribePageResult#sent_time #sent_time} => Time
|
702
|
+
# * {Types::DescribePageResult#read_time #read_time} => Time
|
703
|
+
# * {Types::DescribePageResult#delivery_time #delivery_time} => Time
|
704
|
+
#
|
705
|
+
# @example Request syntax with placeholder values
|
706
|
+
#
|
707
|
+
# resp = client.describe_page({
|
708
|
+
# page_id: "SsmContactsArn", # required
|
709
|
+
# })
|
710
|
+
#
|
711
|
+
# @example Response structure
|
712
|
+
#
|
713
|
+
# resp.page_arn #=> String
|
714
|
+
# resp.engagement_arn #=> String
|
715
|
+
# resp.contact_arn #=> String
|
716
|
+
# resp.sender #=> String
|
717
|
+
# resp.subject #=> String
|
718
|
+
# resp.content #=> String
|
719
|
+
# resp.public_subject #=> String
|
720
|
+
# resp.public_content #=> String
|
721
|
+
# resp.incident_id #=> String
|
722
|
+
# resp.sent_time #=> Time
|
723
|
+
# resp.read_time #=> Time
|
724
|
+
# resp.delivery_time #=> Time
|
725
|
+
#
|
726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DescribePage AWS API Documentation
|
727
|
+
#
|
728
|
+
# @overload describe_page(params = {})
|
729
|
+
# @param [Hash] params ({})
|
730
|
+
def describe_page(params = {}, options = {})
|
731
|
+
req = build_request(:describe_page, params)
|
732
|
+
req.send_request(options)
|
733
|
+
end
|
734
|
+
|
735
|
+
# Retrieves information about the specified contact or escalation plan.
|
736
|
+
#
|
737
|
+
# @option params [required, String] :contact_id
|
738
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
739
|
+
#
|
740
|
+
# @return [Types::GetContactResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
741
|
+
#
|
742
|
+
# * {Types::GetContactResult#contact_arn #contact_arn} => String
|
743
|
+
# * {Types::GetContactResult#alias #alias} => String
|
744
|
+
# * {Types::GetContactResult#display_name #display_name} => String
|
745
|
+
# * {Types::GetContactResult#type #type} => String
|
746
|
+
# * {Types::GetContactResult#plan #plan} => Types::Plan
|
747
|
+
#
|
748
|
+
# @example Request syntax with placeholder values
|
749
|
+
#
|
750
|
+
# resp = client.get_contact({
|
751
|
+
# contact_id: "SsmContactsArn", # required
|
752
|
+
# })
|
753
|
+
#
|
754
|
+
# @example Response structure
|
755
|
+
#
|
756
|
+
# resp.contact_arn #=> String
|
757
|
+
# resp.alias #=> String
|
758
|
+
# resp.display_name #=> String
|
759
|
+
# resp.type #=> String, one of "PERSONAL", "ESCALATION"
|
760
|
+
# resp.plan.stages #=> Array
|
761
|
+
# resp.plan.stages[0].duration_in_minutes #=> Integer
|
762
|
+
# resp.plan.stages[0].targets #=> Array
|
763
|
+
# resp.plan.stages[0].targets[0].channel_target_info.contact_channel_id #=> String
|
764
|
+
# resp.plan.stages[0].targets[0].channel_target_info.retry_interval_in_minutes #=> Integer
|
765
|
+
# resp.plan.stages[0].targets[0].contact_target_info.contact_id #=> String
|
766
|
+
# resp.plan.stages[0].targets[0].contact_target_info.is_essential #=> Boolean
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContact AWS API Documentation
|
769
|
+
#
|
770
|
+
# @overload get_contact(params = {})
|
771
|
+
# @param [Hash] params ({})
|
772
|
+
def get_contact(params = {}, options = {})
|
773
|
+
req = build_request(:get_contact, params)
|
774
|
+
req.send_request(options)
|
775
|
+
end
|
776
|
+
|
777
|
+
# List details about a specific contact channel.
|
778
|
+
#
|
779
|
+
# @option params [required, String] :contact_channel_id
|
780
|
+
# The Amazon Resource Name (ARN) of the contact channel you want
|
781
|
+
# information about.
|
782
|
+
#
|
783
|
+
# @return [Types::GetContactChannelResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
784
|
+
#
|
785
|
+
# * {Types::GetContactChannelResult#contact_arn #contact_arn} => String
|
786
|
+
# * {Types::GetContactChannelResult#contact_channel_arn #contact_channel_arn} => String
|
787
|
+
# * {Types::GetContactChannelResult#name #name} => String
|
788
|
+
# * {Types::GetContactChannelResult#type #type} => String
|
789
|
+
# * {Types::GetContactChannelResult#delivery_address #delivery_address} => Types::ContactChannelAddress
|
790
|
+
# * {Types::GetContactChannelResult#activation_status #activation_status} => String
|
791
|
+
#
|
792
|
+
# @example Request syntax with placeholder values
|
793
|
+
#
|
794
|
+
# resp = client.get_contact_channel({
|
795
|
+
# contact_channel_id: "SsmContactsArn", # required
|
796
|
+
# })
|
797
|
+
#
|
798
|
+
# @example Response structure
|
799
|
+
#
|
800
|
+
# resp.contact_arn #=> String
|
801
|
+
# resp.contact_channel_arn #=> String
|
802
|
+
# resp.name #=> String
|
803
|
+
# resp.type #=> String, one of "SMS", "VOICE", "EMAIL"
|
804
|
+
# resp.delivery_address.simple_address #=> String
|
805
|
+
# resp.activation_status #=> String, one of "ACTIVATED", "NOT_ACTIVATED"
|
806
|
+
#
|
807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannel AWS API Documentation
|
808
|
+
#
|
809
|
+
# @overload get_contact_channel(params = {})
|
810
|
+
# @param [Hash] params ({})
|
811
|
+
def get_contact_channel(params = {}, options = {})
|
812
|
+
req = build_request(:get_contact_channel, params)
|
813
|
+
req.send_request(options)
|
814
|
+
end
|
815
|
+
|
816
|
+
# Retrieves the resource policies attached to the specified contact or
|
817
|
+
# escalation plan.
|
818
|
+
#
|
819
|
+
# @option params [required, String] :contact_arn
|
820
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
821
|
+
#
|
822
|
+
# @return [Types::GetContactPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
823
|
+
#
|
824
|
+
# * {Types::GetContactPolicyResult#contact_arn #contact_arn} => String
|
825
|
+
# * {Types::GetContactPolicyResult#policy #policy} => String
|
826
|
+
#
|
827
|
+
# @example Request syntax with placeholder values
|
828
|
+
#
|
829
|
+
# resp = client.get_contact_policy({
|
830
|
+
# contact_arn: "SsmContactsArn", # required
|
831
|
+
# })
|
832
|
+
#
|
833
|
+
# @example Response structure
|
834
|
+
#
|
835
|
+
# resp.contact_arn #=> String
|
836
|
+
# resp.policy #=> String
|
837
|
+
#
|
838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactPolicy AWS API Documentation
|
839
|
+
#
|
840
|
+
# @overload get_contact_policy(params = {})
|
841
|
+
# @param [Hash] params ({})
|
842
|
+
def get_contact_policy(params = {}, options = {})
|
843
|
+
req = build_request(:get_contact_policy, params)
|
844
|
+
req.send_request(options)
|
845
|
+
end
|
846
|
+
|
847
|
+
# Lists all contact channels for the specified contact.
|
848
|
+
#
|
849
|
+
# @option params [required, String] :contact_id
|
850
|
+
# The Amazon Resource Name (ARN) of the contact.
|
851
|
+
#
|
852
|
+
# @option params [String] :next_token
|
853
|
+
# The pagination token to continue to the next page of results.
|
854
|
+
#
|
855
|
+
# @option params [Integer] :max_results
|
856
|
+
# The maximum number of contact channels per page.
|
857
|
+
#
|
858
|
+
# @return [Types::ListContactChannelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
859
|
+
#
|
860
|
+
# * {Types::ListContactChannelsResult#next_token #next_token} => String
|
861
|
+
# * {Types::ListContactChannelsResult#contact_channels #contact_channels} => Array<Types::ContactChannel>
|
862
|
+
#
|
863
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
864
|
+
#
|
865
|
+
# @example Request syntax with placeholder values
|
866
|
+
#
|
867
|
+
# resp = client.list_contact_channels({
|
868
|
+
# contact_id: "SsmContactsArn", # required
|
869
|
+
# next_token: "PaginationToken",
|
870
|
+
# max_results: 1,
|
871
|
+
# })
|
872
|
+
#
|
873
|
+
# @example Response structure
|
874
|
+
#
|
875
|
+
# resp.next_token #=> String
|
876
|
+
# resp.contact_channels #=> Array
|
877
|
+
# resp.contact_channels[0].contact_channel_arn #=> String
|
878
|
+
# resp.contact_channels[0].contact_arn #=> String
|
879
|
+
# resp.contact_channels[0].name #=> String
|
880
|
+
# resp.contact_channels[0].type #=> String, one of "SMS", "VOICE", "EMAIL"
|
881
|
+
# resp.contact_channels[0].delivery_address.simple_address #=> String
|
882
|
+
# resp.contact_channels[0].activation_status #=> String, one of "ACTIVATED", "NOT_ACTIVATED"
|
883
|
+
#
|
884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContactChannels AWS API Documentation
|
885
|
+
#
|
886
|
+
# @overload list_contact_channels(params = {})
|
887
|
+
# @param [Hash] params ({})
|
888
|
+
def list_contact_channels(params = {}, options = {})
|
889
|
+
req = build_request(:list_contact_channels, params)
|
890
|
+
req.send_request(options)
|
891
|
+
end
|
892
|
+
|
893
|
+
# Lists all contacts and escalation plans in Incident Manager.
|
894
|
+
#
|
895
|
+
# @option params [String] :next_token
|
896
|
+
# The pagination token to continue to the next page of results.
|
897
|
+
#
|
898
|
+
# @option params [Integer] :max_results
|
899
|
+
# The maximum number of contacts and escalation plans per page of
|
900
|
+
# results.
|
901
|
+
#
|
902
|
+
# @option params [String] :alias_prefix
|
903
|
+
# Used to list only contacts who's aliases start with the specified
|
904
|
+
# prefix.
|
905
|
+
#
|
906
|
+
# @option params [String] :type
|
907
|
+
# The type of contact. A contact is type `PERSONAL` and an escalation
|
908
|
+
# plan is type `ESCALATION`.
|
909
|
+
#
|
910
|
+
# @return [Types::ListContactsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
911
|
+
#
|
912
|
+
# * {Types::ListContactsResult#next_token #next_token} => String
|
913
|
+
# * {Types::ListContactsResult#contacts #contacts} => Array<Types::Contact>
|
914
|
+
#
|
915
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
916
|
+
#
|
917
|
+
# @example Request syntax with placeholder values
|
918
|
+
#
|
919
|
+
# resp = client.list_contacts({
|
920
|
+
# next_token: "PaginationToken",
|
921
|
+
# max_results: 1,
|
922
|
+
# alias_prefix: "ContactAlias",
|
923
|
+
# type: "PERSONAL", # accepts PERSONAL, ESCALATION
|
924
|
+
# })
|
925
|
+
#
|
926
|
+
# @example Response structure
|
927
|
+
#
|
928
|
+
# resp.next_token #=> String
|
929
|
+
# resp.contacts #=> Array
|
930
|
+
# resp.contacts[0].contact_arn #=> String
|
931
|
+
# resp.contacts[0].alias #=> String
|
932
|
+
# resp.contacts[0].display_name #=> String
|
933
|
+
# resp.contacts[0].type #=> String, one of "PERSONAL", "ESCALATION"
|
934
|
+
#
|
935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListContacts AWS API Documentation
|
936
|
+
#
|
937
|
+
# @overload list_contacts(params = {})
|
938
|
+
# @param [Hash] params ({})
|
939
|
+
def list_contacts(params = {}, options = {})
|
940
|
+
req = build_request(:list_contacts, params)
|
941
|
+
req.send_request(options)
|
942
|
+
end
|
943
|
+
|
944
|
+
# Lists all engagements that have happened in an incident.
|
945
|
+
#
|
946
|
+
# @option params [String] :next_token
|
947
|
+
# The pagination token to continue to the next page of results.
|
948
|
+
#
|
949
|
+
# @option params [Integer] :max_results
|
950
|
+
# The maximum number of engagements per page of results.
|
951
|
+
#
|
952
|
+
# @option params [String] :incident_id
|
953
|
+
# The Amazon Resource Name (ARN) of the incident you're listing
|
954
|
+
# engagements for.
|
955
|
+
#
|
956
|
+
# @option params [Types::TimeRange] :time_range_value
|
957
|
+
# The time range to lists engagements for an incident.
|
958
|
+
#
|
959
|
+
# @return [Types::ListEngagementsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
|
+
#
|
961
|
+
# * {Types::ListEngagementsResult#next_token #next_token} => String
|
962
|
+
# * {Types::ListEngagementsResult#engagements #engagements} => Array<Types::Engagement>
|
963
|
+
#
|
964
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
965
|
+
#
|
966
|
+
# @example Request syntax with placeholder values
|
967
|
+
#
|
968
|
+
# resp = client.list_engagements({
|
969
|
+
# next_token: "PaginationToken",
|
970
|
+
# max_results: 1,
|
971
|
+
# incident_id: "IncidentId",
|
972
|
+
# time_range_value: {
|
973
|
+
# start_time: Time.now,
|
974
|
+
# end_time: Time.now,
|
975
|
+
# },
|
976
|
+
# })
|
977
|
+
#
|
978
|
+
# @example Response structure
|
979
|
+
#
|
980
|
+
# resp.next_token #=> String
|
981
|
+
# resp.engagements #=> Array
|
982
|
+
# resp.engagements[0].engagement_arn #=> String
|
983
|
+
# resp.engagements[0].contact_arn #=> String
|
984
|
+
# resp.engagements[0].sender #=> String
|
985
|
+
# resp.engagements[0].incident_id #=> String
|
986
|
+
# resp.engagements[0].start_time #=> Time
|
987
|
+
# resp.engagements[0].stop_time #=> Time
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListEngagements AWS API Documentation
|
990
|
+
#
|
991
|
+
# @overload list_engagements(params = {})
|
992
|
+
# @param [Hash] params ({})
|
993
|
+
def list_engagements(params = {}, options = {})
|
994
|
+
req = build_request(:list_engagements, params)
|
995
|
+
req.send_request(options)
|
996
|
+
end
|
997
|
+
|
998
|
+
# Lists all of the engagements to contact channels that have been
|
999
|
+
# acknowledged.
|
1000
|
+
#
|
1001
|
+
# @option params [required, String] :page_id
|
1002
|
+
# The Amazon Resource Name (ARN) of the engagement to a specific contact
|
1003
|
+
# channel.
|
1004
|
+
#
|
1005
|
+
# @option params [String] :next_token
|
1006
|
+
# The pagination token to continue to the next page of results.
|
1007
|
+
#
|
1008
|
+
# @option params [Integer] :max_results
|
1009
|
+
# The maximum number of acknowledgements per page of results.
|
1010
|
+
#
|
1011
|
+
# @return [Types::ListPageReceiptsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1012
|
+
#
|
1013
|
+
# * {Types::ListPageReceiptsResult#next_token #next_token} => String
|
1014
|
+
# * {Types::ListPageReceiptsResult#receipts #receipts} => Array<Types::Receipt>
|
1015
|
+
#
|
1016
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1017
|
+
#
|
1018
|
+
# @example Request syntax with placeholder values
|
1019
|
+
#
|
1020
|
+
# resp = client.list_page_receipts({
|
1021
|
+
# page_id: "SsmContactsArn", # required
|
1022
|
+
# next_token: "PaginationToken",
|
1023
|
+
# max_results: 1,
|
1024
|
+
# })
|
1025
|
+
#
|
1026
|
+
# @example Response structure
|
1027
|
+
#
|
1028
|
+
# resp.next_token #=> String
|
1029
|
+
# resp.receipts #=> Array
|
1030
|
+
# resp.receipts[0].contact_channel_arn #=> String
|
1031
|
+
# resp.receipts[0].receipt_type #=> String, one of "DELIVERED", "ERROR", "READ", "SENT", "STOP"
|
1032
|
+
# resp.receipts[0].receipt_info #=> String
|
1033
|
+
# resp.receipts[0].receipt_time #=> Time
|
1034
|
+
#
|
1035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageReceipts AWS API Documentation
|
1036
|
+
#
|
1037
|
+
# @overload list_page_receipts(params = {})
|
1038
|
+
# @param [Hash] params ({})
|
1039
|
+
def list_page_receipts(params = {}, options = {})
|
1040
|
+
req = build_request(:list_page_receipts, params)
|
1041
|
+
req.send_request(options)
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
# Lists the engagements to a contact's contact channels.
|
1045
|
+
#
|
1046
|
+
# @option params [required, String] :contact_id
|
1047
|
+
# The Amazon Resource Name (ARN) of the contact you are retrieving
|
1048
|
+
# engagements for.
|
1049
|
+
#
|
1050
|
+
# @option params [String] :next_token
|
1051
|
+
# The pagination token to continue to the next page of results.
|
1052
|
+
#
|
1053
|
+
# @option params [Integer] :max_results
|
1054
|
+
# The maximum number of engagements to contact channels to list per page
|
1055
|
+
# of results.
|
1056
|
+
#
|
1057
|
+
# @return [Types::ListPagesByContactResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1058
|
+
#
|
1059
|
+
# * {Types::ListPagesByContactResult#next_token #next_token} => String
|
1060
|
+
# * {Types::ListPagesByContactResult#pages #pages} => Array<Types::Page>
|
1061
|
+
#
|
1062
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1063
|
+
#
|
1064
|
+
# @example Request syntax with placeholder values
|
1065
|
+
#
|
1066
|
+
# resp = client.list_pages_by_contact({
|
1067
|
+
# contact_id: "SsmContactsArn", # required
|
1068
|
+
# next_token: "PaginationToken",
|
1069
|
+
# max_results: 1,
|
1070
|
+
# })
|
1071
|
+
#
|
1072
|
+
# @example Response structure
|
1073
|
+
#
|
1074
|
+
# resp.next_token #=> String
|
1075
|
+
# resp.pages #=> Array
|
1076
|
+
# resp.pages[0].page_arn #=> String
|
1077
|
+
# resp.pages[0].engagement_arn #=> String
|
1078
|
+
# resp.pages[0].contact_arn #=> String
|
1079
|
+
# resp.pages[0].sender #=> String
|
1080
|
+
# resp.pages[0].incident_id #=> String
|
1081
|
+
# resp.pages[0].sent_time #=> Time
|
1082
|
+
# resp.pages[0].delivery_time #=> Time
|
1083
|
+
# resp.pages[0].read_time #=> Time
|
1084
|
+
#
|
1085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByContact AWS API Documentation
|
1086
|
+
#
|
1087
|
+
# @overload list_pages_by_contact(params = {})
|
1088
|
+
# @param [Hash] params ({})
|
1089
|
+
def list_pages_by_contact(params = {}, options = {})
|
1090
|
+
req = build_request(:list_pages_by_contact, params)
|
1091
|
+
req.send_request(options)
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
# Lists the engagements to contact channels that occurred by engaging a
|
1095
|
+
# contact.
|
1096
|
+
#
|
1097
|
+
# @option params [required, String] :engagement_id
|
1098
|
+
# The Amazon Resource Name (ARN) of the engagement.
|
1099
|
+
#
|
1100
|
+
# @option params [String] :next_token
|
1101
|
+
# The pagination token to continue to the next page of results.
|
1102
|
+
#
|
1103
|
+
# @option params [Integer] :max_results
|
1104
|
+
# The maximum number of engagements to contact channels to list per page
|
1105
|
+
# of results.
|
1106
|
+
#
|
1107
|
+
# @return [Types::ListPagesByEngagementResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1108
|
+
#
|
1109
|
+
# * {Types::ListPagesByEngagementResult#next_token #next_token} => String
|
1110
|
+
# * {Types::ListPagesByEngagementResult#pages #pages} => Array<Types::Page>
|
1111
|
+
#
|
1112
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1113
|
+
#
|
1114
|
+
# @example Request syntax with placeholder values
|
1115
|
+
#
|
1116
|
+
# resp = client.list_pages_by_engagement({
|
1117
|
+
# engagement_id: "SsmContactsArn", # required
|
1118
|
+
# next_token: "PaginationToken",
|
1119
|
+
# max_results: 1,
|
1120
|
+
# })
|
1121
|
+
#
|
1122
|
+
# @example Response structure
|
1123
|
+
#
|
1124
|
+
# resp.next_token #=> String
|
1125
|
+
# resp.pages #=> Array
|
1126
|
+
# resp.pages[0].page_arn #=> String
|
1127
|
+
# resp.pages[0].engagement_arn #=> String
|
1128
|
+
# resp.pages[0].contact_arn #=> String
|
1129
|
+
# resp.pages[0].sender #=> String
|
1130
|
+
# resp.pages[0].incident_id #=> String
|
1131
|
+
# resp.pages[0].sent_time #=> Time
|
1132
|
+
# resp.pages[0].delivery_time #=> Time
|
1133
|
+
# resp.pages[0].read_time #=> Time
|
1134
|
+
#
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPagesByEngagement AWS API Documentation
|
1136
|
+
#
|
1137
|
+
# @overload list_pages_by_engagement(params = {})
|
1138
|
+
# @param [Hash] params ({})
|
1139
|
+
def list_pages_by_engagement(params = {}, options = {})
|
1140
|
+
req = build_request(:list_pages_by_engagement, params)
|
1141
|
+
req.send_request(options)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Lists the tags of an escalation plan or contact.
|
1145
|
+
#
|
1146
|
+
# @option params [required, String] :resource_arn
|
1147
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1148
|
+
#
|
1149
|
+
# @return [Types::ListTagsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1150
|
+
#
|
1151
|
+
# * {Types::ListTagsForResourceResult#tags #tags} => Array<Types::Tag>
|
1152
|
+
#
|
1153
|
+
# @example Request syntax with placeholder values
|
1154
|
+
#
|
1155
|
+
# resp = client.list_tags_for_resource({
|
1156
|
+
# resource_arn: "AmazonResourceName", # required
|
1157
|
+
# })
|
1158
|
+
#
|
1159
|
+
# @example Response structure
|
1160
|
+
#
|
1161
|
+
# resp.tags #=> Array
|
1162
|
+
# resp.tags[0].key #=> String
|
1163
|
+
# resp.tags[0].value #=> String
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResource AWS API Documentation
|
1166
|
+
#
|
1167
|
+
# @overload list_tags_for_resource(params = {})
|
1168
|
+
# @param [Hash] params ({})
|
1169
|
+
def list_tags_for_resource(params = {}, options = {})
|
1170
|
+
req = build_request(:list_tags_for_resource, params)
|
1171
|
+
req.send_request(options)
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# Adds a resource to the specified contact or escalation plan.
|
1175
|
+
#
|
1176
|
+
# @option params [required, String] :contact_arn
|
1177
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1178
|
+
#
|
1179
|
+
# @option params [required, String] :policy
|
1180
|
+
# Details of the resource policy.
|
1181
|
+
#
|
1182
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1183
|
+
#
|
1184
|
+
# @example Request syntax with placeholder values
|
1185
|
+
#
|
1186
|
+
# resp = client.put_contact_policy({
|
1187
|
+
# contact_arn: "SsmContactsArn", # required
|
1188
|
+
# policy: "Policy", # required
|
1189
|
+
# })
|
1190
|
+
#
|
1191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PutContactPolicy AWS API Documentation
|
1192
|
+
#
|
1193
|
+
# @overload put_contact_policy(params = {})
|
1194
|
+
# @param [Hash] params ({})
|
1195
|
+
def put_contact_policy(params = {}, options = {})
|
1196
|
+
req = build_request(:put_contact_policy, params)
|
1197
|
+
req.send_request(options)
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
# Sends an activation code to a contact channel. The contact can use
|
1201
|
+
# this code to activate the contact channel in the console or with the
|
1202
|
+
# `ActivateChannel` action. Incident Manager can't engage a contact
|
1203
|
+
# channel until it has been activated.
|
1204
|
+
#
|
1205
|
+
# @option params [required, String] :contact_channel_id
|
1206
|
+
# The Amazon Resource Name (ARN) of the contact channel.
|
1207
|
+
#
|
1208
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1209
|
+
#
|
1210
|
+
# @example Request syntax with placeholder values
|
1211
|
+
#
|
1212
|
+
# resp = client.send_activation_code({
|
1213
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1214
|
+
# })
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/SendActivationCode AWS API Documentation
|
1217
|
+
#
|
1218
|
+
# @overload send_activation_code(params = {})
|
1219
|
+
# @param [Hash] params ({})
|
1220
|
+
def send_activation_code(params = {}, options = {})
|
1221
|
+
req = build_request(:send_activation_code, params)
|
1222
|
+
req.send_request(options)
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Starts an engagement to a contact or escalation plan. The engagement
|
1226
|
+
# engages each contact specified in the incident.
|
1227
|
+
#
|
1228
|
+
# @option params [required, String] :contact_id
|
1229
|
+
# The Amazon Resource Name (ARN) of the contact being engaged.
|
1230
|
+
#
|
1231
|
+
# @option params [required, String] :sender
|
1232
|
+
# The user that started the engagement.
|
1233
|
+
#
|
1234
|
+
# @option params [required, String] :subject
|
1235
|
+
# The secure subject of the message that was sent to the contact. Use
|
1236
|
+
# this field for engagements to `VOICE` or `EMAIL`.
|
1237
|
+
#
|
1238
|
+
# @option params [required, String] :content
|
1239
|
+
# The secure content of the message that was sent to the contact. Use
|
1240
|
+
# this field for engagements to `VOICE` or `EMAIL`.
|
1241
|
+
#
|
1242
|
+
# @option params [String] :public_subject
|
1243
|
+
# The insecure subject of the message that was sent to the contact. Use
|
1244
|
+
# this field for engagements to `SMS`.
|
1245
|
+
#
|
1246
|
+
# @option params [String] :public_content
|
1247
|
+
# The insecure content of the message that was sent to the contact. Use
|
1248
|
+
# this field for engagements to `SMS`.
|
1249
|
+
#
|
1250
|
+
# @option params [String] :incident_id
|
1251
|
+
# The ARN of the incident that the engagement is part of.
|
1252
|
+
#
|
1253
|
+
# @option params [String] :idempotency_token
|
1254
|
+
# A token ensuring that the action is called only once with the
|
1255
|
+
# specified details.
|
1256
|
+
#
|
1257
|
+
# **A suitable default value is auto-generated.** You should normally
|
1258
|
+
# not need to pass this option.**
|
1259
|
+
#
|
1260
|
+
# @return [Types::StartEngagementResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1261
|
+
#
|
1262
|
+
# * {Types::StartEngagementResult#engagement_arn #engagement_arn} => String
|
1263
|
+
#
|
1264
|
+
# @example Request syntax with placeholder values
|
1265
|
+
#
|
1266
|
+
# resp = client.start_engagement({
|
1267
|
+
# contact_id: "SsmContactsArn", # required
|
1268
|
+
# sender: "Sender", # required
|
1269
|
+
# subject: "Subject", # required
|
1270
|
+
# content: "Content", # required
|
1271
|
+
# public_subject: "PublicSubject",
|
1272
|
+
# public_content: "PublicContent",
|
1273
|
+
# incident_id: "IncidentId",
|
1274
|
+
# idempotency_token: "IdempotencyToken",
|
1275
|
+
# })
|
1276
|
+
#
|
1277
|
+
# @example Response structure
|
1278
|
+
#
|
1279
|
+
# resp.engagement_arn #=> String
|
1280
|
+
#
|
1281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StartEngagement AWS API Documentation
|
1282
|
+
#
|
1283
|
+
# @overload start_engagement(params = {})
|
1284
|
+
# @param [Hash] params ({})
|
1285
|
+
def start_engagement(params = {}, options = {})
|
1286
|
+
req = build_request(:start_engagement, params)
|
1287
|
+
req.send_request(options)
|
1288
|
+
end
|
1289
|
+
|
1290
|
+
# Stops an engagement before it finishes the final stage of the
|
1291
|
+
# escalation plan or engagement plan. Further contacts aren't engaged.
|
1292
|
+
#
|
1293
|
+
# @option params [required, String] :engagement_id
|
1294
|
+
# The Amazon Resource Name (ARN) of the engagement.
|
1295
|
+
#
|
1296
|
+
# @option params [String] :reason
|
1297
|
+
# The reason that you're stopping the engagement.
|
1298
|
+
#
|
1299
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1300
|
+
#
|
1301
|
+
# @example Request syntax with placeholder values
|
1302
|
+
#
|
1303
|
+
# resp = client.stop_engagement({
|
1304
|
+
# engagement_id: "SsmContactsArn", # required
|
1305
|
+
# reason: "StopReason",
|
1306
|
+
# })
|
1307
|
+
#
|
1308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/StopEngagement AWS API Documentation
|
1309
|
+
#
|
1310
|
+
# @overload stop_engagement(params = {})
|
1311
|
+
# @param [Hash] params ({})
|
1312
|
+
def stop_engagement(params = {}, options = {})
|
1313
|
+
req = build_request(:stop_engagement, params)
|
1314
|
+
req.send_request(options)
|
1315
|
+
end
|
1316
|
+
|
1317
|
+
# Tags a contact or escalation plan. You can tag only contacts and
|
1318
|
+
# escalation plans in the first region of your replication set.
|
1319
|
+
#
|
1320
|
+
# @option params [required, String] :resource_arn
|
1321
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1322
|
+
#
|
1323
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1324
|
+
# A list of tags that you are adding to the contact or escalation plan.
|
1325
|
+
#
|
1326
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1327
|
+
#
|
1328
|
+
# @example Request syntax with placeholder values
|
1329
|
+
#
|
1330
|
+
# resp = client.tag_resource({
|
1331
|
+
# resource_arn: "AmazonResourceName", # required
|
1332
|
+
# tags: [ # required
|
1333
|
+
# {
|
1334
|
+
# key: "TagKey",
|
1335
|
+
# value: "TagValue",
|
1336
|
+
# },
|
1337
|
+
# ],
|
1338
|
+
# })
|
1339
|
+
#
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/TagResource AWS API Documentation
|
1341
|
+
#
|
1342
|
+
# @overload tag_resource(params = {})
|
1343
|
+
# @param [Hash] params ({})
|
1344
|
+
def tag_resource(params = {}, options = {})
|
1345
|
+
req = build_request(:tag_resource, params)
|
1346
|
+
req.send_request(options)
|
1347
|
+
end
|
1348
|
+
|
1349
|
+
# Removes tags from the specified resource.
|
1350
|
+
#
|
1351
|
+
# @option params [required, String] :resource_arn
|
1352
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan.
|
1353
|
+
#
|
1354
|
+
# @option params [required, Array<String>] :tag_keys
|
1355
|
+
# The key of the tag that you want to remove.
|
1356
|
+
#
|
1357
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1358
|
+
#
|
1359
|
+
# @example Request syntax with placeholder values
|
1360
|
+
#
|
1361
|
+
# resp = client.untag_resource({
|
1362
|
+
# resource_arn: "AmazonResourceName", # required
|
1363
|
+
# tag_keys: ["TagKey"], # required
|
1364
|
+
# })
|
1365
|
+
#
|
1366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UntagResource AWS API Documentation
|
1367
|
+
#
|
1368
|
+
# @overload untag_resource(params = {})
|
1369
|
+
# @param [Hash] params ({})
|
1370
|
+
def untag_resource(params = {}, options = {})
|
1371
|
+
req = build_request(:untag_resource, params)
|
1372
|
+
req.send_request(options)
|
1373
|
+
end
|
1374
|
+
|
1375
|
+
# Updates the contact or escalation plan specified.
|
1376
|
+
#
|
1377
|
+
# @option params [required, String] :contact_id
|
1378
|
+
# The Amazon Resource Name (ARN) of the contact or escalation plan
|
1379
|
+
# you're updating.
|
1380
|
+
#
|
1381
|
+
# @option params [String] :display_name
|
1382
|
+
# The full name of the contact or escalation plan.
|
1383
|
+
#
|
1384
|
+
# @option params [Types::Plan] :plan
|
1385
|
+
# A list of stages. A contact has an engagement plan with stages for
|
1386
|
+
# specified contact channels. An escalation plan uses these stages to
|
1387
|
+
# contact specified contacts.
|
1388
|
+
#
|
1389
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1390
|
+
#
|
1391
|
+
# @example Request syntax with placeholder values
|
1392
|
+
#
|
1393
|
+
# resp = client.update_contact({
|
1394
|
+
# contact_id: "SsmContactsArn", # required
|
1395
|
+
# display_name: "ContactName",
|
1396
|
+
# plan: {
|
1397
|
+
# stages: [ # required
|
1398
|
+
# {
|
1399
|
+
# duration_in_minutes: 1, # required
|
1400
|
+
# targets: [ # required
|
1401
|
+
# {
|
1402
|
+
# channel_target_info: {
|
1403
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1404
|
+
# retry_interval_in_minutes: 1,
|
1405
|
+
# },
|
1406
|
+
# contact_target_info: {
|
1407
|
+
# contact_id: "SsmContactsArn",
|
1408
|
+
# is_essential: false, # required
|
1409
|
+
# },
|
1410
|
+
# },
|
1411
|
+
# ],
|
1412
|
+
# },
|
1413
|
+
# ],
|
1414
|
+
# },
|
1415
|
+
# })
|
1416
|
+
#
|
1417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContact AWS API Documentation
|
1418
|
+
#
|
1419
|
+
# @overload update_contact(params = {})
|
1420
|
+
# @param [Hash] params ({})
|
1421
|
+
def update_contact(params = {}, options = {})
|
1422
|
+
req = build_request(:update_contact, params)
|
1423
|
+
req.send_request(options)
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# Updates a contact's contact channel.
|
1427
|
+
#
|
1428
|
+
# @option params [required, String] :contact_channel_id
|
1429
|
+
# The Amazon Resource Name (ARN) of the contact channel you want to
|
1430
|
+
# update.
|
1431
|
+
#
|
1432
|
+
# @option params [String] :name
|
1433
|
+
# The name of the contact channel
|
1434
|
+
#
|
1435
|
+
# @option params [Types::ContactChannelAddress] :delivery_address
|
1436
|
+
# The details that Incident Manager uses when trying to engage the
|
1437
|
+
# contact channel.
|
1438
|
+
#
|
1439
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1440
|
+
#
|
1441
|
+
# @example Request syntax with placeholder values
|
1442
|
+
#
|
1443
|
+
# resp = client.update_contact_channel({
|
1444
|
+
# contact_channel_id: "SsmContactsArn", # required
|
1445
|
+
# name: "ChannelName",
|
1446
|
+
# delivery_address: {
|
1447
|
+
# simple_address: "SimpleAddress",
|
1448
|
+
# },
|
1449
|
+
# })
|
1450
|
+
#
|
1451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateContactChannel AWS API Documentation
|
1452
|
+
#
|
1453
|
+
# @overload update_contact_channel(params = {})
|
1454
|
+
# @param [Hash] params ({})
|
1455
|
+
def update_contact_channel(params = {}, options = {})
|
1456
|
+
req = build_request(:update_contact_channel, params)
|
1457
|
+
req.send_request(options)
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
# @!endgroup
|
1461
|
+
|
1462
|
+
# @param params ({})
|
1463
|
+
# @api private
|
1464
|
+
def build_request(operation_name, params = {})
|
1465
|
+
handlers = @handlers.for(operation_name)
|
1466
|
+
context = Seahorse::Client::RequestContext.new(
|
1467
|
+
operation_name: operation_name,
|
1468
|
+
operation: config.api.operation(operation_name),
|
1469
|
+
client: self,
|
1470
|
+
params: params,
|
1471
|
+
config: config)
|
1472
|
+
context[:gem_name] = 'aws-sdk-ssmcontacts'
|
1473
|
+
context[:gem_version] = '1.0.0'
|
1474
|
+
Seahorse::Client::Request.new(handlers, context)
|
1475
|
+
end
|
1476
|
+
|
1477
|
+
# @api private
|
1478
|
+
# @deprecated
|
1479
|
+
def waiter_names
|
1480
|
+
[]
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
class << self
|
1484
|
+
|
1485
|
+
# @api private
|
1486
|
+
attr_reader :identifier
|
1487
|
+
|
1488
|
+
# @api private
|
1489
|
+
def errors_module
|
1490
|
+
Errors
|
1491
|
+
end
|
1492
|
+
|
1493
|
+
end
|
1494
|
+
end
|
1495
|
+
end
|