aws-sdk-codedeploy 1.0.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 556b62d94f9012238d53d3c49fe3b638a026b4fd
4
+ data.tar.gz: d3f9239d83d7caf7cc5568a3a70f55d856417e2c
5
+ SHA512:
6
+ metadata.gz: 9e6debd835e026b3368f8ac3c07db7ec481754a81e44e324a1444c77d23b30b2438118fe183d4f4f4a07e348752fbc2835f7e8f975c652a44f7fae222bec5661
7
+ data.tar.gz: 9b4bdaacb12d41a8d30ec16c68acf726e254bc3b918eb5462b4950f25d575c11176f17d37cbc768a98e797c358ddaf263acc42bdd39ba527366b7265c7d58076
@@ -0,0 +1,48 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-codedeploy/types'
12
+ require_relative 'aws-sdk-codedeploy/client_api'
13
+ require_relative 'aws-sdk-codedeploy/client'
14
+ require_relative 'aws-sdk-codedeploy/errors'
15
+ require_relative 'aws-sdk-codedeploy/waiters'
16
+ require_relative 'aws-sdk-codedeploy/resource'
17
+ require_relative 'aws-sdk-codedeploy/customizations'
18
+
19
+ # This module provides support for AWS CodeDeploy. This module is available in the
20
+ # `aws-sdk-codedeploy` gem.
21
+ #
22
+ # # Client
23
+ #
24
+ # The {Client} class provides one method for each API operation. Operation
25
+ # methods each accept a hash of request parameters and return a response
26
+ # structure.
27
+ #
28
+ # See {Client} for more information.
29
+ #
30
+ # # Errors
31
+ #
32
+ # Errors returned from AWS CodeDeploy all
33
+ # extend {Errors::ServiceError}.
34
+ #
35
+ # begin
36
+ # # do stuff
37
+ # rescue Aws::CodeDeploy::Errors::ServiceError
38
+ # # rescues all service API errors
39
+ # end
40
+ #
41
+ # See {Errors} for more information.
42
+ #
43
+ # @service
44
+ module Aws::CodeDeploy
45
+
46
+ GEM_VERSION = '1.0.0.rc1'
47
+
48
+ end
@@ -0,0 +1,1794 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/signature_v4.rb'
22
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
+
24
+ Aws::Plugins::GlobalConfiguration.add_identifier(:codedeploy)
25
+
26
+ module Aws
27
+ module CodeDeploy
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :codedeploy
33
+
34
+ set_api(ClientApi::API)
35
+
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)
51
+
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
141
+
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
168
+
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
227
+
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
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
315
+
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
355
+
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
409
+
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
438
+
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
460
+
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
536
+
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
581
+
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
728
+
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
745
+
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
767
+
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
795
+
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
811
+
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
836
+
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
890
+
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
944
+
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
970
+
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
1031
+
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
1067
+
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
1095
+
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
1179
+
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
1205
+
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
1232
+
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
1265
+
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
1312
+
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
1368
+
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
1418
+
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
1456
+
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
1475
+
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
1499
+
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
1527
+
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
1546
+
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
1644
+
1645
+ # @!endgroup
1646
+
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
1661
+
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
1755
+
1756
+ # @api private
1757
+ # @deprecated
1758
+ def waiter_names
1759
+ waiters.keys
1760
+ end
1761
+
1762
+ private
1763
+
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
1774
+
1775
+ def waiters
1776
+ {
1777
+ deployment_successful: Waiters::DeploymentSuccessful
1778
+ }
1779
+ end
1780
+
1781
+ class << self
1782
+
1783
+ # @api private
1784
+ attr_reader :identifier
1785
+
1786
+ # @api private
1787
+ def errors_module
1788
+ Errors
1789
+ end
1790
+
1791
+ end
1792
+ end
1793
+ end
1794
+ end