aws-sdk-codedeploy 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 556b62d94f9012238d53d3c49fe3b638a026b4fd
4
- data.tar.gz: d3f9239d83d7caf7cc5568a3a70f55d856417e2c
3
+ metadata.gz: cb9facdd273ca2bce4740dbd4edf87d72039fba5
4
+ data.tar.gz: d6dbe0d02bd651e36fb2d88c1f68ed0bd387590b
5
5
  SHA512:
6
- metadata.gz: 9e6debd835e026b3368f8ac3c07db7ec481754a81e44e324a1444c77d23b30b2438118fe183d4f4f4a07e348752fbc2835f7e8f975c652a44f7fae222bec5661
7
- data.tar.gz: 9b4bdaacb12d41a8d30ec16c68acf726e254bc3b918eb5462b4950f25d575c11176f17d37cbc768a98e797c358ddaf263acc42bdd39ba527366b7265c7d58076
6
+ metadata.gz: dc225789efb079a2cb39a4be8b4ad304609c970fc5ae7b8db9a77517cdeffc611f8e6dabeff4f0caec67fdb2335a479d1581673a442fba39eef0785e7f7df1db
7
+ data.tar.gz: ab90e174a1157c8cc310b189896392dbde548416d0a440078b2dee2996f05a6bab44c1567b8d62a033086910dfffc1892b7c48d915f3b52c438e62c43f1e8f12
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -23,1772 +23,1975 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
23
 
24
24
  Aws::Plugins::GlobalConfiguration.add_identifier(:codedeploy)
25
25
 
26
- module Aws
27
- module CodeDeploy
28
- class Client < Seahorse::Client::Base
26
+ module Aws::CodeDeploy
27
+ class Client < Seahorse::Client::Base
29
28
 
30
- include Aws::ClientStubs
29
+ include Aws::ClientStubs
31
30
 
32
- @identifier = :codedeploy
31
+ @identifier = :codedeploy
33
32
 
34
- set_api(ClientApi::API)
33
+ set_api(ClientApi::API)
35
34
 
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::JsonRpc)
35
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
36
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
37
+ add_plugin(Aws::Plugins::Logging)
38
+ add_plugin(Aws::Plugins::ParamConverter)
39
+ add_plugin(Aws::Plugins::ParamValidator)
40
+ add_plugin(Aws::Plugins::UserAgent)
41
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
42
+ add_plugin(Aws::Plugins::RetryErrors)
43
+ add_plugin(Aws::Plugins::GlobalConfiguration)
44
+ add_plugin(Aws::Plugins::RegionalEndpoint)
45
+ add_plugin(Aws::Plugins::ResponsePaging)
46
+ add_plugin(Aws::Plugins::StubResponses)
47
+ add_plugin(Aws::Plugins::IdempotencyToken)
48
+ add_plugin(Aws::Plugins::SignatureV4)
49
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
50
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :simple_json (false)
117
- # Disables request parameter conversion, validation, and formatting.
118
- # Also disable response data type conversions. This option is useful
119
- # when you want to ensure the highest level of performance by
120
- # avoiding overhead of walking request parameters and response data
121
- # structures.
122
- #
123
- # When `:simple_json` is enabled, the request parameters hash must
124
- # be formatted exactly as the DynamoDB API expects.
125
- # @option options [Boolean] :stub_responses (false)
126
- # Causes the client to return stubbed responses. By default
127
- # fake responses are generated and returned. You can specify
128
- # the response data to return or errors to raise by calling
129
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
130
- #
131
- # ** Please note ** When response stubbing is enabled, no HTTP
132
- # requests are made, and retries are disabled.
133
- # @option options [Boolean] :validate_params (true)
134
- # When `true`, request parameters are validated before
135
- # sending the request.
136
- def initialize(*args)
137
- super
138
- end
139
-
140
- # @!group API Operations
51
+ # @option options [required, Aws::CredentialProvider] :credentials
52
+ # Your AWS credentials. This can be an instance of any one of the
53
+ # following classes:
54
+ #
55
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
56
+ # credentials.
57
+ #
58
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
59
+ # from an EC2 IMDS on an EC2 instance.
60
+ #
61
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
62
+ # shared file, such as `~/.aws/config`.
63
+ #
64
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
65
+ #
66
+ # When `:credentials` are not configured directly, the following
67
+ # locations will be searched for credentials:
68
+ #
69
+ # * `Aws.config[:credentials]`
70
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
71
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
72
+ # * `~/.aws/credentials`
73
+ # * `~/.aws/config`
74
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
75
+ # very aggressive. Construct and pass an instance of
76
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
77
+ # timeouts.
78
+ #
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ #
91
+ # @option options [String] :access_key_id
92
+ #
93
+ # @option options [Boolean] :convert_params (true)
94
+ # When `true`, an attempt is made to coerce request parameters into
95
+ # the required types.
96
+ #
97
+ # @option options [String] :endpoint
98
+ # The client endpoint is normally constructed from the `:region`
99
+ # option. You should only configure an `:endpoint` when connecting
100
+ # to test endpoints. This should be avalid HTTP(S) URI.
101
+ #
102
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
103
+ # The log formatter.
104
+ #
105
+ # @option options [Symbol] :log_level (:info)
106
+ # The log level to send messages to the `:logger` at.
107
+ #
108
+ # @option options [Logger] :logger
109
+ # The Logger instance to send log messages to. If this option
110
+ # is not set, logging will be disabled.
111
+ #
112
+ # @option options [String] :profile ("default")
113
+ # Used when loading credentials from the shared credentials file
114
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
115
+ #
116
+ # @option options [Integer] :retry_limit (3)
117
+ # The maximum number of times to retry failed requests. Only
118
+ # ~ 500 level server errors and certain ~ 400 level client errors
119
+ # are retried. Generally, these are throttling errors, data
120
+ # checksum errors, networking errors, timeout errors and auth
121
+ # errors from expired credentials.
122
+ #
123
+ # @option options [String] :secret_access_key
124
+ #
125
+ # @option options [String] :session_token
126
+ #
127
+ # @option options [Boolean] :simple_json (false)
128
+ # Disables request parameter conversion, validation, and formatting.
129
+ # Also disable response data type conversions. This option is useful
130
+ # when you want to ensure the highest level of performance by
131
+ # avoiding overhead of walking request parameters and response data
132
+ # structures.
133
+ #
134
+ # When `:simple_json` is enabled, the request parameters hash must
135
+ # be formatted exactly as the DynamoDB API expects.
136
+ #
137
+ # @option options [Boolean] :stub_responses (false)
138
+ # Causes the client to return stubbed responses. By default
139
+ # fake responses are generated and returned. You can specify
140
+ # the response data to return or errors to raise by calling
141
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
142
+ #
143
+ # ** Please note ** When response stubbing is enabled, no HTTP
144
+ # requests are made, and retries are disabled.
145
+ #
146
+ # @option options [Boolean] :validate_params (true)
147
+ # When `true`, request parameters are validated before
148
+ # sending the request.
149
+ #
150
+ def initialize(*args)
151
+ super
152
+ end
141
153
 
142
- # Adds tags to on-premises instances.
143
- # @option params [required, Array<Types::Tag>] :tags
144
- # The tag key-value pairs to add to the on-premises instances.
145
- #
146
- # Keys and values are both required. Keys cannot be null or empty
147
- # strings. Value-only tags are not allowed.
148
- # @option params [required, Array<String>] :instance_names
149
- # The names of the on-premises instances to which to add tags.
150
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
151
- #
152
- # @example Request syntax with placeholder values
153
- # resp = client.add_tags_to_on_premises_instances({
154
- # tags: [ # required
155
- # {
156
- # key: "Key",
157
- # value: "Value",
158
- # },
159
- # ],
160
- # instance_names: ["InstanceName"], # required
161
- # })
162
- # @overload add_tags_to_on_premises_instances(params = {})
163
- # @param [Hash] params ({})
164
- def add_tags_to_on_premises_instances(params = {}, options = {})
165
- req = build_request(:add_tags_to_on_premises_instances, params)
166
- req.send_request(options)
167
- end
154
+ # @!group API Operations
168
155
 
169
- # Gets information about one or more application revisions.
170
- # @option params [required, String] :application_name
171
- # The name of an AWS CodeDeploy application about which to get revision
172
- # information.
173
- # @option params [required, Array<Types::RevisionLocation>] :revisions
174
- # Information to get about the application revisions, including type and
175
- # location.
176
- # @return [Types::BatchGetApplicationRevisionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
177
- #
178
- # * {Types::BatchGetApplicationRevisionsOutput#application_name #applicationName} => String
179
- # * {Types::BatchGetApplicationRevisionsOutput#error_message #errorMessage} => String
180
- # * {Types::BatchGetApplicationRevisionsOutput#revisions #revisions} => Array&lt;Types::RevisionInfo&gt;
181
- #
182
- # @example Request syntax with placeholder values
183
- # resp = client.batch_get_application_revisions({
184
- # application_name: "ApplicationName", # required
185
- # revisions: [ # required
186
- # {
187
- # revision_type: "S3", # accepts S3, GitHub
188
- # s3_location: {
189
- # bucket: "S3Bucket",
190
- # key: "S3Key",
191
- # bundle_type: "tar", # accepts tar, tgz, zip
192
- # version: "VersionId",
193
- # e_tag: "ETag",
194
- # },
195
- # git_hub_location: {
196
- # repository: "Repository",
197
- # commit_id: "CommitId",
198
- # },
199
- # },
200
- # ],
201
- # })
202
- #
203
- # @example Response structure
204
- # resp.application_name #=> String
205
- # resp.error_message #=> String
206
- # resp.revisions #=> Array
207
- # resp.revisions[0].revision_location.revision_type #=> String, one of "S3", "GitHub"
208
- # resp.revisions[0].revision_location.s3_location.bucket #=> String
209
- # resp.revisions[0].revision_location.s3_location.key #=> String
210
- # resp.revisions[0].revision_location.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
211
- # resp.revisions[0].revision_location.s3_location.version #=> String
212
- # resp.revisions[0].revision_location.s3_location.e_tag #=> String
213
- # resp.revisions[0].revision_location.git_hub_location.repository #=> String
214
- # resp.revisions[0].revision_location.git_hub_location.commit_id #=> String
215
- # resp.revisions[0].generic_revision_info.description #=> String
216
- # resp.revisions[0].generic_revision_info.deployment_groups #=> Array
217
- # resp.revisions[0].generic_revision_info.deployment_groups[0] #=> String
218
- # resp.revisions[0].generic_revision_info.first_used_time #=> Time
219
- # resp.revisions[0].generic_revision_info.last_used_time #=> Time
220
- # resp.revisions[0].generic_revision_info.register_time #=> Time
221
- # @overload batch_get_application_revisions(params = {})
222
- # @param [Hash] params ({})
223
- def batch_get_application_revisions(params = {}, options = {})
224
- req = build_request(:batch_get_application_revisions, params)
225
- req.send_request(options)
226
- end
156
+ # Adds tags to on-premises instances.
157
+ #
158
+ # @option params [required, Array<Types::Tag>] :tags
159
+ # The tag key-value pairs to add to the on-premises instances.
160
+ #
161
+ # Keys and values are both required. Keys cannot be null or empty
162
+ # strings. Value-only tags are not allowed.
163
+ #
164
+ # @option params [required, Array<String>] :instance_names
165
+ # The names of the on-premises instances to which to add tags.
166
+ #
167
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
168
+ #
169
+ # @example Request syntax with placeholder values
170
+ #
171
+ # resp = client.add_tags_to_on_premises_instances({
172
+ # tags: [ # required
173
+ # {
174
+ # key: "Key",
175
+ # value: "Value",
176
+ # },
177
+ # ],
178
+ # instance_names: ["InstanceName"], # required
179
+ # })
180
+ #
181
+ # @overload add_tags_to_on_premises_instances(params = {})
182
+ # @param [Hash] params ({})
183
+ def add_tags_to_on_premises_instances(params = {}, options = {})
184
+ req = build_request(:add_tags_to_on_premises_instances, params)
185
+ req.send_request(options)
186
+ end
227
187
 
228
- # Gets information about one or more applications.
229
- # @option params [Array<String>] :application_names
230
- # A list of application names separated by spaces.
231
- # @return [Types::BatchGetApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
232
- #
233
- # * {Types::BatchGetApplicationsOutput#applications_info #applicationsInfo} => Array&lt;Types::ApplicationInfo&gt;
234
- #
235
- # @example Request syntax with placeholder values
236
- # resp = client.batch_get_applications({
237
- # application_names: ["ApplicationName"],
238
- # })
239
- #
240
- # @example Response structure
241
- # resp.applications_info #=> Array
242
- # resp.applications_info[0].application_id #=> String
243
- # resp.applications_info[0].application_name #=> String
244
- # resp.applications_info[0].create_time #=> Time
245
- # resp.applications_info[0].linked_to_git_hub #=> Boolean
246
- # @overload batch_get_applications(params = {})
247
- # @param [Hash] params ({})
248
- def batch_get_applications(params = {}, options = {})
249
- req = build_request(:batch_get_applications, params)
250
- req.send_request(options)
251
- end
188
+ # Gets information about one or more application revisions.
189
+ #
190
+ # @option params [required, String] :application_name
191
+ # The name of an AWS CodeDeploy application about which to get revision
192
+ # information.
193
+ #
194
+ # @option params [required, Array<Types::RevisionLocation>] :revisions
195
+ # Information to get about the application revisions, including type and
196
+ # location.
197
+ #
198
+ # @return [Types::BatchGetApplicationRevisionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
199
+ #
200
+ # * {Types::BatchGetApplicationRevisionsOutput#application_name #application_name} => String
201
+ # * {Types::BatchGetApplicationRevisionsOutput#error_message #error_message} => String
202
+ # * {Types::BatchGetApplicationRevisionsOutput#revisions #revisions} => Array&lt;Types::RevisionInfo&gt;
203
+ #
204
+ # @example Request syntax with placeholder values
205
+ #
206
+ # resp = client.batch_get_application_revisions({
207
+ # application_name: "ApplicationName", # required
208
+ # revisions: [ # required
209
+ # {
210
+ # revision_type: "S3", # accepts S3, GitHub
211
+ # s3_location: {
212
+ # bucket: "S3Bucket",
213
+ # key: "S3Key",
214
+ # bundle_type: "tar", # accepts tar, tgz, zip
215
+ # version: "VersionId",
216
+ # e_tag: "ETag",
217
+ # },
218
+ # git_hub_location: {
219
+ # repository: "Repository",
220
+ # commit_id: "CommitId",
221
+ # },
222
+ # },
223
+ # ],
224
+ # })
225
+ #
226
+ # @example Response structure
227
+ #
228
+ # resp.application_name #=> String
229
+ # resp.error_message #=> String
230
+ # resp.revisions #=> Array
231
+ # resp.revisions[0].revision_location.revision_type #=> String, one of "S3", "GitHub"
232
+ # resp.revisions[0].revision_location.s3_location.bucket #=> String
233
+ # resp.revisions[0].revision_location.s3_location.key #=> String
234
+ # resp.revisions[0].revision_location.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
235
+ # resp.revisions[0].revision_location.s3_location.version #=> String
236
+ # resp.revisions[0].revision_location.s3_location.e_tag #=> String
237
+ # resp.revisions[0].revision_location.git_hub_location.repository #=> String
238
+ # resp.revisions[0].revision_location.git_hub_location.commit_id #=> String
239
+ # resp.revisions[0].generic_revision_info.description #=> String
240
+ # resp.revisions[0].generic_revision_info.deployment_groups #=> Array
241
+ # resp.revisions[0].generic_revision_info.deployment_groups[0] #=> String
242
+ # resp.revisions[0].generic_revision_info.first_used_time #=> Time
243
+ # resp.revisions[0].generic_revision_info.last_used_time #=> Time
244
+ # resp.revisions[0].generic_revision_info.register_time #=> Time
245
+ #
246
+ # @overload batch_get_application_revisions(params = {})
247
+ # @param [Hash] params ({})
248
+ def batch_get_application_revisions(params = {}, options = {})
249
+ req = build_request(:batch_get_application_revisions, params)
250
+ req.send_request(options)
251
+ end
252
252
 
253
- # Get information about one or more deployment groups.
254
- # @option params [required, String] :application_name
255
- # The name of an AWS CodeDeploy application associated with the
256
- # applicable IAM user or AWS account.
257
- # @option params [required, Array<String>] :deployment_group_names
258
- # The deployment groups' names.
259
- # @return [Types::BatchGetDeploymentGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
260
- #
261
- # * {Types::BatchGetDeploymentGroupsOutput#deployment_groups_info #deploymentGroupsInfo} => Array&lt;Types::DeploymentGroupInfo&gt;
262
- # * {Types::BatchGetDeploymentGroupsOutput#error_message #errorMessage} => String
263
- #
264
- # @example Request syntax with placeholder values
265
- # resp = client.batch_get_deployment_groups({
266
- # application_name: "ApplicationName", # required
267
- # deployment_group_names: ["DeploymentGroupName"], # required
268
- # })
269
- #
270
- # @example Response structure
271
- # resp.deployment_groups_info #=> Array
272
- # resp.deployment_groups_info[0].application_name #=> String
273
- # resp.deployment_groups_info[0].deployment_group_id #=> String
274
- # resp.deployment_groups_info[0].deployment_group_name #=> String
275
- # resp.deployment_groups_info[0].deployment_config_name #=> String
276
- # resp.deployment_groups_info[0].ec2_tag_filters #=> Array
277
- # resp.deployment_groups_info[0].ec2_tag_filters[0].key #=> String
278
- # resp.deployment_groups_info[0].ec2_tag_filters[0].value #=> String
279
- # resp.deployment_groups_info[0].ec2_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
280
- # resp.deployment_groups_info[0].on_premises_instance_tag_filters #=> Array
281
- # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].key #=> String
282
- # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].value #=> String
283
- # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
284
- # resp.deployment_groups_info[0].auto_scaling_groups #=> Array
285
- # resp.deployment_groups_info[0].auto_scaling_groups[0].name #=> String
286
- # resp.deployment_groups_info[0].auto_scaling_groups[0].hook #=> String
287
- # resp.deployment_groups_info[0].service_role_arn #=> String
288
- # resp.deployment_groups_info[0].target_revision.revision_type #=> String, one of "S3", "GitHub"
289
- # resp.deployment_groups_info[0].target_revision.s3_location.bucket #=> String
290
- # resp.deployment_groups_info[0].target_revision.s3_location.key #=> String
291
- # resp.deployment_groups_info[0].target_revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
292
- # resp.deployment_groups_info[0].target_revision.s3_location.version #=> String
293
- # resp.deployment_groups_info[0].target_revision.s3_location.e_tag #=> String
294
- # resp.deployment_groups_info[0].target_revision.git_hub_location.repository #=> String
295
- # resp.deployment_groups_info[0].target_revision.git_hub_location.commit_id #=> String
296
- # resp.deployment_groups_info[0].trigger_configurations #=> Array
297
- # resp.deployment_groups_info[0].trigger_configurations[0].trigger_name #=> String
298
- # resp.deployment_groups_info[0].trigger_configurations[0].trigger_target_arn #=> String
299
- # resp.deployment_groups_info[0].trigger_configurations[0].trigger_events #=> Array
300
- # resp.deployment_groups_info[0].trigger_configurations[0].trigger_events[0] #=> String, one of "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "InstanceStart", "InstanceSuccess", "InstanceFailure"
301
- # resp.deployment_groups_info[0].alarm_configuration.enabled #=> Boolean
302
- # resp.deployment_groups_info[0].alarm_configuration.ignore_poll_alarm_failure #=> Boolean
303
- # resp.deployment_groups_info[0].alarm_configuration.alarms #=> Array
304
- # resp.deployment_groups_info[0].alarm_configuration.alarms[0].name #=> String
305
- # resp.deployment_groups_info[0].auto_rollback_configuration.enabled #=> Boolean
306
- # resp.deployment_groups_info[0].auto_rollback_configuration.events #=> Array
307
- # resp.deployment_groups_info[0].auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
308
- # resp.error_message #=> String
309
- # @overload batch_get_deployment_groups(params = {})
310
- # @param [Hash] params ({})
311
- def batch_get_deployment_groups(params = {}, options = {})
312
- req = build_request(:batch_get_deployment_groups, params)
313
- req.send_request(options)
314
- end
253
+ # Gets information about one or more applications.
254
+ #
255
+ # @option params [Array<String>] :application_names
256
+ # A list of application names separated by spaces.
257
+ #
258
+ # @return [Types::BatchGetApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
259
+ #
260
+ # * {Types::BatchGetApplicationsOutput#applications_info #applications_info} => Array&lt;Types::ApplicationInfo&gt;
261
+ #
262
+ # @example Request syntax with placeholder values
263
+ #
264
+ # resp = client.batch_get_applications({
265
+ # application_names: ["ApplicationName"],
266
+ # })
267
+ #
268
+ # @example Response structure
269
+ #
270
+ # resp.applications_info #=> Array
271
+ # resp.applications_info[0].application_id #=> String
272
+ # resp.applications_info[0].application_name #=> String
273
+ # resp.applications_info[0].create_time #=> Time
274
+ # resp.applications_info[0].linked_to_git_hub #=> Boolean
275
+ #
276
+ # @overload batch_get_applications(params = {})
277
+ # @param [Hash] params ({})
278
+ def batch_get_applications(params = {}, options = {})
279
+ req = build_request(:batch_get_applications, params)
280
+ req.send_request(options)
281
+ end
315
282
 
316
- # Gets information about one or more instance that are part of a
317
- # deployment group.
318
- # @option params [required, String] :deployment_id
319
- # The unique ID of a deployment.
320
- # @option params [required, Array<String>] :instance_ids
321
- # The unique IDs of instances in the deployment group.
322
- # @return [Types::BatchGetDeploymentInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
323
- #
324
- # * {Types::BatchGetDeploymentInstancesOutput#instances_summary #instancesSummary} => Array&lt;Types::InstanceSummary&gt;
325
- # * {Types::BatchGetDeploymentInstancesOutput#error_message #errorMessage} => String
326
- #
327
- # @example Request syntax with placeholder values
328
- # resp = client.batch_get_deployment_instances({
329
- # deployment_id: "DeploymentId", # required
330
- # instance_ids: ["InstanceId"], # required
331
- # })
332
- #
333
- # @example Response structure
334
- # resp.instances_summary #=> Array
335
- # resp.instances_summary[0].deployment_id #=> String
336
- # resp.instances_summary[0].instance_id #=> String
337
- # resp.instances_summary[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
338
- # resp.instances_summary[0].last_updated_at #=> Time
339
- # resp.instances_summary[0].lifecycle_events #=> Array
340
- # resp.instances_summary[0].lifecycle_events[0].lifecycle_event_name #=> String
341
- # resp.instances_summary[0].lifecycle_events[0].diagnostics.error_code #=> String, one of "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError"
342
- # resp.instances_summary[0].lifecycle_events[0].diagnostics.script_name #=> String
343
- # resp.instances_summary[0].lifecycle_events[0].diagnostics.message #=> String
344
- # resp.instances_summary[0].lifecycle_events[0].diagnostics.log_tail #=> String
345
- # resp.instances_summary[0].lifecycle_events[0].start_time #=> Time
346
- # resp.instances_summary[0].lifecycle_events[0].end_time #=> Time
347
- # resp.instances_summary[0].lifecycle_events[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
348
- # resp.error_message #=> String
349
- # @overload batch_get_deployment_instances(params = {})
350
- # @param [Hash] params ({})
351
- def batch_get_deployment_instances(params = {}, options = {})
352
- req = build_request(:batch_get_deployment_instances, params)
353
- req.send_request(options)
354
- end
283
+ # Gets information about one or more deployment groups.
284
+ #
285
+ # @option params [required, String] :application_name
286
+ # The name of an AWS CodeDeploy application associated with the
287
+ # applicable IAM user or AWS account.
288
+ #
289
+ # @option params [required, Array<String>] :deployment_group_names
290
+ # The deployment groups' names.
291
+ #
292
+ # @return [Types::BatchGetDeploymentGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
293
+ #
294
+ # * {Types::BatchGetDeploymentGroupsOutput#deployment_groups_info #deployment_groups_info} => Array&lt;Types::DeploymentGroupInfo&gt;
295
+ # * {Types::BatchGetDeploymentGroupsOutput#error_message #error_message} => String
296
+ #
297
+ # @example Request syntax with placeholder values
298
+ #
299
+ # resp = client.batch_get_deployment_groups({
300
+ # application_name: "ApplicationName", # required
301
+ # deployment_group_names: ["DeploymentGroupName"], # required
302
+ # })
303
+ #
304
+ # @example Response structure
305
+ #
306
+ # resp.deployment_groups_info #=> Array
307
+ # resp.deployment_groups_info[0].application_name #=> String
308
+ # resp.deployment_groups_info[0].deployment_group_id #=> String
309
+ # resp.deployment_groups_info[0].deployment_group_name #=> String
310
+ # resp.deployment_groups_info[0].deployment_config_name #=> String
311
+ # resp.deployment_groups_info[0].ec2_tag_filters #=> Array
312
+ # resp.deployment_groups_info[0].ec2_tag_filters[0].key #=> String
313
+ # resp.deployment_groups_info[0].ec2_tag_filters[0].value #=> String
314
+ # resp.deployment_groups_info[0].ec2_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
315
+ # resp.deployment_groups_info[0].on_premises_instance_tag_filters #=> Array
316
+ # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].key #=> String
317
+ # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].value #=> String
318
+ # resp.deployment_groups_info[0].on_premises_instance_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
319
+ # resp.deployment_groups_info[0].auto_scaling_groups #=> Array
320
+ # resp.deployment_groups_info[0].auto_scaling_groups[0].name #=> String
321
+ # resp.deployment_groups_info[0].auto_scaling_groups[0].hook #=> String
322
+ # resp.deployment_groups_info[0].service_role_arn #=> String
323
+ # resp.deployment_groups_info[0].target_revision.revision_type #=> String, one of "S3", "GitHub"
324
+ # resp.deployment_groups_info[0].target_revision.s3_location.bucket #=> String
325
+ # resp.deployment_groups_info[0].target_revision.s3_location.key #=> String
326
+ # resp.deployment_groups_info[0].target_revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
327
+ # resp.deployment_groups_info[0].target_revision.s3_location.version #=> String
328
+ # resp.deployment_groups_info[0].target_revision.s3_location.e_tag #=> String
329
+ # resp.deployment_groups_info[0].target_revision.git_hub_location.repository #=> String
330
+ # resp.deployment_groups_info[0].target_revision.git_hub_location.commit_id #=> String
331
+ # resp.deployment_groups_info[0].trigger_configurations #=> Array
332
+ # resp.deployment_groups_info[0].trigger_configurations[0].trigger_name #=> String
333
+ # resp.deployment_groups_info[0].trigger_configurations[0].trigger_target_arn #=> String
334
+ # resp.deployment_groups_info[0].trigger_configurations[0].trigger_events #=> Array
335
+ # resp.deployment_groups_info[0].trigger_configurations[0].trigger_events[0] #=> String, one of "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "InstanceStart", "InstanceSuccess", "InstanceFailure"
336
+ # resp.deployment_groups_info[0].alarm_configuration.enabled #=> Boolean
337
+ # resp.deployment_groups_info[0].alarm_configuration.ignore_poll_alarm_failure #=> Boolean
338
+ # resp.deployment_groups_info[0].alarm_configuration.alarms #=> Array
339
+ # resp.deployment_groups_info[0].alarm_configuration.alarms[0].name #=> String
340
+ # resp.deployment_groups_info[0].auto_rollback_configuration.enabled #=> Boolean
341
+ # resp.deployment_groups_info[0].auto_rollback_configuration.events #=> Array
342
+ # resp.deployment_groups_info[0].auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
343
+ # resp.error_message #=> String
344
+ #
345
+ # @overload batch_get_deployment_groups(params = {})
346
+ # @param [Hash] params ({})
347
+ def batch_get_deployment_groups(params = {}, options = {})
348
+ req = build_request(:batch_get_deployment_groups, params)
349
+ req.send_request(options)
350
+ end
355
351
 
356
- # Gets information about one or more deployments.
357
- # @option params [Array<String>] :deployment_ids
358
- # A list of deployment IDs, separated by spaces.
359
- # @return [Types::BatchGetDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
360
- #
361
- # * {Types::BatchGetDeploymentsOutput#deployments_info #deploymentsInfo} => Array&lt;Types::DeploymentInfo&gt;
362
- #
363
- # @example Request syntax with placeholder values
364
- # resp = client.batch_get_deployments({
365
- # deployment_ids: ["DeploymentId"],
366
- # })
367
- #
368
- # @example Response structure
369
- # resp.deployments_info #=> Array
370
- # resp.deployments_info[0].application_name #=> String
371
- # resp.deployments_info[0].deployment_group_name #=> String
372
- # resp.deployments_info[0].deployment_config_name #=> String
373
- # resp.deployments_info[0].deployment_id #=> String
374
- # resp.deployments_info[0].revision.revision_type #=> String, one of "S3", "GitHub"
375
- # resp.deployments_info[0].revision.s3_location.bucket #=> String
376
- # resp.deployments_info[0].revision.s3_location.key #=> String
377
- # resp.deployments_info[0].revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
378
- # resp.deployments_info[0].revision.s3_location.version #=> String
379
- # resp.deployments_info[0].revision.s3_location.e_tag #=> String
380
- # resp.deployments_info[0].revision.git_hub_location.repository #=> String
381
- # resp.deployments_info[0].revision.git_hub_location.commit_id #=> String
382
- # resp.deployments_info[0].status #=> String, one of "Created", "Queued", "InProgress", "Succeeded", "Failed", "Stopped"
383
- # resp.deployments_info[0].error_information.code #=> String, one of "DEPLOYMENT_GROUP_MISSING", "APPLICATION_MISSING", "REVISION_MISSING", "IAM_ROLE_MISSING", "IAM_ROLE_PERMISSIONS", "NO_EC2_SUBSCRIPTION", "OVER_MAX_INSTANCES", "NO_INSTANCES", "TIMEOUT", "HEALTH_CONSTRAINTS_INVALID", "HEALTH_CONSTRAINTS", "INTERNAL_ERROR", "THROTTLED", "ALARM_ACTIVE", "AGENT_ISSUE", "AUTO_SCALING_IAM_ROLE_PERMISSIONS", "AUTO_SCALING_CONFIGURATION", "MANUAL_STOP"
384
- # resp.deployments_info[0].error_information.message #=> String
385
- # resp.deployments_info[0].create_time #=> Time
386
- # resp.deployments_info[0].start_time #=> Time
387
- # resp.deployments_info[0].complete_time #=> Time
388
- # resp.deployments_info[0].deployment_overview.pending #=> Integer
389
- # resp.deployments_info[0].deployment_overview.in_progress #=> Integer
390
- # resp.deployments_info[0].deployment_overview.succeeded #=> Integer
391
- # resp.deployments_info[0].deployment_overview.failed #=> Integer
392
- # resp.deployments_info[0].deployment_overview.skipped #=> Integer
393
- # resp.deployments_info[0].description #=> String
394
- # resp.deployments_info[0].creator #=> String, one of "user", "autoscaling", "codeDeployRollback"
395
- # resp.deployments_info[0].ignore_application_stop_failures #=> Boolean
396
- # resp.deployments_info[0].auto_rollback_configuration.enabled #=> Boolean
397
- # resp.deployments_info[0].auto_rollback_configuration.events #=> Array
398
- # resp.deployments_info[0].auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
399
- # resp.deployments_info[0].update_outdated_instances_only #=> Boolean
400
- # resp.deployments_info[0].rollback_info.rollback_deployment_id #=> String
401
- # resp.deployments_info[0].rollback_info.rollback_triggering_deployment_id #=> String
402
- # resp.deployments_info[0].rollback_info.rollback_message #=> String
403
- # @overload batch_get_deployments(params = {})
404
- # @param [Hash] params ({})
405
- def batch_get_deployments(params = {}, options = {})
406
- req = build_request(:batch_get_deployments, params)
407
- req.send_request(options)
408
- end
352
+ # Gets information about one or more instance that are part of a
353
+ # deployment group.
354
+ #
355
+ # @option params [required, String] :deployment_id
356
+ # The unique ID of a deployment.
357
+ #
358
+ # @option params [required, Array<String>] :instance_ids
359
+ # The unique IDs of instances in the deployment group.
360
+ #
361
+ # @return [Types::BatchGetDeploymentInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
362
+ #
363
+ # * {Types::BatchGetDeploymentInstancesOutput#instances_summary #instances_summary} => Array&lt;Types::InstanceSummary&gt;
364
+ # * {Types::BatchGetDeploymentInstancesOutput#error_message #error_message} => String
365
+ #
366
+ # @example Request syntax with placeholder values
367
+ #
368
+ # resp = client.batch_get_deployment_instances({
369
+ # deployment_id: "DeploymentId", # required
370
+ # instance_ids: ["InstanceId"], # required
371
+ # })
372
+ #
373
+ # @example Response structure
374
+ #
375
+ # resp.instances_summary #=> Array
376
+ # resp.instances_summary[0].deployment_id #=> String
377
+ # resp.instances_summary[0].instance_id #=> String
378
+ # resp.instances_summary[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
379
+ # resp.instances_summary[0].last_updated_at #=> Time
380
+ # resp.instances_summary[0].lifecycle_events #=> Array
381
+ # resp.instances_summary[0].lifecycle_events[0].lifecycle_event_name #=> String
382
+ # resp.instances_summary[0].lifecycle_events[0].diagnostics.error_code #=> String, one of "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError"
383
+ # resp.instances_summary[0].lifecycle_events[0].diagnostics.script_name #=> String
384
+ # resp.instances_summary[0].lifecycle_events[0].diagnostics.message #=> String
385
+ # resp.instances_summary[0].lifecycle_events[0].diagnostics.log_tail #=> String
386
+ # resp.instances_summary[0].lifecycle_events[0].start_time #=> Time
387
+ # resp.instances_summary[0].lifecycle_events[0].end_time #=> Time
388
+ # resp.instances_summary[0].lifecycle_events[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
389
+ # resp.error_message #=> String
390
+ #
391
+ # @overload batch_get_deployment_instances(params = {})
392
+ # @param [Hash] params ({})
393
+ def batch_get_deployment_instances(params = {}, options = {})
394
+ req = build_request(:batch_get_deployment_instances, params)
395
+ req.send_request(options)
396
+ end
409
397
 
410
- # Gets information about one or more on-premises instances.
411
- # @option params [Array<String>] :instance_names
412
- # The names of the on-premises instances about which to get information.
413
- # @return [Types::BatchGetOnPremisesInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
414
- #
415
- # * {Types::BatchGetOnPremisesInstancesOutput#instance_infos #instanceInfos} => Array&lt;Types::InstanceInfo&gt;
416
- #
417
- # @example Request syntax with placeholder values
418
- # resp = client.batch_get_on_premises_instances({
419
- # instance_names: ["InstanceName"],
420
- # })
421
- #
422
- # @example Response structure
423
- # resp.instance_infos #=> Array
424
- # resp.instance_infos[0].instance_name #=> String
425
- # resp.instance_infos[0].iam_user_arn #=> String
426
- # resp.instance_infos[0].instance_arn #=> String
427
- # resp.instance_infos[0].register_time #=> Time
428
- # resp.instance_infos[0].deregister_time #=> Time
429
- # resp.instance_infos[0].tags #=> Array
430
- # resp.instance_infos[0].tags[0].key #=> String
431
- # resp.instance_infos[0].tags[0].value #=> String
432
- # @overload batch_get_on_premises_instances(params = {})
433
- # @param [Hash] params ({})
434
- def batch_get_on_premises_instances(params = {}, options = {})
435
- req = build_request(:batch_get_on_premises_instances, params)
436
- req.send_request(options)
437
- end
398
+ # Gets information about one or more deployments.
399
+ #
400
+ # @option params [Array<String>] :deployment_ids
401
+ # A list of deployment IDs, separated by spaces.
402
+ #
403
+ # @return [Types::BatchGetDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
404
+ #
405
+ # * {Types::BatchGetDeploymentsOutput#deployments_info #deployments_info} => Array&lt;Types::DeploymentInfo&gt;
406
+ #
407
+ # @example Request syntax with placeholder values
408
+ #
409
+ # resp = client.batch_get_deployments({
410
+ # deployment_ids: ["DeploymentId"],
411
+ # })
412
+ #
413
+ # @example Response structure
414
+ #
415
+ # resp.deployments_info #=> Array
416
+ # resp.deployments_info[0].application_name #=> String
417
+ # resp.deployments_info[0].deployment_group_name #=> String
418
+ # resp.deployments_info[0].deployment_config_name #=> String
419
+ # resp.deployments_info[0].deployment_id #=> String
420
+ # resp.deployments_info[0].revision.revision_type #=> String, one of "S3", "GitHub"
421
+ # resp.deployments_info[0].revision.s3_location.bucket #=> String
422
+ # resp.deployments_info[0].revision.s3_location.key #=> String
423
+ # resp.deployments_info[0].revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
424
+ # resp.deployments_info[0].revision.s3_location.version #=> String
425
+ # resp.deployments_info[0].revision.s3_location.e_tag #=> String
426
+ # resp.deployments_info[0].revision.git_hub_location.repository #=> String
427
+ # resp.deployments_info[0].revision.git_hub_location.commit_id #=> String
428
+ # resp.deployments_info[0].status #=> String, one of "Created", "Queued", "InProgress", "Succeeded", "Failed", "Stopped"
429
+ # resp.deployments_info[0].error_information.code #=> String, one of "DEPLOYMENT_GROUP_MISSING", "APPLICATION_MISSING", "REVISION_MISSING", "IAM_ROLE_MISSING", "IAM_ROLE_PERMISSIONS", "NO_EC2_SUBSCRIPTION", "OVER_MAX_INSTANCES", "NO_INSTANCES", "TIMEOUT", "HEALTH_CONSTRAINTS_INVALID", "HEALTH_CONSTRAINTS", "INTERNAL_ERROR", "THROTTLED", "ALARM_ACTIVE", "AGENT_ISSUE", "AUTO_SCALING_IAM_ROLE_PERMISSIONS", "AUTO_SCALING_CONFIGURATION", "MANUAL_STOP"
430
+ # resp.deployments_info[0].error_information.message #=> String
431
+ # resp.deployments_info[0].create_time #=> Time
432
+ # resp.deployments_info[0].start_time #=> Time
433
+ # resp.deployments_info[0].complete_time #=> Time
434
+ # resp.deployments_info[0].deployment_overview.pending #=> Integer
435
+ # resp.deployments_info[0].deployment_overview.in_progress #=> Integer
436
+ # resp.deployments_info[0].deployment_overview.succeeded #=> Integer
437
+ # resp.deployments_info[0].deployment_overview.failed #=> Integer
438
+ # resp.deployments_info[0].deployment_overview.skipped #=> Integer
439
+ # resp.deployments_info[0].description #=> String
440
+ # resp.deployments_info[0].creator #=> String, one of "user", "autoscaling", "codeDeployRollback"
441
+ # resp.deployments_info[0].ignore_application_stop_failures #=> Boolean
442
+ # resp.deployments_info[0].auto_rollback_configuration.enabled #=> Boolean
443
+ # resp.deployments_info[0].auto_rollback_configuration.events #=> Array
444
+ # resp.deployments_info[0].auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
445
+ # resp.deployments_info[0].update_outdated_instances_only #=> Boolean
446
+ # resp.deployments_info[0].rollback_info.rollback_deployment_id #=> String
447
+ # resp.deployments_info[0].rollback_info.rollback_triggering_deployment_id #=> String
448
+ # resp.deployments_info[0].rollback_info.rollback_message #=> String
449
+ #
450
+ # @overload batch_get_deployments(params = {})
451
+ # @param [Hash] params ({})
452
+ def batch_get_deployments(params = {}, options = {})
453
+ req = build_request(:batch_get_deployments, params)
454
+ req.send_request(options)
455
+ end
438
456
 
439
- # Creates an application.
440
- # @option params [required, String] :application_name
441
- # The name of the application. This name must be unique with the
442
- # applicable IAM user or AWS account.
443
- # @return [Types::CreateApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
444
- #
445
- # * {Types::CreateApplicationOutput#application_id #applicationId} => String
446
- #
447
- # @example Request syntax with placeholder values
448
- # resp = client.create_application({
449
- # application_name: "ApplicationName", # required
450
- # })
451
- #
452
- # @example Response structure
453
- # resp.application_id #=> String
454
- # @overload create_application(params = {})
455
- # @param [Hash] params ({})
456
- def create_application(params = {}, options = {})
457
- req = build_request(:create_application, params)
458
- req.send_request(options)
459
- end
457
+ # Gets information about one or more on-premises instances.
458
+ #
459
+ # @option params [Array<String>] :instance_names
460
+ # The names of the on-premises instances about which to get information.
461
+ #
462
+ # @return [Types::BatchGetOnPremisesInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
463
+ #
464
+ # * {Types::BatchGetOnPremisesInstancesOutput#instance_infos #instance_infos} => Array&lt;Types::InstanceInfo&gt;
465
+ #
466
+ # @example Request syntax with placeholder values
467
+ #
468
+ # resp = client.batch_get_on_premises_instances({
469
+ # instance_names: ["InstanceName"],
470
+ # })
471
+ #
472
+ # @example Response structure
473
+ #
474
+ # resp.instance_infos #=> Array
475
+ # resp.instance_infos[0].instance_name #=> String
476
+ # resp.instance_infos[0].iam_session_arn #=> String
477
+ # resp.instance_infos[0].iam_user_arn #=> String
478
+ # resp.instance_infos[0].instance_arn #=> String
479
+ # resp.instance_infos[0].register_time #=> Time
480
+ # resp.instance_infos[0].deregister_time #=> Time
481
+ # resp.instance_infos[0].tags #=> Array
482
+ # resp.instance_infos[0].tags[0].key #=> String
483
+ # resp.instance_infos[0].tags[0].value #=> String
484
+ #
485
+ # @overload batch_get_on_premises_instances(params = {})
486
+ # @param [Hash] params ({})
487
+ def batch_get_on_premises_instances(params = {}, options = {})
488
+ req = build_request(:batch_get_on_premises_instances, params)
489
+ req.send_request(options)
490
+ end
460
491
 
461
- # Deploys an application revision through the specified deployment
462
- # group.
463
- # @option params [required, String] :application_name
464
- # The name of an AWS CodeDeploy application associated with the
465
- # applicable IAM user or AWS account.
466
- # @option params [String] :deployment_group_name
467
- # The name of the deployment group.
468
- # @option params [Types::RevisionLocation] :revision
469
- # The type and location of the revision to deploy.
470
- # @option params [String] :deployment_config_name
471
- # The name of a deployment configuration associated with the applicable
472
- # IAM user or AWS account.
473
- #
474
- # If not specified, the value configured in the deployment group will be
475
- # used as the default. If the deployment group does not have a
476
- # deployment configuration associated with it, then
477
- # CodeDeployDefault.OneAtATime will be used by default.
478
- # @option params [String] :description
479
- # A comment about the deployment.
480
- # @option params [Boolean] :ignore_application_stop_failures
481
- # If set to true, then if the deployment causes the ApplicationStop
482
- # deployment lifecycle event to an instance to fail, the deployment to
483
- # that instance will not be considered to have failed at that point and
484
- # will continue on to the BeforeInstall deployment lifecycle event.
485
- #
486
- # If set to false or not specified, then if the deployment causes the
487
- # ApplicationStop deployment lifecycle event to fail to an instance, the
488
- # deployment to that instance will stop, and the deployment to that
489
- # instance will be considered to have failed.
490
- # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
491
- # Configuration information for an automatic rollback that is added when
492
- # a deployment is created.
493
- # @option params [Boolean] :update_outdated_instances_only
494
- # Indicates whether to deploy to all instances or only to instances that
495
- # are not running the latest application revision.
496
- # @return [Types::CreateDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
497
- #
498
- # * {Types::CreateDeploymentOutput#deployment_id #deploymentId} => String
499
- #
500
- # @example Request syntax with placeholder values
501
- # resp = client.create_deployment({
502
- # application_name: "ApplicationName", # required
503
- # deployment_group_name: "DeploymentGroupName",
504
- # revision: {
505
- # revision_type: "S3", # accepts S3, GitHub
506
- # s3_location: {
507
- # bucket: "S3Bucket",
508
- # key: "S3Key",
509
- # bundle_type: "tar", # accepts tar, tgz, zip
510
- # version: "VersionId",
511
- # e_tag: "ETag",
512
- # },
513
- # git_hub_location: {
514
- # repository: "Repository",
515
- # commit_id: "CommitId",
516
- # },
517
- # },
518
- # deployment_config_name: "DeploymentConfigName",
519
- # description: "Description",
520
- # ignore_application_stop_failures: false,
521
- # auto_rollback_configuration: {
522
- # enabled: false,
523
- # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
524
- # },
525
- # update_outdated_instances_only: false,
526
- # })
527
- #
528
- # @example Response structure
529
- # resp.deployment_id #=> String
530
- # @overload create_deployment(params = {})
531
- # @param [Hash] params ({})
532
- def create_deployment(params = {}, options = {})
533
- req = build_request(:create_deployment, params)
534
- req.send_request(options)
535
- end
492
+ # Creates an application.
493
+ #
494
+ # @option params [required, String] :application_name
495
+ # The name of the application. This name must be unique with the
496
+ # applicable IAM user or AWS account.
497
+ #
498
+ # @return [Types::CreateApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
499
+ #
500
+ # * {Types::CreateApplicationOutput#application_id #application_id} => String
501
+ #
502
+ # @example Request syntax with placeholder values
503
+ #
504
+ # resp = client.create_application({
505
+ # application_name: "ApplicationName", # required
506
+ # })
507
+ #
508
+ # @example Response structure
509
+ #
510
+ # resp.application_id #=> String
511
+ #
512
+ # @overload create_application(params = {})
513
+ # @param [Hash] params ({})
514
+ def create_application(params = {}, options = {})
515
+ req = build_request(:create_application, params)
516
+ req.send_request(options)
517
+ end
536
518
 
537
- # Creates a deployment configuration.
538
- # @option params [required, String] :deployment_config_name
539
- # The name of the deployment configuration to create.
540
- # @option params [Types::MinimumHealthyHosts] :minimum_healthy_hosts
541
- # The minimum number of healthy instances that should be available at
542
- # any time during the deployment. There are two parameters expected in
543
- # the input: type and value.
544
- #
545
- # The type parameter takes either of the following values:
546
- #
547
- # * HOST\_COUNT: The value parameter represents the minimum number of
548
- # healthy instances as an absolute value.
549
- #
550
- # * FLEET\_PERCENT: The value parameter represents the minimum number of
551
- # healthy instances as a percentage of the total number of instances
552
- # in the deployment. If you specify FLEET\_PERCENT, at the start of
553
- # the deployment, AWS CodeDeploy converts the percentage to the
554
- # equivalent number of instance and rounds up fractional instances.
555
- #
556
- # The value parameter takes an integer.
557
- #
558
- # For example, to set a minimum of 95% healthy instance, specify a type
559
- # of FLEET\_PERCENT and a value of 95.
560
- # @return [Types::CreateDeploymentConfigOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
561
- #
562
- # * {Types::CreateDeploymentConfigOutput#deployment_config_id #deploymentConfigId} => String
563
- #
564
- # @example Request syntax with placeholder values
565
- # resp = client.create_deployment_config({
566
- # deployment_config_name: "DeploymentConfigName", # required
567
- # minimum_healthy_hosts: {
568
- # value: 1,
569
- # type: "HOST_COUNT", # accepts HOST_COUNT, FLEET_PERCENT
570
- # },
571
- # })
572
- #
573
- # @example Response structure
574
- # resp.deployment_config_id #=> String
575
- # @overload create_deployment_config(params = {})
576
- # @param [Hash] params ({})
577
- def create_deployment_config(params = {}, options = {})
578
- req = build_request(:create_deployment_config, params)
579
- req.send_request(options)
580
- end
519
+ # Deploys an application revision through the specified deployment
520
+ # group.
521
+ #
522
+ # @option params [required, String] :application_name
523
+ # The name of an AWS CodeDeploy application associated with the
524
+ # applicable IAM user or AWS account.
525
+ #
526
+ # @option params [String] :deployment_group_name
527
+ # The name of the deployment group.
528
+ #
529
+ # @option params [Types::RevisionLocation] :revision
530
+ # The type and location of the revision to deploy.
531
+ #
532
+ # @option params [String] :deployment_config_name
533
+ # The name of a deployment configuration associated with the applicable
534
+ # IAM user or AWS account.
535
+ #
536
+ # If not specified, the value configured in the deployment group will be
537
+ # used as the default. If the deployment group does not have a
538
+ # deployment configuration associated with it, then
539
+ # CodeDeployDefault.OneAtATime will be used by default.
540
+ #
541
+ # @option params [String] :description
542
+ # A comment about the deployment.
543
+ #
544
+ # @option params [Boolean] :ignore_application_stop_failures
545
+ # If set to true, then if the deployment causes the ApplicationStop
546
+ # deployment lifecycle event to an instance to fail, the deployment to
547
+ # that instance will not be considered to have failed at that point and
548
+ # will continue on to the BeforeInstall deployment lifecycle event.
549
+ #
550
+ # If set to false or not specified, then if the deployment causes the
551
+ # ApplicationStop deployment lifecycle event to fail to an instance, the
552
+ # deployment to that instance will stop, and the deployment to that
553
+ # instance will be considered to have failed.
554
+ #
555
+ # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
556
+ # Configuration information for an automatic rollback that is added when
557
+ # a deployment is created.
558
+ #
559
+ # @option params [Boolean] :update_outdated_instances_only
560
+ # Indicates whether to deploy to all instances or only to instances that
561
+ # are not running the latest application revision.
562
+ #
563
+ # @return [Types::CreateDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
564
+ #
565
+ # * {Types::CreateDeploymentOutput#deployment_id #deployment_id} => String
566
+ #
567
+ # @example Request syntax with placeholder values
568
+ #
569
+ # resp = client.create_deployment({
570
+ # application_name: "ApplicationName", # required
571
+ # deployment_group_name: "DeploymentGroupName",
572
+ # revision: {
573
+ # revision_type: "S3", # accepts S3, GitHub
574
+ # s3_location: {
575
+ # bucket: "S3Bucket",
576
+ # key: "S3Key",
577
+ # bundle_type: "tar", # accepts tar, tgz, zip
578
+ # version: "VersionId",
579
+ # e_tag: "ETag",
580
+ # },
581
+ # git_hub_location: {
582
+ # repository: "Repository",
583
+ # commit_id: "CommitId",
584
+ # },
585
+ # },
586
+ # deployment_config_name: "DeploymentConfigName",
587
+ # description: "Description",
588
+ # ignore_application_stop_failures: false,
589
+ # auto_rollback_configuration: {
590
+ # enabled: false,
591
+ # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
592
+ # },
593
+ # update_outdated_instances_only: false,
594
+ # })
595
+ #
596
+ # @example Response structure
597
+ #
598
+ # resp.deployment_id #=> String
599
+ #
600
+ # @overload create_deployment(params = {})
601
+ # @param [Hash] params ({})
602
+ def create_deployment(params = {}, options = {})
603
+ req = build_request(:create_deployment, params)
604
+ req.send_request(options)
605
+ end
581
606
 
582
- # Creates a deployment group to which application revisions will be
583
- # deployed.
584
- # @option params [required, String] :application_name
585
- # The name of an AWS CodeDeploy application associated with the
586
- # applicable IAM user or AWS account.
587
- # @option params [required, String] :deployment_group_name
588
- # The name of a new deployment group for the specified application.
589
- # @option params [String] :deployment_config_name
590
- # If specified, the deployment configuration name can be either one of
591
- # the predefined configurations provided with AWS CodeDeploy or a custom
592
- # deployment configuration that you create by calling the create
593
- # deployment configuration operation.
594
- #
595
- # <note markdown="1"> CodeDeployDefault.OneAtATime is the default deployment configuration.
596
- # It is used if a configuration isn't specified for the deployment or
597
- # the deployment group.
598
- #
599
- # </note>
600
- #
601
- # The predefined deployment configurations include the following:
602
- #
603
- # * **CodeDeployDefault.AllAtOnce** attempts to deploy an application
604
- # revision to as many instances as possible at once. The status of the
605
- # overall deployment will be displayed as **Succeeded** if the
606
- # application revision is deployed to one or more of the instances.
607
- # The status of the overall deployment will be displayed as **Failed**
608
- # if the application revision is not deployed to any of the instances.
609
- # Using an example of nine instances, CodeDeployDefault.AllAtOnce will
610
- # attempt to deploy to all nine instances at once. The overall
611
- # deployment will succeed if deployment to even a single instance is
612
- # successful; it will fail only if deployments to all nine instances
613
- # fail.
614
- #
615
- # * **CodeDeployDefault.HalfAtATime** deploys to up to half of the
616
- # instances at a time (with fractions rounded down). The overall
617
- # deployment succeeds if the application revision is deployed to at
618
- # least half of the instances (with fractions rounded up); otherwise,
619
- # the deployment fails. In the example of nine instances, it will
620
- # deploy to up to four instances at a time. The overall deployment
621
- # succeeds if deployment to five or more instances succeed; otherwise,
622
- # the deployment fails. The deployment may be successfully deployed to
623
- # some instances even if the overall deployment fails.
624
- #
625
- # * **CodeDeployDefault.OneAtATime** deploys the application revision to
626
- # only one instance at a time.
627
- #
628
- # For deployment groups that contain more than one instance:
629
- #
630
- # * The overall deployment succeeds if the application revision is
631
- # deployed to all of the instances. The exception to this rule is if
632
- # deployment to the last instance fails, the overall deployment
633
- # still succeeds. This is because AWS CodeDeploy allows only one
634
- # instance at a time to be taken offline with the
635
- # CodeDeployDefault.OneAtATime configuration.
636
- #
637
- # * The overall deployment fails as soon as the application revision
638
- # fails to be deployed to any but the last instance. The deployment
639
- # may be successfully deployed to some instances even if the overall
640
- # deployment fails.
641
- #
642
- # * In an example using nine instances, it will deploy to one instance
643
- # at a time. The overall deployment succeeds if deployment to the
644
- # first eight instances is successful; the overall deployment fails
645
- # if deployment to any of the first eight instances fails.
646
- #
647
- # For deployment groups that contain only one instance, the overall
648
- # deployment is successful only if deployment to the single instance
649
- # is successful
650
- # @option params [Array<Types::EC2TagFilter>] :ec2_tag_filters
651
- # The Amazon EC2 tags on which to filter.
652
- # @option params [Array<Types::TagFilter>] :on_premises_instance_tag_filters
653
- # The on-premises instance tags on which to filter.
654
- # @option params [Array<String>] :auto_scaling_groups
655
- # A list of associated Auto Scaling groups.
656
- # @option params [required, String] :service_role_arn
657
- # A service role ARN that allows AWS CodeDeploy to act on the user's
658
- # behalf when interacting with AWS services.
659
- # @option params [Array<Types::TriggerConfig>] :trigger_configurations
660
- # Information about triggers to create when the deployment group is
661
- # created. For examples, see [Create a Trigger for an AWS CodeDeploy
662
- # Event][1] in the AWS CodeDeploy User Guide.
663
- #
664
- #
665
- #
666
- # [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html
667
- # @option params [Types::AlarmConfiguration] :alarm_configuration
668
- # Information to add about Amazon CloudWatch alarms when the deployment
669
- # group is created.
670
- # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
671
- # Configuration information for an automatic rollback that is added when
672
- # a deployment group is created.
673
- # @return [Types::CreateDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
674
- #
675
- # * {Types::CreateDeploymentGroupOutput#deployment_group_id #deploymentGroupId} => String
676
- #
677
- # @example Request syntax with placeholder values
678
- # resp = client.create_deployment_group({
679
- # application_name: "ApplicationName", # required
680
- # deployment_group_name: "DeploymentGroupName", # required
681
- # deployment_config_name: "DeploymentConfigName",
682
- # ec2_tag_filters: [
683
- # {
684
- # key: "Key",
685
- # value: "Value",
686
- # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
687
- # },
688
- # ],
689
- # on_premises_instance_tag_filters: [
690
- # {
691
- # key: "Key",
692
- # value: "Value",
693
- # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
694
- # },
695
- # ],
696
- # auto_scaling_groups: ["AutoScalingGroupName"],
697
- # service_role_arn: "Role", # required
698
- # trigger_configurations: [
699
- # {
700
- # trigger_name: "TriggerName",
701
- # trigger_target_arn: "TriggerTargetArn",
702
- # trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, InstanceStart, InstanceSuccess, InstanceFailure
703
- # },
704
- # ],
705
- # alarm_configuration: {
706
- # enabled: false,
707
- # ignore_poll_alarm_failure: false,
708
- # alarms: [
709
- # {
710
- # name: "AlarmName",
711
- # },
712
- # ],
713
- # },
714
- # auto_rollback_configuration: {
715
- # enabled: false,
716
- # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
717
- # },
718
- # })
719
- #
720
- # @example Response structure
721
- # resp.deployment_group_id #=> String
722
- # @overload create_deployment_group(params = {})
723
- # @param [Hash] params ({})
724
- def create_deployment_group(params = {}, options = {})
725
- req = build_request(:create_deployment_group, params)
726
- req.send_request(options)
727
- end
607
+ # Creates a deployment configuration.
608
+ #
609
+ # @option params [required, String] :deployment_config_name
610
+ # The name of the deployment configuration to create.
611
+ #
612
+ # @option params [Types::MinimumHealthyHosts] :minimum_healthy_hosts
613
+ # The minimum number of healthy instances that should be available at
614
+ # any time during the deployment. There are two parameters expected in
615
+ # the input: type and value.
616
+ #
617
+ # The type parameter takes either of the following values:
618
+ #
619
+ # * HOST\_COUNT: The value parameter represents the minimum number of
620
+ # healthy instances as an absolute value.
621
+ #
622
+ # * FLEET\_PERCENT: The value parameter represents the minimum number of
623
+ # healthy instances as a percentage of the total number of instances
624
+ # in the deployment. If you specify FLEET\_PERCENT, at the start of
625
+ # the deployment, AWS CodeDeploy converts the percentage to the
626
+ # equivalent number of instance and rounds up fractional instances.
627
+ #
628
+ # The value parameter takes an integer.
629
+ #
630
+ # For example, to set a minimum of 95% healthy instance, specify a type
631
+ # of FLEET\_PERCENT and a value of 95.
632
+ #
633
+ # @return [Types::CreateDeploymentConfigOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
634
+ #
635
+ # * {Types::CreateDeploymentConfigOutput#deployment_config_id #deployment_config_id} => String
636
+ #
637
+ # @example Request syntax with placeholder values
638
+ #
639
+ # resp = client.create_deployment_config({
640
+ # deployment_config_name: "DeploymentConfigName", # required
641
+ # minimum_healthy_hosts: {
642
+ # value: 1,
643
+ # type: "HOST_COUNT", # accepts HOST_COUNT, FLEET_PERCENT
644
+ # },
645
+ # })
646
+ #
647
+ # @example Response structure
648
+ #
649
+ # resp.deployment_config_id #=> String
650
+ #
651
+ # @overload create_deployment_config(params = {})
652
+ # @param [Hash] params ({})
653
+ def create_deployment_config(params = {}, options = {})
654
+ req = build_request(:create_deployment_config, params)
655
+ req.send_request(options)
656
+ end
728
657
 
729
- # Deletes an application.
730
- # @option params [required, String] :application_name
731
- # The name of an AWS CodeDeploy application associated with the
732
- # applicable IAM user or AWS account.
733
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
734
- #
735
- # @example Request syntax with placeholder values
736
- # resp = client.delete_application({
737
- # application_name: "ApplicationName", # required
738
- # })
739
- # @overload delete_application(params = {})
740
- # @param [Hash] params ({})
741
- def delete_application(params = {}, options = {})
742
- req = build_request(:delete_application, params)
743
- req.send_request(options)
744
- end
658
+ # Creates a deployment group to which application revisions will be
659
+ # deployed.
660
+ #
661
+ # @option params [required, String] :application_name
662
+ # The name of an AWS CodeDeploy application associated with the
663
+ # applicable IAM user or AWS account.
664
+ #
665
+ # @option params [required, String] :deployment_group_name
666
+ # The name of a new deployment group for the specified application.
667
+ #
668
+ # @option params [String] :deployment_config_name
669
+ # If specified, the deployment configuration name can be either one of
670
+ # the predefined configurations provided with AWS CodeDeploy or a custom
671
+ # deployment configuration that you create by calling the create
672
+ # deployment configuration operation.
673
+ #
674
+ # CodeDeployDefault.OneAtATime is the default deployment configuration.
675
+ # It is used if a configuration isn't specified for the deployment or
676
+ # the deployment group.
677
+ #
678
+ # For more information about the predefined deployment configurations in
679
+ # AWS CodeDeploy, see see [Working with Deployment Groups in AWS
680
+ # CodeDeploy][1] in the AWS CodeDeploy User Guide.
681
+ #
682
+ #
683
+ #
684
+ # [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html
685
+ #
686
+ # @option params [Array<Types::EC2TagFilter>] :ec2_tag_filters
687
+ # The Amazon EC2 tags on which to filter.
688
+ #
689
+ # @option params [Array<Types::TagFilter>] :on_premises_instance_tag_filters
690
+ # The on-premises instance tags on which to filter.
691
+ #
692
+ # @option params [Array<String>] :auto_scaling_groups
693
+ # A list of associated Auto Scaling groups.
694
+ #
695
+ # @option params [required, String] :service_role_arn
696
+ # A service role ARN that allows AWS CodeDeploy to act on the user's
697
+ # behalf when interacting with AWS services.
698
+ #
699
+ # @option params [Array<Types::TriggerConfig>] :trigger_configurations
700
+ # Information about triggers to create when the deployment group is
701
+ # created. For examples, see [Create a Trigger for an AWS CodeDeploy
702
+ # Event][1] in the AWS CodeDeploy User Guide.
703
+ #
704
+ #
705
+ #
706
+ # [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html
707
+ #
708
+ # @option params [Types::AlarmConfiguration] :alarm_configuration
709
+ # Information to add about Amazon CloudWatch alarms when the deployment
710
+ # group is created.
711
+ #
712
+ # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
713
+ # Configuration information for an automatic rollback that is added when
714
+ # a deployment group is created.
715
+ #
716
+ # @return [Types::CreateDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
717
+ #
718
+ # * {Types::CreateDeploymentGroupOutput#deployment_group_id #deployment_group_id} => String
719
+ #
720
+ # @example Request syntax with placeholder values
721
+ #
722
+ # resp = client.create_deployment_group({
723
+ # application_name: "ApplicationName", # required
724
+ # deployment_group_name: "DeploymentGroupName", # required
725
+ # deployment_config_name: "DeploymentConfigName",
726
+ # ec2_tag_filters: [
727
+ # {
728
+ # key: "Key",
729
+ # value: "Value",
730
+ # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
731
+ # },
732
+ # ],
733
+ # on_premises_instance_tag_filters: [
734
+ # {
735
+ # key: "Key",
736
+ # value: "Value",
737
+ # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
738
+ # },
739
+ # ],
740
+ # auto_scaling_groups: ["AutoScalingGroupName"],
741
+ # service_role_arn: "Role", # required
742
+ # trigger_configurations: [
743
+ # {
744
+ # trigger_name: "TriggerName",
745
+ # trigger_target_arn: "TriggerTargetArn",
746
+ # trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, InstanceStart, InstanceSuccess, InstanceFailure
747
+ # },
748
+ # ],
749
+ # alarm_configuration: {
750
+ # enabled: false,
751
+ # ignore_poll_alarm_failure: false,
752
+ # alarms: [
753
+ # {
754
+ # name: "AlarmName",
755
+ # },
756
+ # ],
757
+ # },
758
+ # auto_rollback_configuration: {
759
+ # enabled: false,
760
+ # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
761
+ # },
762
+ # })
763
+ #
764
+ # @example Response structure
765
+ #
766
+ # resp.deployment_group_id #=> String
767
+ #
768
+ # @overload create_deployment_group(params = {})
769
+ # @param [Hash] params ({})
770
+ def create_deployment_group(params = {}, options = {})
771
+ req = build_request(:create_deployment_group, params)
772
+ req.send_request(options)
773
+ end
745
774
 
746
- # Deletes a deployment configuration.
747
- #
748
- # <note markdown="1"> A deployment configuration cannot be deleted if it is currently in
749
- # use. Predefined configurations cannot be deleted.
750
- #
751
- # </note>
752
- # @option params [required, String] :deployment_config_name
753
- # The name of a deployment configuration associated with the applicable
754
- # IAM user or AWS account.
755
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
756
- #
757
- # @example Request syntax with placeholder values
758
- # resp = client.delete_deployment_config({
759
- # deployment_config_name: "DeploymentConfigName", # required
760
- # })
761
- # @overload delete_deployment_config(params = {})
762
- # @param [Hash] params ({})
763
- def delete_deployment_config(params = {}, options = {})
764
- req = build_request(:delete_deployment_config, params)
765
- req.send_request(options)
766
- end
775
+ # Deletes an application.
776
+ #
777
+ # @option params [required, String] :application_name
778
+ # The name of an AWS CodeDeploy application associated with the
779
+ # applicable IAM user or AWS account.
780
+ #
781
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
782
+ #
783
+ # @example Request syntax with placeholder values
784
+ #
785
+ # resp = client.delete_application({
786
+ # application_name: "ApplicationName", # required
787
+ # })
788
+ #
789
+ # @overload delete_application(params = {})
790
+ # @param [Hash] params ({})
791
+ def delete_application(params = {}, options = {})
792
+ req = build_request(:delete_application, params)
793
+ req.send_request(options)
794
+ end
767
795
 
768
- # Deletes a deployment group.
769
- # @option params [required, String] :application_name
770
- # The name of an AWS CodeDeploy application associated with the
771
- # applicable IAM user or AWS account.
772
- # @option params [required, String] :deployment_group_name
773
- # The name of an existing deployment group for the specified
774
- # application.
775
- # @return [Types::DeleteDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
776
- #
777
- # * {Types::DeleteDeploymentGroupOutput#hooks_not_cleaned_up #hooksNotCleanedUp} => Array&lt;Types::AutoScalingGroup&gt;
778
- #
779
- # @example Request syntax with placeholder values
780
- # resp = client.delete_deployment_group({
781
- # application_name: "ApplicationName", # required
782
- # deployment_group_name: "DeploymentGroupName", # required
783
- # })
784
- #
785
- # @example Response structure
786
- # resp.hooks_not_cleaned_up #=> Array
787
- # resp.hooks_not_cleaned_up[0].name #=> String
788
- # resp.hooks_not_cleaned_up[0].hook #=> String
789
- # @overload delete_deployment_group(params = {})
790
- # @param [Hash] params ({})
791
- def delete_deployment_group(params = {}, options = {})
792
- req = build_request(:delete_deployment_group, params)
793
- req.send_request(options)
794
- end
796
+ # Deletes a deployment configuration.
797
+ #
798
+ # <note markdown="1"> A deployment configuration cannot be deleted if it is currently in
799
+ # use. Predefined configurations cannot be deleted.
800
+ #
801
+ # </note>
802
+ #
803
+ # @option params [required, String] :deployment_config_name
804
+ # The name of a deployment configuration associated with the applicable
805
+ # IAM user or AWS account.
806
+ #
807
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
808
+ #
809
+ # @example Request syntax with placeholder values
810
+ #
811
+ # resp = client.delete_deployment_config({
812
+ # deployment_config_name: "DeploymentConfigName", # required
813
+ # })
814
+ #
815
+ # @overload delete_deployment_config(params = {})
816
+ # @param [Hash] params ({})
817
+ def delete_deployment_config(params = {}, options = {})
818
+ req = build_request(:delete_deployment_config, params)
819
+ req.send_request(options)
820
+ end
795
821
 
796
- # Deregisters an on-premises instance.
797
- # @option params [required, String] :instance_name
798
- # The name of the on-premises instance to deregister.
799
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
800
- #
801
- # @example Request syntax with placeholder values
802
- # resp = client.deregister_on_premises_instance({
803
- # instance_name: "InstanceName", # required
804
- # })
805
- # @overload deregister_on_premises_instance(params = {})
806
- # @param [Hash] params ({})
807
- def deregister_on_premises_instance(params = {}, options = {})
808
- req = build_request(:deregister_on_premises_instance, params)
809
- req.send_request(options)
810
- end
822
+ # Deletes a deployment group.
823
+ #
824
+ # @option params [required, String] :application_name
825
+ # The name of an AWS CodeDeploy application associated with the
826
+ # applicable IAM user or AWS account.
827
+ #
828
+ # @option params [required, String] :deployment_group_name
829
+ # The name of an existing deployment group for the specified
830
+ # application.
831
+ #
832
+ # @return [Types::DeleteDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
833
+ #
834
+ # * {Types::DeleteDeploymentGroupOutput#hooks_not_cleaned_up #hooks_not_cleaned_up} => Array&lt;Types::AutoScalingGroup&gt;
835
+ #
836
+ # @example Request syntax with placeholder values
837
+ #
838
+ # resp = client.delete_deployment_group({
839
+ # application_name: "ApplicationName", # required
840
+ # deployment_group_name: "DeploymentGroupName", # required
841
+ # })
842
+ #
843
+ # @example Response structure
844
+ #
845
+ # resp.hooks_not_cleaned_up #=> Array
846
+ # resp.hooks_not_cleaned_up[0].name #=> String
847
+ # resp.hooks_not_cleaned_up[0].hook #=> String
848
+ #
849
+ # @overload delete_deployment_group(params = {})
850
+ # @param [Hash] params ({})
851
+ def delete_deployment_group(params = {}, options = {})
852
+ req = build_request(:delete_deployment_group, params)
853
+ req.send_request(options)
854
+ end
811
855
 
812
- # Gets information about an application.
813
- # @option params [required, String] :application_name
814
- # The name of an AWS CodeDeploy application associated with the
815
- # applicable IAM user or AWS account.
816
- # @return [Types::GetApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
817
- #
818
- # * {Types::GetApplicationOutput#application #application} => Types::ApplicationInfo
819
- #
820
- # @example Request syntax with placeholder values
821
- # resp = client.get_application({
822
- # application_name: "ApplicationName", # required
823
- # })
824
- #
825
- # @example Response structure
826
- # resp.application.application_id #=> String
827
- # resp.application.application_name #=> String
828
- # resp.application.create_time #=> Time
829
- # resp.application.linked_to_git_hub #=> Boolean
830
- # @overload get_application(params = {})
831
- # @param [Hash] params ({})
832
- def get_application(params = {}, options = {})
833
- req = build_request(:get_application, params)
834
- req.send_request(options)
835
- end
856
+ # Deregisters an on-premises instance.
857
+ #
858
+ # @option params [required, String] :instance_name
859
+ # The name of the on-premises instance to deregister.
860
+ #
861
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
862
+ #
863
+ # @example Request syntax with placeholder values
864
+ #
865
+ # resp = client.deregister_on_premises_instance({
866
+ # instance_name: "InstanceName", # required
867
+ # })
868
+ #
869
+ # @overload deregister_on_premises_instance(params = {})
870
+ # @param [Hash] params ({})
871
+ def deregister_on_premises_instance(params = {}, options = {})
872
+ req = build_request(:deregister_on_premises_instance, params)
873
+ req.send_request(options)
874
+ end
836
875
 
837
- # Gets information about an application revision.
838
- # @option params [required, String] :application_name
839
- # The name of the application that corresponds to the revision.
840
- # @option params [required, Types::RevisionLocation] :revision
841
- # Information about the application revision to get, including type and
842
- # location.
843
- # @return [Types::GetApplicationRevisionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
844
- #
845
- # * {Types::GetApplicationRevisionOutput#application_name #applicationName} => String
846
- # * {Types::GetApplicationRevisionOutput#revision #revision} => Types::RevisionLocation
847
- # * {Types::GetApplicationRevisionOutput#revision_info #revisionInfo} => Types::GenericRevisionInfo
848
- #
849
- # @example Request syntax with placeholder values
850
- # resp = client.get_application_revision({
851
- # application_name: "ApplicationName", # required
852
- # revision: { # required
853
- # revision_type: "S3", # accepts S3, GitHub
854
- # s3_location: {
855
- # bucket: "S3Bucket",
856
- # key: "S3Key",
857
- # bundle_type: "tar", # accepts tar, tgz, zip
858
- # version: "VersionId",
859
- # e_tag: "ETag",
860
- # },
861
- # git_hub_location: {
862
- # repository: "Repository",
863
- # commit_id: "CommitId",
864
- # },
865
- # },
866
- # })
867
- #
868
- # @example Response structure
869
- # resp.application_name #=> String
870
- # resp.revision.revision_type #=> String, one of "S3", "GitHub"
871
- # resp.revision.s3_location.bucket #=> String
872
- # resp.revision.s3_location.key #=> String
873
- # resp.revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
874
- # resp.revision.s3_location.version #=> String
875
- # resp.revision.s3_location.e_tag #=> String
876
- # resp.revision.git_hub_location.repository #=> String
877
- # resp.revision.git_hub_location.commit_id #=> String
878
- # resp.revision_info.description #=> String
879
- # resp.revision_info.deployment_groups #=> Array
880
- # resp.revision_info.deployment_groups[0] #=> String
881
- # resp.revision_info.first_used_time #=> Time
882
- # resp.revision_info.last_used_time #=> Time
883
- # resp.revision_info.register_time #=> Time
884
- # @overload get_application_revision(params = {})
885
- # @param [Hash] params ({})
886
- def get_application_revision(params = {}, options = {})
887
- req = build_request(:get_application_revision, params)
888
- req.send_request(options)
889
- end
876
+ # Gets information about an application.
877
+ #
878
+ # @option params [required, String] :application_name
879
+ # The name of an AWS CodeDeploy application associated with the
880
+ # applicable IAM user or AWS account.
881
+ #
882
+ # @return [Types::GetApplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
883
+ #
884
+ # * {Types::GetApplicationOutput#application #application} => Types::ApplicationInfo
885
+ #
886
+ # @example Request syntax with placeholder values
887
+ #
888
+ # resp = client.get_application({
889
+ # application_name: "ApplicationName", # required
890
+ # })
891
+ #
892
+ # @example Response structure
893
+ #
894
+ # resp.application.application_id #=> String
895
+ # resp.application.application_name #=> String
896
+ # resp.application.create_time #=> Time
897
+ # resp.application.linked_to_git_hub #=> Boolean
898
+ #
899
+ # @overload get_application(params = {})
900
+ # @param [Hash] params ({})
901
+ def get_application(params = {}, options = {})
902
+ req = build_request(:get_application, params)
903
+ req.send_request(options)
904
+ end
890
905
 
891
- # Gets information about a deployment.
892
- # @option params [required, String] :deployment_id
893
- # A deployment ID associated with the applicable IAM user or AWS
894
- # account.
895
- # @return [Types::GetDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
896
- #
897
- # * {Types::GetDeploymentOutput#deployment_info #deploymentInfo} => Types::DeploymentInfo
898
- #
899
- # @example Request syntax with placeholder values
900
- # resp = client.get_deployment({
901
- # deployment_id: "DeploymentId", # required
902
- # })
903
- #
904
- # @example Response structure
905
- # resp.deployment_info.application_name #=> String
906
- # resp.deployment_info.deployment_group_name #=> String
907
- # resp.deployment_info.deployment_config_name #=> String
908
- # resp.deployment_info.deployment_id #=> String
909
- # resp.deployment_info.revision.revision_type #=> String, one of "S3", "GitHub"
910
- # resp.deployment_info.revision.s3_location.bucket #=> String
911
- # resp.deployment_info.revision.s3_location.key #=> String
912
- # resp.deployment_info.revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
913
- # resp.deployment_info.revision.s3_location.version #=> String
914
- # resp.deployment_info.revision.s3_location.e_tag #=> String
915
- # resp.deployment_info.revision.git_hub_location.repository #=> String
916
- # resp.deployment_info.revision.git_hub_location.commit_id #=> String
917
- # resp.deployment_info.status #=> String, one of "Created", "Queued", "InProgress", "Succeeded", "Failed", "Stopped"
918
- # resp.deployment_info.error_information.code #=> String, one of "DEPLOYMENT_GROUP_MISSING", "APPLICATION_MISSING", "REVISION_MISSING", "IAM_ROLE_MISSING", "IAM_ROLE_PERMISSIONS", "NO_EC2_SUBSCRIPTION", "OVER_MAX_INSTANCES", "NO_INSTANCES", "TIMEOUT", "HEALTH_CONSTRAINTS_INVALID", "HEALTH_CONSTRAINTS", "INTERNAL_ERROR", "THROTTLED", "ALARM_ACTIVE", "AGENT_ISSUE", "AUTO_SCALING_IAM_ROLE_PERMISSIONS", "AUTO_SCALING_CONFIGURATION", "MANUAL_STOP"
919
- # resp.deployment_info.error_information.message #=> String
920
- # resp.deployment_info.create_time #=> Time
921
- # resp.deployment_info.start_time #=> Time
922
- # resp.deployment_info.complete_time #=> Time
923
- # resp.deployment_info.deployment_overview.pending #=> Integer
924
- # resp.deployment_info.deployment_overview.in_progress #=> Integer
925
- # resp.deployment_info.deployment_overview.succeeded #=> Integer
926
- # resp.deployment_info.deployment_overview.failed #=> Integer
927
- # resp.deployment_info.deployment_overview.skipped #=> Integer
928
- # resp.deployment_info.description #=> String
929
- # resp.deployment_info.creator #=> String, one of "user", "autoscaling", "codeDeployRollback"
930
- # resp.deployment_info.ignore_application_stop_failures #=> Boolean
931
- # resp.deployment_info.auto_rollback_configuration.enabled #=> Boolean
932
- # resp.deployment_info.auto_rollback_configuration.events #=> Array
933
- # resp.deployment_info.auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
934
- # resp.deployment_info.update_outdated_instances_only #=> Boolean
935
- # resp.deployment_info.rollback_info.rollback_deployment_id #=> String
936
- # resp.deployment_info.rollback_info.rollback_triggering_deployment_id #=> String
937
- # resp.deployment_info.rollback_info.rollback_message #=> String
938
- # @overload get_deployment(params = {})
939
- # @param [Hash] params ({})
940
- def get_deployment(params = {}, options = {})
941
- req = build_request(:get_deployment, params)
942
- req.send_request(options)
943
- end
906
+ # Gets information about an application revision.
907
+ #
908
+ # @option params [required, String] :application_name
909
+ # The name of the application that corresponds to the revision.
910
+ #
911
+ # @option params [required, Types::RevisionLocation] :revision
912
+ # Information about the application revision to get, including type and
913
+ # location.
914
+ #
915
+ # @return [Types::GetApplicationRevisionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
916
+ #
917
+ # * {Types::GetApplicationRevisionOutput#application_name #application_name} => String
918
+ # * {Types::GetApplicationRevisionOutput#revision #revision} => Types::RevisionLocation
919
+ # * {Types::GetApplicationRevisionOutput#revision_info #revision_info} => Types::GenericRevisionInfo
920
+ #
921
+ # @example Request syntax with placeholder values
922
+ #
923
+ # resp = client.get_application_revision({
924
+ # application_name: "ApplicationName", # required
925
+ # revision: { # required
926
+ # revision_type: "S3", # accepts S3, GitHub
927
+ # s3_location: {
928
+ # bucket: "S3Bucket",
929
+ # key: "S3Key",
930
+ # bundle_type: "tar", # accepts tar, tgz, zip
931
+ # version: "VersionId",
932
+ # e_tag: "ETag",
933
+ # },
934
+ # git_hub_location: {
935
+ # repository: "Repository",
936
+ # commit_id: "CommitId",
937
+ # },
938
+ # },
939
+ # })
940
+ #
941
+ # @example Response structure
942
+ #
943
+ # resp.application_name #=> String
944
+ # resp.revision.revision_type #=> String, one of "S3", "GitHub"
945
+ # resp.revision.s3_location.bucket #=> String
946
+ # resp.revision.s3_location.key #=> String
947
+ # resp.revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
948
+ # resp.revision.s3_location.version #=> String
949
+ # resp.revision.s3_location.e_tag #=> String
950
+ # resp.revision.git_hub_location.repository #=> String
951
+ # resp.revision.git_hub_location.commit_id #=> String
952
+ # resp.revision_info.description #=> String
953
+ # resp.revision_info.deployment_groups #=> Array
954
+ # resp.revision_info.deployment_groups[0] #=> String
955
+ # resp.revision_info.first_used_time #=> Time
956
+ # resp.revision_info.last_used_time #=> Time
957
+ # resp.revision_info.register_time #=> Time
958
+ #
959
+ # @overload get_application_revision(params = {})
960
+ # @param [Hash] params ({})
961
+ def get_application_revision(params = {}, options = {})
962
+ req = build_request(:get_application_revision, params)
963
+ req.send_request(options)
964
+ end
944
965
 
945
- # Gets information about a deployment configuration.
946
- # @option params [required, String] :deployment_config_name
947
- # The name of a deployment configuration associated with the applicable
948
- # IAM user or AWS account.
949
- # @return [Types::GetDeploymentConfigOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
950
- #
951
- # * {Types::GetDeploymentConfigOutput#deployment_config_info #deploymentConfigInfo} => Types::DeploymentConfigInfo
952
- #
953
- # @example Request syntax with placeholder values
954
- # resp = client.get_deployment_config({
955
- # deployment_config_name: "DeploymentConfigName", # required
956
- # })
957
- #
958
- # @example Response structure
959
- # resp.deployment_config_info.deployment_config_id #=> String
960
- # resp.deployment_config_info.deployment_config_name #=> String
961
- # resp.deployment_config_info.minimum_healthy_hosts.value #=> Integer
962
- # resp.deployment_config_info.minimum_healthy_hosts.type #=> String, one of "HOST_COUNT", "FLEET_PERCENT"
963
- # resp.deployment_config_info.create_time #=> Time
964
- # @overload get_deployment_config(params = {})
965
- # @param [Hash] params ({})
966
- def get_deployment_config(params = {}, options = {})
967
- req = build_request(:get_deployment_config, params)
968
- req.send_request(options)
969
- end
966
+ # Gets information about a deployment.
967
+ #
968
+ # @option params [required, String] :deployment_id
969
+ # A deployment ID associated with the applicable IAM user or AWS
970
+ # account.
971
+ #
972
+ # @return [Types::GetDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
973
+ #
974
+ # * {Types::GetDeploymentOutput#deployment_info #deployment_info} => Types::DeploymentInfo
975
+ #
976
+ # @example Request syntax with placeholder values
977
+ #
978
+ # resp = client.get_deployment({
979
+ # deployment_id: "DeploymentId", # required
980
+ # })
981
+ #
982
+ # @example Response structure
983
+ #
984
+ # resp.deployment_info.application_name #=> String
985
+ # resp.deployment_info.deployment_group_name #=> String
986
+ # resp.deployment_info.deployment_config_name #=> String
987
+ # resp.deployment_info.deployment_id #=> String
988
+ # resp.deployment_info.revision.revision_type #=> String, one of "S3", "GitHub"
989
+ # resp.deployment_info.revision.s3_location.bucket #=> String
990
+ # resp.deployment_info.revision.s3_location.key #=> String
991
+ # resp.deployment_info.revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
992
+ # resp.deployment_info.revision.s3_location.version #=> String
993
+ # resp.deployment_info.revision.s3_location.e_tag #=> String
994
+ # resp.deployment_info.revision.git_hub_location.repository #=> String
995
+ # resp.deployment_info.revision.git_hub_location.commit_id #=> String
996
+ # resp.deployment_info.status #=> String, one of "Created", "Queued", "InProgress", "Succeeded", "Failed", "Stopped"
997
+ # resp.deployment_info.error_information.code #=> String, one of "DEPLOYMENT_GROUP_MISSING", "APPLICATION_MISSING", "REVISION_MISSING", "IAM_ROLE_MISSING", "IAM_ROLE_PERMISSIONS", "NO_EC2_SUBSCRIPTION", "OVER_MAX_INSTANCES", "NO_INSTANCES", "TIMEOUT", "HEALTH_CONSTRAINTS_INVALID", "HEALTH_CONSTRAINTS", "INTERNAL_ERROR", "THROTTLED", "ALARM_ACTIVE", "AGENT_ISSUE", "AUTO_SCALING_IAM_ROLE_PERMISSIONS", "AUTO_SCALING_CONFIGURATION", "MANUAL_STOP"
998
+ # resp.deployment_info.error_information.message #=> String
999
+ # resp.deployment_info.create_time #=> Time
1000
+ # resp.deployment_info.start_time #=> Time
1001
+ # resp.deployment_info.complete_time #=> Time
1002
+ # resp.deployment_info.deployment_overview.pending #=> Integer
1003
+ # resp.deployment_info.deployment_overview.in_progress #=> Integer
1004
+ # resp.deployment_info.deployment_overview.succeeded #=> Integer
1005
+ # resp.deployment_info.deployment_overview.failed #=> Integer
1006
+ # resp.deployment_info.deployment_overview.skipped #=> Integer
1007
+ # resp.deployment_info.description #=> String
1008
+ # resp.deployment_info.creator #=> String, one of "user", "autoscaling", "codeDeployRollback"
1009
+ # resp.deployment_info.ignore_application_stop_failures #=> Boolean
1010
+ # resp.deployment_info.auto_rollback_configuration.enabled #=> Boolean
1011
+ # resp.deployment_info.auto_rollback_configuration.events #=> Array
1012
+ # resp.deployment_info.auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
1013
+ # resp.deployment_info.update_outdated_instances_only #=> Boolean
1014
+ # resp.deployment_info.rollback_info.rollback_deployment_id #=> String
1015
+ # resp.deployment_info.rollback_info.rollback_triggering_deployment_id #=> String
1016
+ # resp.deployment_info.rollback_info.rollback_message #=> String
1017
+ #
1018
+ # @overload get_deployment(params = {})
1019
+ # @param [Hash] params ({})
1020
+ def get_deployment(params = {}, options = {})
1021
+ req = build_request(:get_deployment, params)
1022
+ req.send_request(options)
1023
+ end
970
1024
 
971
- # Gets information about a deployment group.
972
- # @option params [required, String] :application_name
973
- # The name of an AWS CodeDeploy application associated with the
974
- # applicable IAM user or AWS account.
975
- # @option params [required, String] :deployment_group_name
976
- # The name of an existing deployment group for the specified
977
- # application.
978
- # @return [Types::GetDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
979
- #
980
- # * {Types::GetDeploymentGroupOutput#deployment_group_info #deploymentGroupInfo} => Types::DeploymentGroupInfo
981
- #
982
- # @example Request syntax with placeholder values
983
- # resp = client.get_deployment_group({
984
- # application_name: "ApplicationName", # required
985
- # deployment_group_name: "DeploymentGroupName", # required
986
- # })
987
- #
988
- # @example Response structure
989
- # resp.deployment_group_info.application_name #=> String
990
- # resp.deployment_group_info.deployment_group_id #=> String
991
- # resp.deployment_group_info.deployment_group_name #=> String
992
- # resp.deployment_group_info.deployment_config_name #=> String
993
- # resp.deployment_group_info.ec2_tag_filters #=> Array
994
- # resp.deployment_group_info.ec2_tag_filters[0].key #=> String
995
- # resp.deployment_group_info.ec2_tag_filters[0].value #=> String
996
- # resp.deployment_group_info.ec2_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
997
- # resp.deployment_group_info.on_premises_instance_tag_filters #=> Array
998
- # resp.deployment_group_info.on_premises_instance_tag_filters[0].key #=> String
999
- # resp.deployment_group_info.on_premises_instance_tag_filters[0].value #=> String
1000
- # resp.deployment_group_info.on_premises_instance_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
1001
- # resp.deployment_group_info.auto_scaling_groups #=> Array
1002
- # resp.deployment_group_info.auto_scaling_groups[0].name #=> String
1003
- # resp.deployment_group_info.auto_scaling_groups[0].hook #=> String
1004
- # resp.deployment_group_info.service_role_arn #=> String
1005
- # resp.deployment_group_info.target_revision.revision_type #=> String, one of "S3", "GitHub"
1006
- # resp.deployment_group_info.target_revision.s3_location.bucket #=> String
1007
- # resp.deployment_group_info.target_revision.s3_location.key #=> String
1008
- # resp.deployment_group_info.target_revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
1009
- # resp.deployment_group_info.target_revision.s3_location.version #=> String
1010
- # resp.deployment_group_info.target_revision.s3_location.e_tag #=> String
1011
- # resp.deployment_group_info.target_revision.git_hub_location.repository #=> String
1012
- # resp.deployment_group_info.target_revision.git_hub_location.commit_id #=> String
1013
- # resp.deployment_group_info.trigger_configurations #=> Array
1014
- # resp.deployment_group_info.trigger_configurations[0].trigger_name #=> String
1015
- # resp.deployment_group_info.trigger_configurations[0].trigger_target_arn #=> String
1016
- # resp.deployment_group_info.trigger_configurations[0].trigger_events #=> Array
1017
- # resp.deployment_group_info.trigger_configurations[0].trigger_events[0] #=> String, one of "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "InstanceStart", "InstanceSuccess", "InstanceFailure"
1018
- # resp.deployment_group_info.alarm_configuration.enabled #=> Boolean
1019
- # resp.deployment_group_info.alarm_configuration.ignore_poll_alarm_failure #=> Boolean
1020
- # resp.deployment_group_info.alarm_configuration.alarms #=> Array
1021
- # resp.deployment_group_info.alarm_configuration.alarms[0].name #=> String
1022
- # resp.deployment_group_info.auto_rollback_configuration.enabled #=> Boolean
1023
- # resp.deployment_group_info.auto_rollback_configuration.events #=> Array
1024
- # resp.deployment_group_info.auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
1025
- # @overload get_deployment_group(params = {})
1026
- # @param [Hash] params ({})
1027
- def get_deployment_group(params = {}, options = {})
1028
- req = build_request(:get_deployment_group, params)
1029
- req.send_request(options)
1030
- end
1025
+ # Gets information about a deployment configuration.
1026
+ #
1027
+ # @option params [required, String] :deployment_config_name
1028
+ # The name of a deployment configuration associated with the applicable
1029
+ # IAM user or AWS account.
1030
+ #
1031
+ # @return [Types::GetDeploymentConfigOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1032
+ #
1033
+ # * {Types::GetDeploymentConfigOutput#deployment_config_info #deployment_config_info} => Types::DeploymentConfigInfo
1034
+ #
1035
+ # @example Request syntax with placeholder values
1036
+ #
1037
+ # resp = client.get_deployment_config({
1038
+ # deployment_config_name: "DeploymentConfigName", # required
1039
+ # })
1040
+ #
1041
+ # @example Response structure
1042
+ #
1043
+ # resp.deployment_config_info.deployment_config_id #=> String
1044
+ # resp.deployment_config_info.deployment_config_name #=> String
1045
+ # resp.deployment_config_info.minimum_healthy_hosts.value #=> Integer
1046
+ # resp.deployment_config_info.minimum_healthy_hosts.type #=> String, one of "HOST_COUNT", "FLEET_PERCENT"
1047
+ # resp.deployment_config_info.create_time #=> Time
1048
+ #
1049
+ # @overload get_deployment_config(params = {})
1050
+ # @param [Hash] params ({})
1051
+ def get_deployment_config(params = {}, options = {})
1052
+ req = build_request(:get_deployment_config, params)
1053
+ req.send_request(options)
1054
+ end
1031
1055
 
1032
- # Gets information about an instance as part of a deployment.
1033
- # @option params [required, String] :deployment_id
1034
- # The unique ID of a deployment.
1035
- # @option params [required, String] :instance_id
1036
- # The unique ID of an instance in the deployment group.
1037
- # @return [Types::GetDeploymentInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1038
- #
1039
- # * {Types::GetDeploymentInstanceOutput#instance_summary #instanceSummary} => Types::InstanceSummary
1040
- #
1041
- # @example Request syntax with placeholder values
1042
- # resp = client.get_deployment_instance({
1043
- # deployment_id: "DeploymentId", # required
1044
- # instance_id: "InstanceId", # required
1045
- # })
1046
- #
1047
- # @example Response structure
1048
- # resp.instance_summary.deployment_id #=> String
1049
- # resp.instance_summary.instance_id #=> String
1050
- # resp.instance_summary.status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
1051
- # resp.instance_summary.last_updated_at #=> Time
1052
- # resp.instance_summary.lifecycle_events #=> Array
1053
- # resp.instance_summary.lifecycle_events[0].lifecycle_event_name #=> String
1054
- # resp.instance_summary.lifecycle_events[0].diagnostics.error_code #=> String, one of "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError"
1055
- # resp.instance_summary.lifecycle_events[0].diagnostics.script_name #=> String
1056
- # resp.instance_summary.lifecycle_events[0].diagnostics.message #=> String
1057
- # resp.instance_summary.lifecycle_events[0].diagnostics.log_tail #=> String
1058
- # resp.instance_summary.lifecycle_events[0].start_time #=> Time
1059
- # resp.instance_summary.lifecycle_events[0].end_time #=> Time
1060
- # resp.instance_summary.lifecycle_events[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
1061
- # @overload get_deployment_instance(params = {})
1062
- # @param [Hash] params ({})
1063
- def get_deployment_instance(params = {}, options = {})
1064
- req = build_request(:get_deployment_instance, params)
1065
- req.send_request(options)
1066
- end
1056
+ # Gets information about a deployment group.
1057
+ #
1058
+ # @option params [required, String] :application_name
1059
+ # The name of an AWS CodeDeploy application associated with the
1060
+ # applicable IAM user or AWS account.
1061
+ #
1062
+ # @option params [required, String] :deployment_group_name
1063
+ # The name of an existing deployment group for the specified
1064
+ # application.
1065
+ #
1066
+ # @return [Types::GetDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1067
+ #
1068
+ # * {Types::GetDeploymentGroupOutput#deployment_group_info #deployment_group_info} => Types::DeploymentGroupInfo
1069
+ #
1070
+ # @example Request syntax with placeholder values
1071
+ #
1072
+ # resp = client.get_deployment_group({
1073
+ # application_name: "ApplicationName", # required
1074
+ # deployment_group_name: "DeploymentGroupName", # required
1075
+ # })
1076
+ #
1077
+ # @example Response structure
1078
+ #
1079
+ # resp.deployment_group_info.application_name #=> String
1080
+ # resp.deployment_group_info.deployment_group_id #=> String
1081
+ # resp.deployment_group_info.deployment_group_name #=> String
1082
+ # resp.deployment_group_info.deployment_config_name #=> String
1083
+ # resp.deployment_group_info.ec2_tag_filters #=> Array
1084
+ # resp.deployment_group_info.ec2_tag_filters[0].key #=> String
1085
+ # resp.deployment_group_info.ec2_tag_filters[0].value #=> String
1086
+ # resp.deployment_group_info.ec2_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
1087
+ # resp.deployment_group_info.on_premises_instance_tag_filters #=> Array
1088
+ # resp.deployment_group_info.on_premises_instance_tag_filters[0].key #=> String
1089
+ # resp.deployment_group_info.on_premises_instance_tag_filters[0].value #=> String
1090
+ # resp.deployment_group_info.on_premises_instance_tag_filters[0].type #=> String, one of "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE"
1091
+ # resp.deployment_group_info.auto_scaling_groups #=> Array
1092
+ # resp.deployment_group_info.auto_scaling_groups[0].name #=> String
1093
+ # resp.deployment_group_info.auto_scaling_groups[0].hook #=> String
1094
+ # resp.deployment_group_info.service_role_arn #=> String
1095
+ # resp.deployment_group_info.target_revision.revision_type #=> String, one of "S3", "GitHub"
1096
+ # resp.deployment_group_info.target_revision.s3_location.bucket #=> String
1097
+ # resp.deployment_group_info.target_revision.s3_location.key #=> String
1098
+ # resp.deployment_group_info.target_revision.s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
1099
+ # resp.deployment_group_info.target_revision.s3_location.version #=> String
1100
+ # resp.deployment_group_info.target_revision.s3_location.e_tag #=> String
1101
+ # resp.deployment_group_info.target_revision.git_hub_location.repository #=> String
1102
+ # resp.deployment_group_info.target_revision.git_hub_location.commit_id #=> String
1103
+ # resp.deployment_group_info.trigger_configurations #=> Array
1104
+ # resp.deployment_group_info.trigger_configurations[0].trigger_name #=> String
1105
+ # resp.deployment_group_info.trigger_configurations[0].trigger_target_arn #=> String
1106
+ # resp.deployment_group_info.trigger_configurations[0].trigger_events #=> Array
1107
+ # resp.deployment_group_info.trigger_configurations[0].trigger_events[0] #=> String, one of "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "InstanceStart", "InstanceSuccess", "InstanceFailure"
1108
+ # resp.deployment_group_info.alarm_configuration.enabled #=> Boolean
1109
+ # resp.deployment_group_info.alarm_configuration.ignore_poll_alarm_failure #=> Boolean
1110
+ # resp.deployment_group_info.alarm_configuration.alarms #=> Array
1111
+ # resp.deployment_group_info.alarm_configuration.alarms[0].name #=> String
1112
+ # resp.deployment_group_info.auto_rollback_configuration.enabled #=> Boolean
1113
+ # resp.deployment_group_info.auto_rollback_configuration.events #=> Array
1114
+ # resp.deployment_group_info.auto_rollback_configuration.events[0] #=> String, one of "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST"
1115
+ #
1116
+ # @overload get_deployment_group(params = {})
1117
+ # @param [Hash] params ({})
1118
+ def get_deployment_group(params = {}, options = {})
1119
+ req = build_request(:get_deployment_group, params)
1120
+ req.send_request(options)
1121
+ end
1067
1122
 
1068
- # Gets information about an on-premises instance.
1069
- # @option params [required, String] :instance_name
1070
- # The name of the on-premises instance about which to get information.
1071
- # @return [Types::GetOnPremisesInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1072
- #
1073
- # * {Types::GetOnPremisesInstanceOutput#instance_info #instanceInfo} => Types::InstanceInfo
1074
- #
1075
- # @example Request syntax with placeholder values
1076
- # resp = client.get_on_premises_instance({
1077
- # instance_name: "InstanceName", # required
1078
- # })
1079
- #
1080
- # @example Response structure
1081
- # resp.instance_info.instance_name #=> String
1082
- # resp.instance_info.iam_user_arn #=> String
1083
- # resp.instance_info.instance_arn #=> String
1084
- # resp.instance_info.register_time #=> Time
1085
- # resp.instance_info.deregister_time #=> Time
1086
- # resp.instance_info.tags #=> Array
1087
- # resp.instance_info.tags[0].key #=> String
1088
- # resp.instance_info.tags[0].value #=> String
1089
- # @overload get_on_premises_instance(params = {})
1090
- # @param [Hash] params ({})
1091
- def get_on_premises_instance(params = {}, options = {})
1092
- req = build_request(:get_on_premises_instance, params)
1093
- req.send_request(options)
1094
- end
1123
+ # Gets information about an instance as part of a deployment.
1124
+ #
1125
+ # @option params [required, String] :deployment_id
1126
+ # The unique ID of a deployment.
1127
+ #
1128
+ # @option params [required, String] :instance_id
1129
+ # The unique ID of an instance in the deployment group.
1130
+ #
1131
+ # @return [Types::GetDeploymentInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1132
+ #
1133
+ # * {Types::GetDeploymentInstanceOutput#instance_summary #instance_summary} => Types::InstanceSummary
1134
+ #
1135
+ # @example Request syntax with placeholder values
1136
+ #
1137
+ # resp = client.get_deployment_instance({
1138
+ # deployment_id: "DeploymentId", # required
1139
+ # instance_id: "InstanceId", # required
1140
+ # })
1141
+ #
1142
+ # @example Response structure
1143
+ #
1144
+ # resp.instance_summary.deployment_id #=> String
1145
+ # resp.instance_summary.instance_id #=> String
1146
+ # resp.instance_summary.status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
1147
+ # resp.instance_summary.last_updated_at #=> Time
1148
+ # resp.instance_summary.lifecycle_events #=> Array
1149
+ # resp.instance_summary.lifecycle_events[0].lifecycle_event_name #=> String
1150
+ # resp.instance_summary.lifecycle_events[0].diagnostics.error_code #=> String, one of "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError"
1151
+ # resp.instance_summary.lifecycle_events[0].diagnostics.script_name #=> String
1152
+ # resp.instance_summary.lifecycle_events[0].diagnostics.message #=> String
1153
+ # resp.instance_summary.lifecycle_events[0].diagnostics.log_tail #=> String
1154
+ # resp.instance_summary.lifecycle_events[0].start_time #=> Time
1155
+ # resp.instance_summary.lifecycle_events[0].end_time #=> Time
1156
+ # resp.instance_summary.lifecycle_events[0].status #=> String, one of "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown"
1157
+ #
1158
+ # @overload get_deployment_instance(params = {})
1159
+ # @param [Hash] params ({})
1160
+ def get_deployment_instance(params = {}, options = {})
1161
+ req = build_request(:get_deployment_instance, params)
1162
+ req.send_request(options)
1163
+ end
1095
1164
 
1096
- # Lists information about revisions for an application.
1097
- # @option params [required, String] :application_name
1098
- # The name of an AWS CodeDeploy application associated with the
1099
- # applicable IAM user or AWS account.
1100
- # @option params [String] :sort_by
1101
- # The column name to use to sort the list results:
1102
- #
1103
- # * registerTime: Sort by the time the revisions were registered with
1104
- # AWS CodeDeploy.
1105
- #
1106
- # * firstUsedTime: Sort by the time the revisions were first used in a
1107
- # deployment.
1108
- #
1109
- # * lastUsedTime: Sort by the time the revisions were last used in a
1110
- # deployment.
1111
- #
1112
- # If not specified or set to null, the results will be returned in an
1113
- # arbitrary order.
1114
- # @option params [String] :sort_order
1115
- # The order in which to sort the list results:
1116
- #
1117
- # * ascending: ascending order.
1118
- #
1119
- # * descending: descending order.
1120
- #
1121
- # If not specified, the results will be sorted in ascending order.
1122
- #
1123
- # If set to null, the results will be sorted in an arbitrary order.
1124
- # @option params [String] :s3_bucket
1125
- # An Amazon S3 bucket name to limit the search for revisions.
1126
- #
1127
- # If set to null, all of the user's buckets will be searched.
1128
- # @option params [String] :s3_key_prefix
1129
- # A key prefix for the set of Amazon S3 objects to limit the search for
1130
- # revisions.
1131
- # @option params [String] :deployed
1132
- # Whether to list revisions based on whether the revision is the target
1133
- # revision of an deployment group:
1134
- #
1135
- # * include: List revisions that are target revisions of a deployment
1136
- # group.
1137
- #
1138
- # * exclude: Do not list revisions that are target revisions of a
1139
- # deployment group.
1140
- #
1141
- # * ignore: List all revisions.
1142
- # @option params [String] :next_token
1143
- # An identifier returned from the previous list application revisions
1144
- # call. It can be used to return the next set of applications in the
1145
- # list.
1146
- # @return [Types::ListApplicationRevisionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1147
- #
1148
- # * {Types::ListApplicationRevisionsOutput#revisions #revisions} => Array&lt;Types::RevisionLocation&gt;
1149
- # * {Types::ListApplicationRevisionsOutput#next_token #nextToken} => String
1150
- #
1151
- # @example Request syntax with placeholder values
1152
- # resp = client.list_application_revisions({
1153
- # application_name: "ApplicationName", # required
1154
- # sort_by: "registerTime", # accepts registerTime, firstUsedTime, lastUsedTime
1155
- # sort_order: "ascending", # accepts ascending, descending
1156
- # s3_bucket: "S3Bucket",
1157
- # s3_key_prefix: "S3Key",
1158
- # deployed: "include", # accepts include, exclude, ignore
1159
- # next_token: "NextToken",
1160
- # })
1161
- #
1162
- # @example Response structure
1163
- # resp.revisions #=> Array
1164
- # resp.revisions[0].revision_type #=> String, one of "S3", "GitHub"
1165
- # resp.revisions[0].s3_location.bucket #=> String
1166
- # resp.revisions[0].s3_location.key #=> String
1167
- # resp.revisions[0].s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
1168
- # resp.revisions[0].s3_location.version #=> String
1169
- # resp.revisions[0].s3_location.e_tag #=> String
1170
- # resp.revisions[0].git_hub_location.repository #=> String
1171
- # resp.revisions[0].git_hub_location.commit_id #=> String
1172
- # resp.next_token #=> String
1173
- # @overload list_application_revisions(params = {})
1174
- # @param [Hash] params ({})
1175
- def list_application_revisions(params = {}, options = {})
1176
- req = build_request(:list_application_revisions, params)
1177
- req.send_request(options)
1178
- end
1165
+ # Gets information about an on-premises instance.
1166
+ #
1167
+ # @option params [required, String] :instance_name
1168
+ # The name of the on-premises instance about which to get information.
1169
+ #
1170
+ # @return [Types::GetOnPremisesInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1171
+ #
1172
+ # * {Types::GetOnPremisesInstanceOutput#instance_info #instance_info} => Types::InstanceInfo
1173
+ #
1174
+ # @example Request syntax with placeholder values
1175
+ #
1176
+ # resp = client.get_on_premises_instance({
1177
+ # instance_name: "InstanceName", # required
1178
+ # })
1179
+ #
1180
+ # @example Response structure
1181
+ #
1182
+ # resp.instance_info.instance_name #=> String
1183
+ # resp.instance_info.iam_session_arn #=> String
1184
+ # resp.instance_info.iam_user_arn #=> String
1185
+ # resp.instance_info.instance_arn #=> String
1186
+ # resp.instance_info.register_time #=> Time
1187
+ # resp.instance_info.deregister_time #=> Time
1188
+ # resp.instance_info.tags #=> Array
1189
+ # resp.instance_info.tags[0].key #=> String
1190
+ # resp.instance_info.tags[0].value #=> String
1191
+ #
1192
+ # @overload get_on_premises_instance(params = {})
1193
+ # @param [Hash] params ({})
1194
+ def get_on_premises_instance(params = {}, options = {})
1195
+ req = build_request(:get_on_premises_instance, params)
1196
+ req.send_request(options)
1197
+ end
1179
1198
 
1180
- # Lists the applications registered with the applicable IAM user or AWS
1181
- # account.
1182
- # @option params [String] :next_token
1183
- # An identifier returned from the previous list applications call. It
1184
- # can be used to return the next set of applications in the list.
1185
- # @return [Types::ListApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1186
- #
1187
- # * {Types::ListApplicationsOutput#applications #applications} => Array&lt;String&gt;
1188
- # * {Types::ListApplicationsOutput#next_token #nextToken} => String
1189
- #
1190
- # @example Request syntax with placeholder values
1191
- # resp = client.list_applications({
1192
- # next_token: "NextToken",
1193
- # })
1194
- #
1195
- # @example Response structure
1196
- # resp.applications #=> Array
1197
- # resp.applications[0] #=> String
1198
- # resp.next_token #=> String
1199
- # @overload list_applications(params = {})
1200
- # @param [Hash] params ({})
1201
- def list_applications(params = {}, options = {})
1202
- req = build_request(:list_applications, params)
1203
- req.send_request(options)
1204
- end
1199
+ # Lists information about revisions for an application.
1200
+ #
1201
+ # @option params [required, String] :application_name
1202
+ # The name of an AWS CodeDeploy application associated with the
1203
+ # applicable IAM user or AWS account.
1204
+ #
1205
+ # @option params [String] :sort_by
1206
+ # The column name to use to sort the list results:
1207
+ #
1208
+ # * registerTime: Sort by the time the revisions were registered with
1209
+ # AWS CodeDeploy.
1210
+ #
1211
+ # * firstUsedTime: Sort by the time the revisions were first used in a
1212
+ # deployment.
1213
+ #
1214
+ # * lastUsedTime: Sort by the time the revisions were last used in a
1215
+ # deployment.
1216
+ #
1217
+ # If not specified or set to null, the results will be returned in an
1218
+ # arbitrary order.
1219
+ #
1220
+ # @option params [String] :sort_order
1221
+ # The order in which to sort the list results:
1222
+ #
1223
+ # * ascending: ascending order.
1224
+ #
1225
+ # * descending: descending order.
1226
+ #
1227
+ # If not specified, the results will be sorted in ascending order.
1228
+ #
1229
+ # If set to null, the results will be sorted in an arbitrary order.
1230
+ #
1231
+ # @option params [String] :s3_bucket
1232
+ # An Amazon S3 bucket name to limit the search for revisions.
1233
+ #
1234
+ # If set to null, all of the user's buckets will be searched.
1235
+ #
1236
+ # @option params [String] :s3_key_prefix
1237
+ # A key prefix for the set of Amazon S3 objects to limit the search for
1238
+ # revisions.
1239
+ #
1240
+ # @option params [String] :deployed
1241
+ # Whether to list revisions based on whether the revision is the target
1242
+ # revision of an deployment group:
1243
+ #
1244
+ # * include: List revisions that are target revisions of a deployment
1245
+ # group.
1246
+ #
1247
+ # * exclude: Do not list revisions that are target revisions of a
1248
+ # deployment group.
1249
+ #
1250
+ # * ignore: List all revisions.
1251
+ #
1252
+ # @option params [String] :next_token
1253
+ # An identifier returned from the previous list application revisions
1254
+ # call. It can be used to return the next set of applications in the
1255
+ # list.
1256
+ #
1257
+ # @return [Types::ListApplicationRevisionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1258
+ #
1259
+ # * {Types::ListApplicationRevisionsOutput#revisions #revisions} => Array&lt;Types::RevisionLocation&gt;
1260
+ # * {Types::ListApplicationRevisionsOutput#next_token #next_token} => String
1261
+ #
1262
+ # @example Request syntax with placeholder values
1263
+ #
1264
+ # resp = client.list_application_revisions({
1265
+ # application_name: "ApplicationName", # required
1266
+ # sort_by: "registerTime", # accepts registerTime, firstUsedTime, lastUsedTime
1267
+ # sort_order: "ascending", # accepts ascending, descending
1268
+ # s3_bucket: "S3Bucket",
1269
+ # s3_key_prefix: "S3Key",
1270
+ # deployed: "include", # accepts include, exclude, ignore
1271
+ # next_token: "NextToken",
1272
+ # })
1273
+ #
1274
+ # @example Response structure
1275
+ #
1276
+ # resp.revisions #=> Array
1277
+ # resp.revisions[0].revision_type #=> String, one of "S3", "GitHub"
1278
+ # resp.revisions[0].s3_location.bucket #=> String
1279
+ # resp.revisions[0].s3_location.key #=> String
1280
+ # resp.revisions[0].s3_location.bundle_type #=> String, one of "tar", "tgz", "zip"
1281
+ # resp.revisions[0].s3_location.version #=> String
1282
+ # resp.revisions[0].s3_location.e_tag #=> String
1283
+ # resp.revisions[0].git_hub_location.repository #=> String
1284
+ # resp.revisions[0].git_hub_location.commit_id #=> String
1285
+ # resp.next_token #=> String
1286
+ #
1287
+ # @overload list_application_revisions(params = {})
1288
+ # @param [Hash] params ({})
1289
+ def list_application_revisions(params = {}, options = {})
1290
+ req = build_request(:list_application_revisions, params)
1291
+ req.send_request(options)
1292
+ end
1205
1293
 
1206
- # Lists the deployment configurations with the applicable IAM user or
1207
- # AWS account.
1208
- # @option params [String] :next_token
1209
- # An identifier returned from the previous list deployment
1210
- # configurations call. It can be used to return the next set of
1211
- # deployment configurations in the list.
1212
- # @return [Types::ListDeploymentConfigsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1213
- #
1214
- # * {Types::ListDeploymentConfigsOutput#deployment_configs_list #deploymentConfigsList} => Array&lt;String&gt;
1215
- # * {Types::ListDeploymentConfigsOutput#next_token #nextToken} => String
1216
- #
1217
- # @example Request syntax with placeholder values
1218
- # resp = client.list_deployment_configs({
1219
- # next_token: "NextToken",
1220
- # })
1221
- #
1222
- # @example Response structure
1223
- # resp.deployment_configs_list #=> Array
1224
- # resp.deployment_configs_list[0] #=> String
1225
- # resp.next_token #=> String
1226
- # @overload list_deployment_configs(params = {})
1227
- # @param [Hash] params ({})
1228
- def list_deployment_configs(params = {}, options = {})
1229
- req = build_request(:list_deployment_configs, params)
1230
- req.send_request(options)
1231
- end
1294
+ # Lists the applications registered with the applicable IAM user or AWS
1295
+ # account.
1296
+ #
1297
+ # @option params [String] :next_token
1298
+ # An identifier returned from the previous list applications call. It
1299
+ # can be used to return the next set of applications in the list.
1300
+ #
1301
+ # @return [Types::ListApplicationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1302
+ #
1303
+ # * {Types::ListApplicationsOutput#applications #applications} => Array&lt;String&gt;
1304
+ # * {Types::ListApplicationsOutput#next_token #next_token} => String
1305
+ #
1306
+ # @example Request syntax with placeholder values
1307
+ #
1308
+ # resp = client.list_applications({
1309
+ # next_token: "NextToken",
1310
+ # })
1311
+ #
1312
+ # @example Response structure
1313
+ #
1314
+ # resp.applications #=> Array
1315
+ # resp.applications[0] #=> String
1316
+ # resp.next_token #=> String
1317
+ #
1318
+ # @overload list_applications(params = {})
1319
+ # @param [Hash] params ({})
1320
+ def list_applications(params = {}, options = {})
1321
+ req = build_request(:list_applications, params)
1322
+ req.send_request(options)
1323
+ end
1232
1324
 
1233
- # Lists the deployment groups for an application registered with the
1234
- # applicable IAM user or AWS account.
1235
- # @option params [required, String] :application_name
1236
- # The name of an AWS CodeDeploy application associated with the
1237
- # applicable IAM user or AWS account.
1238
- # @option params [String] :next_token
1239
- # An identifier returned from the previous list deployment groups call.
1240
- # It can be used to return the next set of deployment groups in the
1241
- # list.
1242
- # @return [Types::ListDeploymentGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1243
- #
1244
- # * {Types::ListDeploymentGroupsOutput#application_name #applicationName} => String
1245
- # * {Types::ListDeploymentGroupsOutput#deployment_groups #deploymentGroups} => Array&lt;String&gt;
1246
- # * {Types::ListDeploymentGroupsOutput#next_token #nextToken} => String
1247
- #
1248
- # @example Request syntax with placeholder values
1249
- # resp = client.list_deployment_groups({
1250
- # application_name: "ApplicationName", # required
1251
- # next_token: "NextToken",
1252
- # })
1253
- #
1254
- # @example Response structure
1255
- # resp.application_name #=> String
1256
- # resp.deployment_groups #=> Array
1257
- # resp.deployment_groups[0] #=> String
1258
- # resp.next_token #=> String
1259
- # @overload list_deployment_groups(params = {})
1260
- # @param [Hash] params ({})
1261
- def list_deployment_groups(params = {}, options = {})
1262
- req = build_request(:list_deployment_groups, params)
1263
- req.send_request(options)
1264
- end
1325
+ # Lists the deployment configurations with the applicable IAM user or
1326
+ # AWS account.
1327
+ #
1328
+ # @option params [String] :next_token
1329
+ # An identifier returned from the previous list deployment
1330
+ # configurations call. It can be used to return the next set of
1331
+ # deployment configurations in the list.
1332
+ #
1333
+ # @return [Types::ListDeploymentConfigsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1334
+ #
1335
+ # * {Types::ListDeploymentConfigsOutput#deployment_configs_list #deployment_configs_list} => Array&lt;String&gt;
1336
+ # * {Types::ListDeploymentConfigsOutput#next_token #next_token} => String
1337
+ #
1338
+ # @example Request syntax with placeholder values
1339
+ #
1340
+ # resp = client.list_deployment_configs({
1341
+ # next_token: "NextToken",
1342
+ # })
1343
+ #
1344
+ # @example Response structure
1345
+ #
1346
+ # resp.deployment_configs_list #=> Array
1347
+ # resp.deployment_configs_list[0] #=> String
1348
+ # resp.next_token #=> String
1349
+ #
1350
+ # @overload list_deployment_configs(params = {})
1351
+ # @param [Hash] params ({})
1352
+ def list_deployment_configs(params = {}, options = {})
1353
+ req = build_request(:list_deployment_configs, params)
1354
+ req.send_request(options)
1355
+ end
1265
1356
 
1266
- # Lists the instance for a deployment associated with the applicable IAM
1267
- # user or AWS account.
1268
- # @option params [required, String] :deployment_id
1269
- # The unique ID of a deployment.
1270
- # @option params [String] :next_token
1271
- # An identifier returned from the previous list deployment instances
1272
- # call. It can be used to return the next set of deployment instances in
1273
- # the list.
1274
- # @option params [Array<String>] :instance_status_filter
1275
- # A subset of instances to list by status:
1276
- #
1277
- # * Pending: Include those instance with pending deployments.
1278
- #
1279
- # * InProgress: Include those instance where deployments are still in
1280
- # progress.
1281
- #
1282
- # * Succeeded: Include those instances with successful deployments.
1283
- #
1284
- # * Failed: Include those instance with failed deployments.
1285
- #
1286
- # * Skipped: Include those instance with skipped deployments.
1287
- #
1288
- # * Unknown: Include those instance with deployments in an unknown
1289
- # state.
1290
- # @return [Types::ListDeploymentInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1291
- #
1292
- # * {Types::ListDeploymentInstancesOutput#instances_list #instancesList} => Array&lt;String&gt;
1293
- # * {Types::ListDeploymentInstancesOutput#next_token #nextToken} => String
1294
- #
1295
- # @example Request syntax with placeholder values
1296
- # resp = client.list_deployment_instances({
1297
- # deployment_id: "DeploymentId", # required
1298
- # next_token: "NextToken",
1299
- # instance_status_filter: ["Pending"], # accepts Pending, InProgress, Succeeded, Failed, Skipped, Unknown
1300
- # })
1301
- #
1302
- # @example Response structure
1303
- # resp.instances_list #=> Array
1304
- # resp.instances_list[0] #=> String
1305
- # resp.next_token #=> String
1306
- # @overload list_deployment_instances(params = {})
1307
- # @param [Hash] params ({})
1308
- def list_deployment_instances(params = {}, options = {})
1309
- req = build_request(:list_deployment_instances, params)
1310
- req.send_request(options)
1311
- end
1357
+ # Lists the deployment groups for an application registered with the
1358
+ # applicable IAM user or AWS account.
1359
+ #
1360
+ # @option params [required, String] :application_name
1361
+ # The name of an AWS CodeDeploy application associated with the
1362
+ # applicable IAM user or AWS account.
1363
+ #
1364
+ # @option params [String] :next_token
1365
+ # An identifier returned from the previous list deployment groups call.
1366
+ # It can be used to return the next set of deployment groups in the
1367
+ # list.
1368
+ #
1369
+ # @return [Types::ListDeploymentGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1370
+ #
1371
+ # * {Types::ListDeploymentGroupsOutput#application_name #application_name} => String
1372
+ # * {Types::ListDeploymentGroupsOutput#deployment_groups #deployment_groups} => Array&lt;String&gt;
1373
+ # * {Types::ListDeploymentGroupsOutput#next_token #next_token} => String
1374
+ #
1375
+ # @example Request syntax with placeholder values
1376
+ #
1377
+ # resp = client.list_deployment_groups({
1378
+ # application_name: "ApplicationName", # required
1379
+ # next_token: "NextToken",
1380
+ # })
1381
+ #
1382
+ # @example Response structure
1383
+ #
1384
+ # resp.application_name #=> String
1385
+ # resp.deployment_groups #=> Array
1386
+ # resp.deployment_groups[0] #=> String
1387
+ # resp.next_token #=> String
1388
+ #
1389
+ # @overload list_deployment_groups(params = {})
1390
+ # @param [Hash] params ({})
1391
+ def list_deployment_groups(params = {}, options = {})
1392
+ req = build_request(:list_deployment_groups, params)
1393
+ req.send_request(options)
1394
+ end
1312
1395
 
1313
- # Lists the deployments in a deployment group for an application
1314
- # registered with the applicable IAM user or AWS account.
1315
- # @option params [String] :application_name
1316
- # The name of an AWS CodeDeploy application associated with the
1317
- # applicable IAM user or AWS account.
1318
- # @option params [String] :deployment_group_name
1319
- # The name of an existing deployment group for the specified
1320
- # application.
1321
- # @option params [Array<String>] :include_only_statuses
1322
- # A subset of deployments to list by status:
1323
- #
1324
- # * Created: Include created deployments in the resulting list.
1325
- #
1326
- # * Queued: Include queued deployments in the resulting list.
1327
- #
1328
- # * In Progress: Include in-progress deployments in the resulting list.
1329
- #
1330
- # * Succeeded: Include successful deployments in the resulting list.
1331
- #
1332
- # * Failed: Include failed deployments in the resulting list.
1333
- #
1334
- # * Stopped: Include stopped deployments in the resulting list.
1335
- # @option params [Types::TimeRange] :create_time_range
1336
- # A time range (start and end) for returning a subset of the list of
1337
- # deployments.
1338
- # @option params [String] :next_token
1339
- # An identifier returned from the previous list deployments call. It can
1340
- # be used to return the next set of deployments in the list.
1341
- # @return [Types::ListDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1342
- #
1343
- # * {Types::ListDeploymentsOutput#deployments #deployments} => Array&lt;String&gt;
1344
- # * {Types::ListDeploymentsOutput#next_token #nextToken} => String
1345
- #
1346
- # @example Request syntax with placeholder values
1347
- # resp = client.list_deployments({
1348
- # application_name: "ApplicationName",
1349
- # deployment_group_name: "DeploymentGroupName",
1350
- # include_only_statuses: ["Created"], # accepts Created, Queued, InProgress, Succeeded, Failed, Stopped
1351
- # create_time_range: {
1352
- # start: Time.now,
1353
- # end: Time.now,
1354
- # },
1355
- # next_token: "NextToken",
1356
- # })
1357
- #
1358
- # @example Response structure
1359
- # resp.deployments #=> Array
1360
- # resp.deployments[0] #=> String
1361
- # resp.next_token #=> String
1362
- # @overload list_deployments(params = {})
1363
- # @param [Hash] params ({})
1364
- def list_deployments(params = {}, options = {})
1365
- req = build_request(:list_deployments, params)
1366
- req.send_request(options)
1367
- end
1396
+ # Lists the instance for a deployment associated with the applicable IAM
1397
+ # user or AWS account.
1398
+ #
1399
+ # @option params [required, String] :deployment_id
1400
+ # The unique ID of a deployment.
1401
+ #
1402
+ # @option params [String] :next_token
1403
+ # An identifier returned from the previous list deployment instances
1404
+ # call. It can be used to return the next set of deployment instances in
1405
+ # the list.
1406
+ #
1407
+ # @option params [Array<String>] :instance_status_filter
1408
+ # A subset of instances to list by status:
1409
+ #
1410
+ # * Pending: Include those instance with pending deployments.
1411
+ #
1412
+ # * InProgress: Include those instance where deployments are still in
1413
+ # progress.
1414
+ #
1415
+ # * Succeeded: Include those instances with successful deployments.
1416
+ #
1417
+ # * Failed: Include those instance with failed deployments.
1418
+ #
1419
+ # * Skipped: Include those instance with skipped deployments.
1420
+ #
1421
+ # * Unknown: Include those instance with deployments in an unknown
1422
+ # state.
1423
+ #
1424
+ # @return [Types::ListDeploymentInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1425
+ #
1426
+ # * {Types::ListDeploymentInstancesOutput#instances_list #instances_list} => Array&lt;String&gt;
1427
+ # * {Types::ListDeploymentInstancesOutput#next_token #next_token} => String
1428
+ #
1429
+ # @example Request syntax with placeholder values
1430
+ #
1431
+ # resp = client.list_deployment_instances({
1432
+ # deployment_id: "DeploymentId", # required
1433
+ # next_token: "NextToken",
1434
+ # instance_status_filter: ["Pending"], # accepts Pending, InProgress, Succeeded, Failed, Skipped, Unknown
1435
+ # })
1436
+ #
1437
+ # @example Response structure
1438
+ #
1439
+ # resp.instances_list #=> Array
1440
+ # resp.instances_list[0] #=> String
1441
+ # resp.next_token #=> String
1442
+ #
1443
+ # @overload list_deployment_instances(params = {})
1444
+ # @param [Hash] params ({})
1445
+ def list_deployment_instances(params = {}, options = {})
1446
+ req = build_request(:list_deployment_instances, params)
1447
+ req.send_request(options)
1448
+ end
1368
1449
 
1369
- # Gets a list of names for one or more on-premises instances.
1370
- #
1371
- # Unless otherwise specified, both registered and deregistered
1372
- # on-premises instance names will be listed. To list only registered or
1373
- # deregistered on-premises instance names, use the registration status
1374
- # parameter.
1375
- # @option params [String] :registration_status
1376
- # The registration status of the on-premises instances:
1377
- #
1378
- # * Deregistered: Include deregistered on-premises instances in the
1379
- # resulting list.
1380
- #
1381
- # * Registered: Include registered on-premises instances in the
1382
- # resulting list.
1383
- # @option params [Array<Types::TagFilter>] :tag_filters
1384
- # The on-premises instance tags that will be used to restrict the
1385
- # corresponding on-premises instance names returned.
1386
- # @option params [String] :next_token
1387
- # An identifier returned from the previous list on-premises instances
1388
- # call. It can be used to return the next set of on-premises instances
1389
- # in the list.
1390
- # @return [Types::ListOnPremisesInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1391
- #
1392
- # * {Types::ListOnPremisesInstancesOutput#instance_names #instanceNames} => Array&lt;String&gt;
1393
- # * {Types::ListOnPremisesInstancesOutput#next_token #nextToken} => String
1394
- #
1395
- # @example Request syntax with placeholder values
1396
- # resp = client.list_on_premises_instances({
1397
- # registration_status: "Registered", # accepts Registered, Deregistered
1398
- # tag_filters: [
1399
- # {
1400
- # key: "Key",
1401
- # value: "Value",
1402
- # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1403
- # },
1404
- # ],
1405
- # next_token: "NextToken",
1406
- # })
1407
- #
1408
- # @example Response structure
1409
- # resp.instance_names #=> Array
1410
- # resp.instance_names[0] #=> String
1411
- # resp.next_token #=> String
1412
- # @overload list_on_premises_instances(params = {})
1413
- # @param [Hash] params ({})
1414
- def list_on_premises_instances(params = {}, options = {})
1415
- req = build_request(:list_on_premises_instances, params)
1416
- req.send_request(options)
1417
- end
1450
+ # Lists the deployments in a deployment group for an application
1451
+ # registered with the applicable IAM user or AWS account.
1452
+ #
1453
+ # @option params [String] :application_name
1454
+ # The name of an AWS CodeDeploy application associated with the
1455
+ # applicable IAM user or AWS account.
1456
+ #
1457
+ # @option params [String] :deployment_group_name
1458
+ # The name of an existing deployment group for the specified
1459
+ # application.
1460
+ #
1461
+ # @option params [Array<String>] :include_only_statuses
1462
+ # A subset of deployments to list by status:
1463
+ #
1464
+ # * Created: Include created deployments in the resulting list.
1465
+ #
1466
+ # * Queued: Include queued deployments in the resulting list.
1467
+ #
1468
+ # * In Progress: Include in-progress deployments in the resulting list.
1469
+ #
1470
+ # * Succeeded: Include successful deployments in the resulting list.
1471
+ #
1472
+ # * Failed: Include failed deployments in the resulting list.
1473
+ #
1474
+ # * Stopped: Include stopped deployments in the resulting list.
1475
+ #
1476
+ # @option params [Types::TimeRange] :create_time_range
1477
+ # A time range (start and end) for returning a subset of the list of
1478
+ # deployments.
1479
+ #
1480
+ # @option params [String] :next_token
1481
+ # An identifier returned from the previous list deployments call. It can
1482
+ # be used to return the next set of deployments in the list.
1483
+ #
1484
+ # @return [Types::ListDeploymentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1485
+ #
1486
+ # * {Types::ListDeploymentsOutput#deployments #deployments} => Array&lt;String&gt;
1487
+ # * {Types::ListDeploymentsOutput#next_token #next_token} => String
1488
+ #
1489
+ # @example Request syntax with placeholder values
1490
+ #
1491
+ # resp = client.list_deployments({
1492
+ # application_name: "ApplicationName",
1493
+ # deployment_group_name: "DeploymentGroupName",
1494
+ # include_only_statuses: ["Created"], # accepts Created, Queued, InProgress, Succeeded, Failed, Stopped
1495
+ # create_time_range: {
1496
+ # start: Time.now,
1497
+ # end: Time.now,
1498
+ # },
1499
+ # next_token: "NextToken",
1500
+ # })
1501
+ #
1502
+ # @example Response structure
1503
+ #
1504
+ # resp.deployments #=> Array
1505
+ # resp.deployments[0] #=> String
1506
+ # resp.next_token #=> String
1507
+ #
1508
+ # @overload list_deployments(params = {})
1509
+ # @param [Hash] params ({})
1510
+ def list_deployments(params = {}, options = {})
1511
+ req = build_request(:list_deployments, params)
1512
+ req.send_request(options)
1513
+ end
1418
1514
 
1419
- # Registers with AWS CodeDeploy a revision for the specified
1420
- # application.
1421
- # @option params [required, String] :application_name
1422
- # The name of an AWS CodeDeploy application associated with the
1423
- # applicable IAM user or AWS account.
1424
- # @option params [String] :description
1425
- # A comment about the revision.
1426
- # @option params [required, Types::RevisionLocation] :revision
1427
- # Information about the application revision to register, including type
1428
- # and location.
1429
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1430
- #
1431
- # @example Request syntax with placeholder values
1432
- # resp = client.register_application_revision({
1433
- # application_name: "ApplicationName", # required
1434
- # description: "Description",
1435
- # revision: { # required
1436
- # revision_type: "S3", # accepts S3, GitHub
1437
- # s3_location: {
1438
- # bucket: "S3Bucket",
1439
- # key: "S3Key",
1440
- # bundle_type: "tar", # accepts tar, tgz, zip
1441
- # version: "VersionId",
1442
- # e_tag: "ETag",
1443
- # },
1444
- # git_hub_location: {
1445
- # repository: "Repository",
1446
- # commit_id: "CommitId",
1447
- # },
1448
- # },
1449
- # })
1450
- # @overload register_application_revision(params = {})
1451
- # @param [Hash] params ({})
1452
- def register_application_revision(params = {}, options = {})
1453
- req = build_request(:register_application_revision, params)
1454
- req.send_request(options)
1455
- end
1515
+ # Gets a list of names for one or more on-premises instances.
1516
+ #
1517
+ # Unless otherwise specified, both registered and deregistered
1518
+ # on-premises instance names will be listed. To list only registered or
1519
+ # deregistered on-premises instance names, use the registration status
1520
+ # parameter.
1521
+ #
1522
+ # @option params [String] :registration_status
1523
+ # The registration status of the on-premises instances:
1524
+ #
1525
+ # * Deregistered: Include deregistered on-premises instances in the
1526
+ # resulting list.
1527
+ #
1528
+ # * Registered: Include registered on-premises instances in the
1529
+ # resulting list.
1530
+ #
1531
+ # @option params [Array<Types::TagFilter>] :tag_filters
1532
+ # The on-premises instance tags that will be used to restrict the
1533
+ # corresponding on-premises instance names returned.
1534
+ #
1535
+ # @option params [String] :next_token
1536
+ # An identifier returned from the previous list on-premises instances
1537
+ # call. It can be used to return the next set of on-premises instances
1538
+ # in the list.
1539
+ #
1540
+ # @return [Types::ListOnPremisesInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1541
+ #
1542
+ # * {Types::ListOnPremisesInstancesOutput#instance_names #instance_names} => Array&lt;String&gt;
1543
+ # * {Types::ListOnPremisesInstancesOutput#next_token #next_token} => String
1544
+ #
1545
+ # @example Request syntax with placeholder values
1546
+ #
1547
+ # resp = client.list_on_premises_instances({
1548
+ # registration_status: "Registered", # accepts Registered, Deregistered
1549
+ # tag_filters: [
1550
+ # {
1551
+ # key: "Key",
1552
+ # value: "Value",
1553
+ # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1554
+ # },
1555
+ # ],
1556
+ # next_token: "NextToken",
1557
+ # })
1558
+ #
1559
+ # @example Response structure
1560
+ #
1561
+ # resp.instance_names #=> Array
1562
+ # resp.instance_names[0] #=> String
1563
+ # resp.next_token #=> String
1564
+ #
1565
+ # @overload list_on_premises_instances(params = {})
1566
+ # @param [Hash] params ({})
1567
+ def list_on_premises_instances(params = {}, options = {})
1568
+ req = build_request(:list_on_premises_instances, params)
1569
+ req.send_request(options)
1570
+ end
1456
1571
 
1457
- # Registers an on-premises instance.
1458
- # @option params [required, String] :instance_name
1459
- # The name of the on-premises instance to register.
1460
- # @option params [required, String] :iam_user_arn
1461
- # The ARN of the IAM user to associate with the on-premises instance.
1462
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1463
- #
1464
- # @example Request syntax with placeholder values
1465
- # resp = client.register_on_premises_instance({
1466
- # instance_name: "InstanceName", # required
1467
- # iam_user_arn: "IamUserArn", # required
1468
- # })
1469
- # @overload register_on_premises_instance(params = {})
1470
- # @param [Hash] params ({})
1471
- def register_on_premises_instance(params = {}, options = {})
1472
- req = build_request(:register_on_premises_instance, params)
1473
- req.send_request(options)
1474
- end
1572
+ # Registers with AWS CodeDeploy a revision for the specified
1573
+ # application.
1574
+ #
1575
+ # @option params [required, String] :application_name
1576
+ # The name of an AWS CodeDeploy application associated with the
1577
+ # applicable IAM user or AWS account.
1578
+ #
1579
+ # @option params [String] :description
1580
+ # A comment about the revision.
1581
+ #
1582
+ # @option params [required, Types::RevisionLocation] :revision
1583
+ # Information about the application revision to register, including type
1584
+ # and location.
1585
+ #
1586
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1587
+ #
1588
+ # @example Request syntax with placeholder values
1589
+ #
1590
+ # resp = client.register_application_revision({
1591
+ # application_name: "ApplicationName", # required
1592
+ # description: "Description",
1593
+ # revision: { # required
1594
+ # revision_type: "S3", # accepts S3, GitHub
1595
+ # s3_location: {
1596
+ # bucket: "S3Bucket",
1597
+ # key: "S3Key",
1598
+ # bundle_type: "tar", # accepts tar, tgz, zip
1599
+ # version: "VersionId",
1600
+ # e_tag: "ETag",
1601
+ # },
1602
+ # git_hub_location: {
1603
+ # repository: "Repository",
1604
+ # commit_id: "CommitId",
1605
+ # },
1606
+ # },
1607
+ # })
1608
+ #
1609
+ # @overload register_application_revision(params = {})
1610
+ # @param [Hash] params ({})
1611
+ def register_application_revision(params = {}, options = {})
1612
+ req = build_request(:register_application_revision, params)
1613
+ req.send_request(options)
1614
+ end
1475
1615
 
1476
- # Removes one or more tags from one or more on-premises instances.
1477
- # @option params [required, Array<Types::Tag>] :tags
1478
- # The tag key-value pairs to remove from the on-premises instances.
1479
- # @option params [required, Array<String>] :instance_names
1480
- # The names of the on-premises instances from which to remove tags.
1481
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1482
- #
1483
- # @example Request syntax with placeholder values
1484
- # resp = client.remove_tags_from_on_premises_instances({
1485
- # tags: [ # required
1486
- # {
1487
- # key: "Key",
1488
- # value: "Value",
1489
- # },
1490
- # ],
1491
- # instance_names: ["InstanceName"], # required
1492
- # })
1493
- # @overload remove_tags_from_on_premises_instances(params = {})
1494
- # @param [Hash] params ({})
1495
- def remove_tags_from_on_premises_instances(params = {}, options = {})
1496
- req = build_request(:remove_tags_from_on_premises_instances, params)
1497
- req.send_request(options)
1498
- end
1616
+ # Registers an on-premises instance.
1617
+ #
1618
+ # <note markdown="1"> Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in
1619
+ # the request. You cannot use both.
1620
+ #
1621
+ # </note>
1622
+ #
1623
+ # @option params [required, String] :instance_name
1624
+ # The name of the on-premises instance to register.
1625
+ #
1626
+ # @option params [String] :iam_session_arn
1627
+ # The ARN of the IAM session to associate with the on-premises instance.
1628
+ #
1629
+ # @option params [String] :iam_user_arn
1630
+ # The ARN of the IAM user to associate with the on-premises instance.
1631
+ #
1632
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1633
+ #
1634
+ # @example Request syntax with placeholder values
1635
+ #
1636
+ # resp = client.register_on_premises_instance({
1637
+ # instance_name: "InstanceName", # required
1638
+ # iam_session_arn: "IamSessionArn",
1639
+ # iam_user_arn: "IamUserArn",
1640
+ # })
1641
+ #
1642
+ # @overload register_on_premises_instance(params = {})
1643
+ # @param [Hash] params ({})
1644
+ def register_on_premises_instance(params = {}, options = {})
1645
+ req = build_request(:register_on_premises_instance, params)
1646
+ req.send_request(options)
1647
+ end
1499
1648
 
1500
- # Attempts to stop an ongoing deployment.
1501
- # @option params [required, String] :deployment_id
1502
- # The unique ID of a deployment.
1503
- # @option params [Boolean] :auto_rollback_enabled
1504
- # Indicates, when a deployment is stopped, whether instances that have
1505
- # been updated should be rolled back to the previous version of the
1506
- # application revision.
1507
- # @return [Types::StopDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1508
- #
1509
- # * {Types::StopDeploymentOutput#status #status} => String
1510
- # * {Types::StopDeploymentOutput#status_message #statusMessage} => String
1511
- #
1512
- # @example Request syntax with placeholder values
1513
- # resp = client.stop_deployment({
1514
- # deployment_id: "DeploymentId", # required
1515
- # auto_rollback_enabled: false,
1516
- # })
1517
- #
1518
- # @example Response structure
1519
- # resp.status #=> String, one of "Pending", "Succeeded"
1520
- # resp.status_message #=> String
1521
- # @overload stop_deployment(params = {})
1522
- # @param [Hash] params ({})
1523
- def stop_deployment(params = {}, options = {})
1524
- req = build_request(:stop_deployment, params)
1525
- req.send_request(options)
1526
- end
1649
+ # Removes one or more tags from one or more on-premises instances.
1650
+ #
1651
+ # @option params [required, Array<Types::Tag>] :tags
1652
+ # The tag key-value pairs to remove from the on-premises instances.
1653
+ #
1654
+ # @option params [required, Array<String>] :instance_names
1655
+ # The names of the on-premises instances from which to remove tags.
1656
+ #
1657
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1658
+ #
1659
+ # @example Request syntax with placeholder values
1660
+ #
1661
+ # resp = client.remove_tags_from_on_premises_instances({
1662
+ # tags: [ # required
1663
+ # {
1664
+ # key: "Key",
1665
+ # value: "Value",
1666
+ # },
1667
+ # ],
1668
+ # instance_names: ["InstanceName"], # required
1669
+ # })
1670
+ #
1671
+ # @overload remove_tags_from_on_premises_instances(params = {})
1672
+ # @param [Hash] params ({})
1673
+ def remove_tags_from_on_premises_instances(params = {}, options = {})
1674
+ req = build_request(:remove_tags_from_on_premises_instances, params)
1675
+ req.send_request(options)
1676
+ end
1527
1677
 
1528
- # Changes the name of an application.
1529
- # @option params [String] :application_name
1530
- # The current name of the application you want to change.
1531
- # @option params [String] :new_application_name
1532
- # The new name to give the application.
1533
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1534
- #
1535
- # @example Request syntax with placeholder values
1536
- # resp = client.update_application({
1537
- # application_name: "ApplicationName",
1538
- # new_application_name: "ApplicationName",
1539
- # })
1540
- # @overload update_application(params = {})
1541
- # @param [Hash] params ({})
1542
- def update_application(params = {}, options = {})
1543
- req = build_request(:update_application, params)
1544
- req.send_request(options)
1545
- end
1678
+ # Attempts to stop an ongoing deployment.
1679
+ #
1680
+ # @option params [required, String] :deployment_id
1681
+ # The unique ID of a deployment.
1682
+ #
1683
+ # @option params [Boolean] :auto_rollback_enabled
1684
+ # Indicates, when a deployment is stopped, whether instances that have
1685
+ # been updated should be rolled back to the previous version of the
1686
+ # application revision.
1687
+ #
1688
+ # @return [Types::StopDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1689
+ #
1690
+ # * {Types::StopDeploymentOutput#status #status} => String
1691
+ # * {Types::StopDeploymentOutput#status_message #status_message} => String
1692
+ #
1693
+ # @example Request syntax with placeholder values
1694
+ #
1695
+ # resp = client.stop_deployment({
1696
+ # deployment_id: "DeploymentId", # required
1697
+ # auto_rollback_enabled: false,
1698
+ # })
1699
+ #
1700
+ # @example Response structure
1701
+ #
1702
+ # resp.status #=> String, one of "Pending", "Succeeded"
1703
+ # resp.status_message #=> String
1704
+ #
1705
+ # @overload stop_deployment(params = {})
1706
+ # @param [Hash] params ({})
1707
+ def stop_deployment(params = {}, options = {})
1708
+ req = build_request(:stop_deployment, params)
1709
+ req.send_request(options)
1710
+ end
1546
1711
 
1547
- # Changes information about a deployment group.
1548
- # @option params [required, String] :application_name
1549
- # The application name corresponding to the deployment group to update.
1550
- # @option params [required, String] :current_deployment_group_name
1551
- # The current name of the deployment group.
1552
- # @option params [String] :new_deployment_group_name
1553
- # The new name of the deployment group, if you want to change it.
1554
- # @option params [String] :deployment_config_name
1555
- # The replacement deployment configuration name to use, if you want to
1556
- # change it.
1557
- # @option params [Array<Types::EC2TagFilter>] :ec2_tag_filters
1558
- # The replacement set of Amazon EC2 tags on which to filter, if you want
1559
- # to change them. To keep the existing tags, enter their names. To
1560
- # remove tags, do not enter any tag names.
1561
- # @option params [Array<Types::TagFilter>] :on_premises_instance_tag_filters
1562
- # The replacement set of on-premises instance tags on which to filter,
1563
- # if you want to change them. To keep the existing tags, enter their
1564
- # names. To remove tags, do not enter any tag names.
1565
- # @option params [Array<String>] :auto_scaling_groups
1566
- # The replacement list of Auto Scaling groups to be included in the
1567
- # deployment group, if you want to change them. To keep the Auto Scaling
1568
- # groups, enter their names. To remove Auto Scaling groups, do not enter
1569
- # any Auto Scaling group names.
1570
- # @option params [String] :service_role_arn
1571
- # A replacement ARN for the service role, if you want to change it.
1572
- # @option params [Array<Types::TriggerConfig>] :trigger_configurations
1573
- # Information about triggers to change when the deployment group is
1574
- # updated. For examples, see [Modify Triggers in an AWS CodeDeploy
1575
- # Deployment Group][1] in the AWS CodeDeploy User Guide.
1576
- #
1577
- #
1578
- #
1579
- # [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html
1580
- # @option params [Types::AlarmConfiguration] :alarm_configuration
1581
- # Information to add or change about Amazon CloudWatch alarms when the
1582
- # deployment group is updated.
1583
- # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
1584
- # Information for an automatic rollback configuration that is added or
1585
- # changed when a deployment group is updated.
1586
- # @return [Types::UpdateDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1587
- #
1588
- # * {Types::UpdateDeploymentGroupOutput#hooks_not_cleaned_up #hooksNotCleanedUp} => Array&lt;Types::AutoScalingGroup&gt;
1589
- #
1590
- # @example Request syntax with placeholder values
1591
- # resp = client.update_deployment_group({
1592
- # application_name: "ApplicationName", # required
1593
- # current_deployment_group_name: "DeploymentGroupName", # required
1594
- # new_deployment_group_name: "DeploymentGroupName",
1595
- # deployment_config_name: "DeploymentConfigName",
1596
- # ec2_tag_filters: [
1597
- # {
1598
- # key: "Key",
1599
- # value: "Value",
1600
- # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1601
- # },
1602
- # ],
1603
- # on_premises_instance_tag_filters: [
1604
- # {
1605
- # key: "Key",
1606
- # value: "Value",
1607
- # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1608
- # },
1609
- # ],
1610
- # auto_scaling_groups: ["AutoScalingGroupName"],
1611
- # service_role_arn: "Role",
1612
- # trigger_configurations: [
1613
- # {
1614
- # trigger_name: "TriggerName",
1615
- # trigger_target_arn: "TriggerTargetArn",
1616
- # trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, InstanceStart, InstanceSuccess, InstanceFailure
1617
- # },
1618
- # ],
1619
- # alarm_configuration: {
1620
- # enabled: false,
1621
- # ignore_poll_alarm_failure: false,
1622
- # alarms: [
1623
- # {
1624
- # name: "AlarmName",
1625
- # },
1626
- # ],
1627
- # },
1628
- # auto_rollback_configuration: {
1629
- # enabled: false,
1630
- # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
1631
- # },
1632
- # })
1633
- #
1634
- # @example Response structure
1635
- # resp.hooks_not_cleaned_up #=> Array
1636
- # resp.hooks_not_cleaned_up[0].name #=> String
1637
- # resp.hooks_not_cleaned_up[0].hook #=> String
1638
- # @overload update_deployment_group(params = {})
1639
- # @param [Hash] params ({})
1640
- def update_deployment_group(params = {}, options = {})
1641
- req = build_request(:update_deployment_group, params)
1642
- req.send_request(options)
1643
- end
1712
+ # Changes the name of an application.
1713
+ #
1714
+ # @option params [String] :application_name
1715
+ # The current name of the application you want to change.
1716
+ #
1717
+ # @option params [String] :new_application_name
1718
+ # The new name to give the application.
1719
+ #
1720
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1721
+ #
1722
+ # @example Request syntax with placeholder values
1723
+ #
1724
+ # resp = client.update_application({
1725
+ # application_name: "ApplicationName",
1726
+ # new_application_name: "ApplicationName",
1727
+ # })
1728
+ #
1729
+ # @overload update_application(params = {})
1730
+ # @param [Hash] params ({})
1731
+ def update_application(params = {}, options = {})
1732
+ req = build_request(:update_application, params)
1733
+ req.send_request(options)
1734
+ end
1644
1735
 
1645
- # @!endgroup
1736
+ # Changes information about a deployment group.
1737
+ #
1738
+ # @option params [required, String] :application_name
1739
+ # The application name corresponding to the deployment group to update.
1740
+ #
1741
+ # @option params [required, String] :current_deployment_group_name
1742
+ # The current name of the deployment group.
1743
+ #
1744
+ # @option params [String] :new_deployment_group_name
1745
+ # The new name of the deployment group, if you want to change it.
1746
+ #
1747
+ # @option params [String] :deployment_config_name
1748
+ # The replacement deployment configuration name to use, if you want to
1749
+ # change it.
1750
+ #
1751
+ # @option params [Array<Types::EC2TagFilter>] :ec2_tag_filters
1752
+ # The replacement set of Amazon EC2 tags on which to filter, if you want
1753
+ # to change them. To keep the existing tags, enter their names. To
1754
+ # remove tags, do not enter any tag names.
1755
+ #
1756
+ # @option params [Array<Types::TagFilter>] :on_premises_instance_tag_filters
1757
+ # The replacement set of on-premises instance tags on which to filter,
1758
+ # if you want to change them. To keep the existing tags, enter their
1759
+ # names. To remove tags, do not enter any tag names.
1760
+ #
1761
+ # @option params [Array<String>] :auto_scaling_groups
1762
+ # The replacement list of Auto Scaling groups to be included in the
1763
+ # deployment group, if you want to change them. To keep the Auto Scaling
1764
+ # groups, enter their names. To remove Auto Scaling groups, do not enter
1765
+ # any Auto Scaling group names.
1766
+ #
1767
+ # @option params [String] :service_role_arn
1768
+ # A replacement ARN for the service role, if you want to change it.
1769
+ #
1770
+ # @option params [Array<Types::TriggerConfig>] :trigger_configurations
1771
+ # Information about triggers to change when the deployment group is
1772
+ # updated. For examples, see [Modify Triggers in an AWS CodeDeploy
1773
+ # Deployment Group][1] in the AWS CodeDeploy User Guide.
1774
+ #
1775
+ #
1776
+ #
1777
+ # [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html
1778
+ #
1779
+ # @option params [Types::AlarmConfiguration] :alarm_configuration
1780
+ # Information to add or change about Amazon CloudWatch alarms when the
1781
+ # deployment group is updated.
1782
+ #
1783
+ # @option params [Types::AutoRollbackConfiguration] :auto_rollback_configuration
1784
+ # Information for an automatic rollback configuration that is added or
1785
+ # changed when a deployment group is updated.
1786
+ #
1787
+ # @return [Types::UpdateDeploymentGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1788
+ #
1789
+ # * {Types::UpdateDeploymentGroupOutput#hooks_not_cleaned_up #hooks_not_cleaned_up} => Array&lt;Types::AutoScalingGroup&gt;
1790
+ #
1791
+ # @example Request syntax with placeholder values
1792
+ #
1793
+ # resp = client.update_deployment_group({
1794
+ # application_name: "ApplicationName", # required
1795
+ # current_deployment_group_name: "DeploymentGroupName", # required
1796
+ # new_deployment_group_name: "DeploymentGroupName",
1797
+ # deployment_config_name: "DeploymentConfigName",
1798
+ # ec2_tag_filters: [
1799
+ # {
1800
+ # key: "Key",
1801
+ # value: "Value",
1802
+ # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1803
+ # },
1804
+ # ],
1805
+ # on_premises_instance_tag_filters: [
1806
+ # {
1807
+ # key: "Key",
1808
+ # value: "Value",
1809
+ # type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
1810
+ # },
1811
+ # ],
1812
+ # auto_scaling_groups: ["AutoScalingGroupName"],
1813
+ # service_role_arn: "Role",
1814
+ # trigger_configurations: [
1815
+ # {
1816
+ # trigger_name: "TriggerName",
1817
+ # trigger_target_arn: "TriggerTargetArn",
1818
+ # trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, InstanceStart, InstanceSuccess, InstanceFailure
1819
+ # },
1820
+ # ],
1821
+ # alarm_configuration: {
1822
+ # enabled: false,
1823
+ # ignore_poll_alarm_failure: false,
1824
+ # alarms: [
1825
+ # {
1826
+ # name: "AlarmName",
1827
+ # },
1828
+ # ],
1829
+ # },
1830
+ # auto_rollback_configuration: {
1831
+ # enabled: false,
1832
+ # events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
1833
+ # },
1834
+ # })
1835
+ #
1836
+ # @example Response structure
1837
+ #
1838
+ # resp.hooks_not_cleaned_up #=> Array
1839
+ # resp.hooks_not_cleaned_up[0].name #=> String
1840
+ # resp.hooks_not_cleaned_up[0].hook #=> String
1841
+ #
1842
+ # @overload update_deployment_group(params = {})
1843
+ # @param [Hash] params ({})
1844
+ def update_deployment_group(params = {}, options = {})
1845
+ req = build_request(:update_deployment_group, params)
1846
+ req.send_request(options)
1847
+ end
1646
1848
 
1647
- # @param params ({})
1648
- # @api private
1649
- def build_request(operation_name, params = {})
1650
- handlers = @handlers.for(operation_name)
1651
- context = Seahorse::Client::RequestContext.new(
1652
- operation_name: operation_name,
1653
- operation: config.api.operation(operation_name),
1654
- client: self,
1655
- params: params,
1656
- config: config)
1657
- context[:gem_name] = 'aws-sdk-codedeploy'
1658
- context[:gem_version] = '1.0.0.rc1'
1659
- Seahorse::Client::Request.new(handlers, context)
1660
- end
1849
+ # @!endgroup
1661
1850
 
1662
- # Polls an API operation until a resource enters a desired state.
1663
- #
1664
- # ## Basic Usage
1665
- #
1666
- # A waiter will call an API operation until:
1667
- #
1668
- # * It is successful
1669
- # * It enters a terminal state
1670
- # * It makes the maximum number of attempts
1671
- #
1672
- # In between attempts, the waiter will sleep.
1673
- #
1674
- # # polls in a loop, sleeping between attempts
1675
- # client.waiter_until(waiter_name, params)
1676
- #
1677
- # ## Configuration
1678
- #
1679
- # You can configure the maximum number of polling attempts, and the
1680
- # delay (in seconds) between each polling attempt. You can pass
1681
- # configuration as the final arguments hash.
1682
- #
1683
- # # poll for ~25 seconds
1684
- # client.wait_until(waiter_name, params, {
1685
- # max_attempts: 5,
1686
- # delay: 5,
1687
- # })
1688
- #
1689
- # ## Callbacks
1690
- #
1691
- # You can be notified before each polling attempt and before each
1692
- # delay. If you throw `:success` or `:failure` from these callbacks,
1693
- # it will terminate the waiter.
1694
- #
1695
- # started_at = Time.now
1696
- # client.wait_until(waiter_name, params, {
1697
- #
1698
- # # disable max attempts
1699
- # max_attempts: nil,
1700
- #
1701
- # # poll for 1 hour, instead of a number of attempts
1702
- # before_wait: -> (attempts, response) do
1703
- # throw :failure if Time.now - started_at > 3600
1704
- # end
1705
- # })
1706
- #
1707
- # ## Handling Errors
1708
- #
1709
- # When a waiter is unsuccessful, it will raise an error.
1710
- # All of the failure errors extend from
1711
- # {Aws::Waiters::Errors::WaiterFailed}.
1712
- #
1713
- # begin
1714
- # client.wait_until(...)
1715
- # rescue Aws::Waiters::Errors::WaiterFailed
1716
- # # resource did not enter the desired state in time
1717
- # end
1718
- #
1719
- # ## Valid Waiters
1720
- #
1721
- # The following table lists the valid waiter names, the operations they call,
1722
- # and the default `:delay` and `:max_attempts` values.
1723
- #
1724
- # | waiter_name | params | :delay | :max_attempts |
1725
- # | --------------------- | ----------------- | -------- | ------------- |
1726
- # | deployment_successful | {#get_deployment} | 15 | 120 |
1727
- #
1728
- # @raise [Errors::FailureStateError] Raised when the waiter terminates
1729
- # because the waiter has entered a state that it will not transition
1730
- # out of, preventing success.
1731
- #
1732
- # @raise [Errors::TooManyAttemptsError] Raised when the configured
1733
- # maximum number of attempts have been made, and the waiter is not
1734
- # yet successful.
1735
- #
1736
- # @raise [Errors::UnexpectedError] Raised when an error is encounted
1737
- # while polling for a resource that is not expected.
1738
- #
1739
- # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
1740
- # for an unknown state.
1741
- #
1742
- # @return [Boolean] Returns `true` if the waiter was successful.
1743
- # @param [Symbol] waiter_name
1744
- # @param [Hash] params ({})
1745
- # @param [Hash] options ({})
1746
- # @option options [Integer] :max_attempts
1747
- # @option options [Integer] :delay
1748
- # @option options [Proc] :before_attempt
1749
- # @option options [Proc] :before_wait
1750
- def wait_until(waiter_name, params = {}, options = {})
1751
- w = waiter(waiter_name, options)
1752
- yield(w.waiter) if block_given? # deprecated
1753
- w.wait(params)
1754
- end
1851
+ # @param params ({})
1852
+ # @api private
1853
+ def build_request(operation_name, params = {})
1854
+ handlers = @handlers.for(operation_name)
1855
+ context = Seahorse::Client::RequestContext.new(
1856
+ operation_name: operation_name,
1857
+ operation: config.api.operation(operation_name),
1858
+ client: self,
1859
+ params: params,
1860
+ config: config)
1861
+ context[:gem_name] = 'aws-sdk-codedeploy'
1862
+ context[:gem_version] = '1.0.0.rc1'
1863
+ Seahorse::Client::Request.new(handlers, context)
1864
+ end
1755
1865
 
1756
- # @api private
1757
- # @deprecated
1758
- def waiter_names
1759
- waiters.keys
1760
- end
1866
+ # Polls an API operation until a resource enters a desired state.
1867
+ #
1868
+ # ## Basic Usage
1869
+ #
1870
+ # A waiter will call an API operation until:
1871
+ #
1872
+ # * It is successful
1873
+ # * It enters a terminal state
1874
+ # * It makes the maximum number of attempts
1875
+ #
1876
+ # In between attempts, the waiter will sleep.
1877
+ #
1878
+ # # polls in a loop, sleeping between attempts
1879
+ # client.waiter_until(waiter_name, params)
1880
+ #
1881
+ # ## Configuration
1882
+ #
1883
+ # You can configure the maximum number of polling attempts, and the
1884
+ # delay (in seconds) between each polling attempt. You can pass
1885
+ # configuration as the final arguments hash.
1886
+ #
1887
+ # # poll for ~25 seconds
1888
+ # client.wait_until(waiter_name, params, {
1889
+ # max_attempts: 5,
1890
+ # delay: 5,
1891
+ # })
1892
+ #
1893
+ # ## Callbacks
1894
+ #
1895
+ # You can be notified before each polling attempt and before each
1896
+ # delay. If you throw `:success` or `:failure` from these callbacks,
1897
+ # it will terminate the waiter.
1898
+ #
1899
+ # started_at = Time.now
1900
+ # client.wait_until(waiter_name, params, {
1901
+ #
1902
+ # # disable max attempts
1903
+ # max_attempts: nil,
1904
+ #
1905
+ # # poll for 1 hour, instead of a number of attempts
1906
+ # before_wait: -> (attempts, response) do
1907
+ # throw :failure if Time.now - started_at > 3600
1908
+ # end
1909
+ # })
1910
+ #
1911
+ # ## Handling Errors
1912
+ #
1913
+ # When a waiter is unsuccessful, it will raise an error.
1914
+ # All of the failure errors extend from
1915
+ # {Aws::Waiters::Errors::WaiterFailed}.
1916
+ #
1917
+ # begin
1918
+ # client.wait_until(...)
1919
+ # rescue Aws::Waiters::Errors::WaiterFailed
1920
+ # # resource did not enter the desired state in time
1921
+ # end
1922
+ #
1923
+ # ## Valid Waiters
1924
+ #
1925
+ # The following table lists the valid waiter names, the operations they call,
1926
+ # and the default `:delay` and `:max_attempts` values.
1927
+ #
1928
+ # | waiter_name | params | :delay | :max_attempts |
1929
+ # | --------------------- | ----------------- | -------- | ------------- |
1930
+ # | deployment_successful | {#get_deployment} | 15 | 120 |
1931
+ #
1932
+ # @raise [Errors::FailureStateError] Raised when the waiter terminates
1933
+ # because the waiter has entered a state that it will not transition
1934
+ # out of, preventing success.
1935
+ #
1936
+ # @raise [Errors::TooManyAttemptsError] Raised when the configured
1937
+ # maximum number of attempts have been made, and the waiter is not
1938
+ # yet successful.
1939
+ #
1940
+ # @raise [Errors::UnexpectedError] Raised when an error is encounted
1941
+ # while polling for a resource that is not expected.
1942
+ #
1943
+ # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
1944
+ # for an unknown state.
1945
+ #
1946
+ # @return [Boolean] Returns `true` if the waiter was successful.
1947
+ # @param [Symbol] waiter_name
1948
+ # @param [Hash] params ({})
1949
+ # @param [Hash] options ({})
1950
+ # @option options [Integer] :max_attempts
1951
+ # @option options [Integer] :delay
1952
+ # @option options [Proc] :before_attempt
1953
+ # @option options [Proc] :before_wait
1954
+ def wait_until(waiter_name, params = {}, options = {})
1955
+ w = waiter(waiter_name, options)
1956
+ yield(w.waiter) if block_given? # deprecated
1957
+ w.wait(params)
1958
+ end
1761
1959
 
1762
- private
1960
+ # @api private
1961
+ # @deprecated
1962
+ def waiter_names
1963
+ waiters.keys
1964
+ end
1763
1965
 
1764
- # @param [Symbol] waiter_name
1765
- # @param [Hash] options ({})
1766
- def waiter(waiter_name, options = {})
1767
- waiter_class = waiters[waiter_name]
1768
- if waiter_class
1769
- waiter_class.new(options.merge(client: self))
1770
- else
1771
- raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
1772
- end
1773
- end
1966
+ private
1774
1967
 
1775
- def waiters
1776
- {
1777
- deployment_successful: Waiters::DeploymentSuccessful
1778
- }
1968
+ # @param [Symbol] waiter_name
1969
+ # @param [Hash] options ({})
1970
+ def waiter(waiter_name, options = {})
1971
+ waiter_class = waiters[waiter_name]
1972
+ if waiter_class
1973
+ waiter_class.new(options.merge(client: self))
1974
+ else
1975
+ raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
1779
1976
  end
1977
+ end
1780
1978
 
1781
- class << self
1979
+ def waiters
1980
+ {
1981
+ deployment_successful: Waiters::DeploymentSuccessful
1982
+ }
1983
+ end
1782
1984
 
1783
- # @api private
1784
- attr_reader :identifier
1985
+ class << self
1785
1986
 
1786
- # @api private
1787
- def errors_module
1788
- Errors
1789
- end
1987
+ # @api private
1988
+ attr_reader :identifier
1790
1989
 
1990
+ # @api private
1991
+ def errors_module
1992
+ Errors
1791
1993
  end
1994
+
1792
1995
  end
1793
1996
  end
1794
1997
  end