aws-sdk-elasticbeanstalk 1.25.0 → 1.30.0

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
- SHA1:
3
- metadata.gz: 5dc686e0495082354427c5cff2b4cdade150e1a4
4
- data.tar.gz: 9d87a3422dd430bed4e234688d51235b4759658e
2
+ SHA256:
3
+ metadata.gz: c9ab9f45555ae5d4a648182b57ae1bc06eb61d327c5450092686c46d2733908e
4
+ data.tar.gz: 7ffa61ee380b37e0ceeb6220ad6bdc22eae1b99b411815abdcf41e44df713e42
5
5
  SHA512:
6
- metadata.gz: 9cbfe697fb1ccbec247891bac82af5274765be27230cec30f9f84a36cba207a3c7342629cc44e79dd3923f73794da770b25da76ede83fc1046b4e98205ca91fe
7
- data.tar.gz: 35fafece497b306a2ec3eef4e815de1705268cadd56aab13057d1e5e53d26fee2dff5a89ac616762245790e7bdfcdcab0bcd5e0488c195e2efc07d3591f0a4a9
6
+ metadata.gz: 912c8dfcf3281a4f59e18086b14b6c0ad0c1e665a84a3551612ab260ddc46cc43a281e834a6afbf4d1361e8e6dece6d7e4fb09246a4e71a9c166e61b964b30fd
7
+ data.tar.gz: 7ea36aca651d02560581ed74ae33f6961c1580224404e4a0432af99c786804dfcb5c679e911ad18e2108912e14998c6ff97357f33b14f2d282c5887b0be68289
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # elastic_beanstalk = Aws::ElasticBeanstalk::Client.new
28
+ # resp = elastic_beanstalk.abort_environment_update(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Elastic Beanstalk all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Elastic Beanstalk are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::ElasticBeanstalk::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Elastic Beanstalk API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
42
45
  # @service
43
46
  module Aws::ElasticBeanstalk
44
47
 
45
- GEM_VERSION = '1.25.0'
48
+ GEM_VERSION = '1.30.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:elasticbeanstalk)
31
31
 
32
32
  module Aws::ElasticBeanstalk
33
+ # An API client for ElasticBeanstalk. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::ElasticBeanstalk::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::ElasticBeanstalk
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::ElasticBeanstalk
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::ElasticBeanstalk
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::ElasticBeanstalk
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::ElasticBeanstalk
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::ElasticBeanstalk
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::ElasticBeanstalk
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::ElasticBeanstalk
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::ElasticBeanstalk
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -472,17 +526,13 @@ module Aws::ElasticBeanstalk
472
526
  # `default` and no application versions.
473
527
  #
474
528
  # @option params [required, String] :application_name
475
- # The name of the application.
476
- #
477
- # Constraint: This name must be unique within your account. If the
478
- # specified name already exists, the action returns an
479
- # `InvalidParameterValue` error.
529
+ # The name of the application. Must be unique within your account.
480
530
  #
481
531
  # @option params [String] :description
482
- # Describes the application.
532
+ # Your description of the application.
483
533
  #
484
534
  # @option params [Types::ApplicationResourceLifecycleConfig] :resource_lifecycle_config
485
- # Specify an application resource lifecycle configuration to prevent
535
+ # Specifies an application resource lifecycle configuration to prevent
486
536
  # your application from accumulating too many versions.
487
537
  #
488
538
  # @option params [Array<Types::Tag>] :tags
@@ -590,8 +640,8 @@ module Aws::ElasticBeanstalk
590
640
  # Omit both `SourceBuildInformation` and `SourceBundle` to use the
591
641
  # default sample application.
592
642
  #
593
- # <note markdown="1"> Once you create an application version with a specified Amazon S3
594
- # bucket and key location, you cannot change that Amazon S3 location. If
643
+ # <note markdown="1"> After you create an application version with a specified Amazon S3
644
+ # bucket and key location, you can't change that Amazon S3 location. If
595
645
  # you change the Amazon S3 location, you receive an exception when you
596
646
  # attempt to launch an environment from the application version.
597
647
  #
@@ -610,7 +660,7 @@ module Aws::ElasticBeanstalk
610
660
  # Elastic Beanstalk returns an `InvalidParameterValue` error.
611
661
  #
612
662
  # @option params [String] :description
613
- # Describes this version.
663
+ # A description of this application version.
614
664
  #
615
665
  # @option params [Types::SourceBuildInformation] :source_build_information
616
666
  # Specify a commit in an AWS CodeCommit Git repository to use as the
@@ -751,8 +801,10 @@ module Aws::ElasticBeanstalk
751
801
  req.send_request(options)
752
802
  end
753
803
 
754
- # Creates a configuration template. Templates are associated with a
755
- # specific application and are used to deploy different versions of the
804
+ # Creates an AWS Elastic Beanstalk configuration template, associated
805
+ # with a specific Elastic Beanstalk application. You define application
806
+ # configuration settings in a configuration template. You can then use
807
+ # the configuration template to deploy different versions of the
756
808
  # application with the same configuration settings.
757
809
  #
758
810
  # Templates aren't associated with any environment. The
@@ -767,64 +819,80 @@ module Aws::ElasticBeanstalk
767
819
  # * ListAvailableSolutionStacks
768
820
  #
769
821
  # @option params [required, String] :application_name
770
- # The name of the application to associate with this configuration
771
- # template. If no application is found with this name, AWS Elastic
772
- # Beanstalk returns an `InvalidParameterValue` error.
822
+ # The name of the Elastic Beanstalk application to associate with this
823
+ # configuration template.
773
824
  #
774
825
  # @option params [required, String] :template_name
775
826
  # The name of the configuration template.
776
827
  #
777
828
  # Constraint: This name must be unique per application.
778
829
  #
779
- # Default: If a configuration template already exists with this name,
780
- # AWS Elastic Beanstalk returns an `InvalidParameterValue` error.
781
- #
782
830
  # @option params [String] :solution_stack_name
783
- # The name of the solution stack used by this configuration. The
784
- # solution stack specifies the operating system, architecture, and
785
- # application server for a configuration template. It determines the set
786
- # of configuration options as well as the possible and default values.
831
+ # The name of an Elastic Beanstalk solution stack (platform version)
832
+ # that this configuration uses. For example, `64bit Amazon Linux 2013.09
833
+ # running Tomcat 7 Java 7`. A solution stack specifies the operating
834
+ # system, runtime, and application server for a configuration template.
835
+ # It also determines the set of configuration options as well as the
836
+ # possible and default values. For more information, see [Supported
837
+ # Platforms][1] in the *AWS Elastic Beanstalk Developer Guide*.
787
838
  #
788
- # Use ListAvailableSolutionStacks to obtain a list of available solution
789
- # stacks.
839
+ # You must specify `SolutionStackName` if you don't specify
840
+ # `PlatformArn`, `EnvironmentId`, or `SourceConfiguration`.
790
841
  #
791
- # A solution stack name or a source configuration parameter must be
792
- # specified, otherwise AWS Elastic Beanstalk returns an
793
- # `InvalidParameterValue` error.
842
+ # Use the [ `ListAvailableSolutionStacks` ][2] API to obtain a list of
843
+ # available solution stacks.
794
844
  #
795
- # If a solution stack name is not specified and the source configuration
796
- # parameter is specified, AWS Elastic Beanstalk uses the same solution
797
- # stack as the source configuration template.
845
+ #
846
+ #
847
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html
848
+ # [2]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html
798
849
  #
799
850
  # @option params [String] :platform_arn
800
- # The ARN of the custom platform.
851
+ # The Amazon Resource Name (ARN) of the custom platform. For more
852
+ # information, see [ Custom Platforms][1] in the *AWS Elastic Beanstalk
853
+ # Developer Guide*.
854
+ #
855
+ # <note markdown="1"> If you specify `PlatformArn`, then don't specify `SolutionStackName`.
856
+ #
857
+ # </note>
858
+ #
859
+ #
860
+ #
861
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
801
862
  #
802
863
  # @option params [Types::SourceConfiguration] :source_configuration
803
- # If specified, AWS Elastic Beanstalk uses the configuration values from
804
- # the specified configuration template to create a new configuration.
864
+ # An Elastic Beanstalk configuration template to base this one on. If
865
+ # specified, Elastic Beanstalk uses the configuration values from the
866
+ # specified configuration template to create a new configuration.
805
867
  #
806
- # Values specified in the `OptionSettings` parameter of this call
807
- # overrides any values obtained from the `SourceConfiguration`.
868
+ # Values specified in `OptionSettings` override any values obtained from
869
+ # the `SourceConfiguration`.
808
870
  #
809
- # If no configuration template is found, returns an
810
- # `InvalidParameterValue` error.
871
+ # You must specify `SourceConfiguration` if you don't specify
872
+ # `PlatformArn`, `EnvironmentId`, or `SolutionStackName`.
811
873
  #
812
- # Constraint: If both the solution stack name parameter and the source
813
- # configuration parameters are specified, the solution stack of the
814
- # source configuration template must match the specified solution stack
815
- # name or else AWS Elastic Beanstalk returns an
816
- # `InvalidParameterCombination` error.
874
+ # Constraint: If both solution stack name and source configuration are
875
+ # specified, the solution stack of the source configuration template
876
+ # must match the specified solution stack name.
817
877
  #
818
878
  # @option params [String] :environment_id
819
- # The ID of the environment used with this configuration template.
879
+ # The ID of an environment whose settings you want to use to create the
880
+ # configuration template. You must specify `EnvironmentId` if you don't
881
+ # specify `PlatformArn`, `SolutionStackName`, or `SourceConfiguration`.
820
882
  #
821
883
  # @option params [String] :description
822
- # Describes this configuration.
884
+ # An optional description for this configuration.
823
885
  #
824
886
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
825
- # If specified, AWS Elastic Beanstalk sets the specified configuration
826
- # option to the requested value. The new value overrides the value
827
- # obtained from the solution stack or the source configuration template.
887
+ # Option values for the Elastic Beanstalk configuration, such as the
888
+ # instance type. If specified, these values override the values obtained
889
+ # from the solution stack or the source configuration template. For a
890
+ # complete list of Elastic Beanstalk configuration options, see [Option
891
+ # Values][1] in the *AWS Elastic Beanstalk Developer Guide*.
892
+ #
893
+ #
894
+ #
895
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
828
896
  #
829
897
  # @option params [Array<Types::Tag>] :tags
830
898
  # Specifies the tags applied to the configuration template.
@@ -918,28 +986,24 @@ module Aws::ElasticBeanstalk
918
986
  req.send_request(options)
919
987
  end
920
988
 
921
- # Launches an environment for the specified application using the
922
- # specified configuration.
989
+ # Launches an AWS Elastic Beanstalk environment for the specified
990
+ # application using the specified configuration.
923
991
  #
924
992
  # @option params [required, String] :application_name
925
- # The name of the application that contains the version to be deployed.
926
- #
927
- # If no application is found with this name, `CreateEnvironment` returns
928
- # an `InvalidParameterValue` error.
993
+ # The name of the application that is associated with this environment.
929
994
  #
930
995
  # @option params [String] :environment_name
931
- # A unique name for the deployment environment. Used in the application
932
- # URL.
996
+ # A unique name for the environment.
933
997
  #
934
998
  # Constraint: Must be from 4 to 40 characters in length. The name can
935
- # contain only letters, numbers, and hyphens. It cannot start or end
999
+ # contain only letters, numbers, and hyphens. It can't start or end
936
1000
  # with a hyphen. This name must be unique within a region in your
937
- # account. If the specified name already exists in the region, AWS
938
- # Elastic Beanstalk returns an `InvalidParameterValue` error.
1001
+ # account. If the specified name already exists in the region, Elastic
1002
+ # Beanstalk returns an `InvalidParameterValue` error.
939
1003
  #
940
- # Default: If the CNAME parameter is not specified, the environment name
941
- # becomes part of the CNAME, and therefore part of the visible URL for
942
- # your application.
1004
+ # If you don't specify the `CNAMEPrefix` parameter, the environment
1005
+ # name becomes part of the CNAME, and therefore part of the visible URL
1006
+ # for your application.
943
1007
  #
944
1008
  # @option params [String] :group_name
945
1009
  # The name of the group to which the target environment belongs. Specify
@@ -952,15 +1016,20 @@ module Aws::ElasticBeanstalk
952
1016
  # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
953
1017
  #
954
1018
  # @option params [String] :description
955
- # Describes this environment.
1019
+ # Your description for this environment.
956
1020
  #
957
1021
  # @option params [String] :cname_prefix
958
1022
  # If specified, the environment attempts to use this value as the prefix
959
- # for the CNAME. If not specified, the CNAME is generated automatically
960
- # by appending a random alphanumeric string to the environment name.
1023
+ # for the CNAME in your Elastic Beanstalk environment URL. If not
1024
+ # specified, the CNAME is generated automatically by appending a random
1025
+ # alphanumeric string to the environment name.
961
1026
  #
962
1027
  # @option params [Types::EnvironmentTier] :tier
963
- # This specifies the tier to use for creating this environment.
1028
+ # Specifies the tier to use in creating this environment. The
1029
+ # environment tier that you choose determines whether Elastic Beanstalk
1030
+ # provisions resources to support a web application that handles HTTP(S)
1031
+ # requests or a web application that handles background-processing
1032
+ # tasks.
964
1033
  #
965
1034
  # @option params [Array<Types::Tag>] :tags
966
1035
  # Specifies the tags applied to resources in the environment.
@@ -968,32 +1037,47 @@ module Aws::ElasticBeanstalk
968
1037
  # @option params [String] :version_label
969
1038
  # The name of the application version to deploy.
970
1039
  #
971
- # If the specified application has no associated application versions,
972
- # AWS Elastic Beanstalk `UpdateEnvironment` returns an
973
- # `InvalidParameterValue` error.
974
- #
975
- # Default: If not specified, AWS Elastic Beanstalk attempts to launch
976
- # the sample application in the container.
1040
+ # Default: If not specified, Elastic Beanstalk attempts to deploy the
1041
+ # sample application.
977
1042
  #
978
1043
  # @option params [String] :template_name
979
- # The name of the configuration template to use in deployment. If no
980
- # configuration template is found with this name, AWS Elastic Beanstalk
981
- # returns an `InvalidParameterValue` error.
1044
+ # The name of the Elastic Beanstalk configuration template to use with
1045
+ # the environment.
1046
+ #
1047
+ # <note markdown="1"> If you specify `TemplateName`, then don't specify
1048
+ # `SolutionStackName`.
1049
+ #
1050
+ # </note>
982
1051
  #
983
1052
  # @option params [String] :solution_stack_name
984
- # This is an alternative to specifying a template name. If specified,
985
- # AWS Elastic Beanstalk sets the configuration values to the default
986
- # values associated with the specified solution stack.
1053
+ # The name of an Elastic Beanstalk solution stack (platform version) to
1054
+ # use with the environment. If specified, Elastic Beanstalk sets the
1055
+ # configuration values to the default values associated with the
1056
+ # specified solution stack. For a list of current solution stacks, see
1057
+ # [Elastic Beanstalk Supported Platforms][1] in the *AWS Elastic
1058
+ # Beanstalk Platforms* guide.
987
1059
  #
988
- # For a list of current solution stacks, see [Elastic Beanstalk
989
- # Supported Platforms][1].
1060
+ # <note markdown="1"> If you specify `SolutionStackName`, don't specify `PlatformArn` or
1061
+ # `TemplateName`.
990
1062
  #
1063
+ # </note>
991
1064
  #
992
1065
  #
993
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html
1066
+ #
1067
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html
994
1068
  #
995
1069
  # @option params [String] :platform_arn
996
- # The ARN of the platform.
1070
+ # The Amazon Resource Name (ARN) of the custom platform to use with the
1071
+ # environment. For more information, see [ Custom Platforms][1] in the
1072
+ # *AWS Elastic Beanstalk Developer Guide*.
1073
+ #
1074
+ # <note markdown="1"> If you specify `PlatformArn`, don't specify `SolutionStackName`.
1075
+ #
1076
+ # </note>
1077
+ #
1078
+ #
1079
+ #
1080
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
997
1081
  #
998
1082
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
999
1083
  # If specified, AWS Elastic Beanstalk sets the specified configuration
@@ -1207,6 +1291,10 @@ module Aws::ElasticBeanstalk
1207
1291
  # resp.platform_summary.supported_tier_list[0] #=> String
1208
1292
  # resp.platform_summary.supported_addon_list #=> Array
1209
1293
  # resp.platform_summary.supported_addon_list[0] #=> String
1294
+ # resp.platform_summary.platform_lifecycle_state #=> String
1295
+ # resp.platform_summary.platform_version #=> String
1296
+ # resp.platform_summary.platform_branch_name #=> String
1297
+ # resp.platform_summary.platform_branch_lifecycle_state #=> String
1210
1298
  # resp.builder.arn #=> String
1211
1299
  #
1212
1300
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreatePlatformVersion AWS API Documentation
@@ -1460,6 +1548,10 @@ module Aws::ElasticBeanstalk
1460
1548
  # resp.platform_summary.supported_tier_list[0] #=> String
1461
1549
  # resp.platform_summary.supported_addon_list #=> Array
1462
1550
  # resp.platform_summary.supported_addon_list[0] #=> String
1551
+ # resp.platform_summary.platform_lifecycle_state #=> String
1552
+ # resp.platform_summary.platform_version #=> String
1553
+ # resp.platform_summary.platform_branch_name #=> String
1554
+ # resp.platform_summary.platform_branch_lifecycle_state #=> String
1463
1555
  #
1464
1556
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeletePlatformVersion AWS API Documentation
1465
1557
  #
@@ -2423,7 +2515,9 @@ module Aws::ElasticBeanstalk
2423
2515
  # descriptions to those associated with this environment.
2424
2516
  #
2425
2517
  # @option params [String] :platform_arn
2426
- # The ARN of the version of the custom platform.
2518
+ # The ARN of a custom platform version. If specified, AWS Elastic
2519
+ # Beanstalk restricts the returned descriptions to those associated with
2520
+ # this custom platform version.
2427
2521
  #
2428
2522
  # @option params [String] :request_id
2429
2523
  # If specified, AWS Elastic Beanstalk restricts the described events to
@@ -2455,6 +2549,8 @@ module Aws::ElasticBeanstalk
2455
2549
  # * {Types::EventDescriptionsMessage#events #events} => Array&lt;Types::EventDescription&gt;
2456
2550
  # * {Types::EventDescriptionsMessage#next_token #next_token} => String
2457
2551
  #
2552
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2553
+ #
2458
2554
  #
2459
2555
  # @example Example: To view events for an environment
2460
2556
  #
@@ -2692,10 +2788,19 @@ module Aws::ElasticBeanstalk
2692
2788
  req.send_request(options)
2693
2789
  end
2694
2790
 
2695
- # Describes the version of the platform.
2791
+ # Describes a platform version. Provides full details. Compare to
2792
+ # ListPlatformVersions, which provides summary information about a list
2793
+ # of platform versions.
2794
+ #
2795
+ # For definitions of platform version and other platform-related terms,
2796
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
2797
+ #
2798
+ #
2799
+ #
2800
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
2696
2801
  #
2697
2802
  # @option params [String] :platform_arn
2698
- # The ARN of the version of the platform.
2803
+ # The ARN of the platform version.
2699
2804
  #
2700
2805
  # @return [Types::DescribePlatformVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2701
2806
  #
@@ -2735,6 +2840,9 @@ module Aws::ElasticBeanstalk
2735
2840
  # resp.platform_description.supported_tier_list[0] #=> String
2736
2841
  # resp.platform_description.supported_addon_list #=> Array
2737
2842
  # resp.platform_description.supported_addon_list[0] #=> String
2843
+ # resp.platform_description.platform_lifecycle_state #=> String
2844
+ # resp.platform_description.platform_branch_name #=> String
2845
+ # resp.platform_description.platform_branch_lifecycle_state #=> String
2738
2846
  #
2739
2847
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribePlatformVersion AWS API Documentation
2740
2848
  #
@@ -2822,18 +2930,133 @@ module Aws::ElasticBeanstalk
2822
2930
  req.send_request(options)
2823
2931
  end
2824
2932
 
2825
- # Lists the available platforms.
2933
+ # Lists the platform branches available for your account in an AWS
2934
+ # Region. Provides summary information about each platform branch.
2935
+ #
2936
+ # For definitions of platform branch and other platform-related terms,
2937
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
2938
+ #
2939
+ #
2940
+ #
2941
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
2942
+ #
2943
+ # @option params [Array<Types::SearchFilter>] :filters
2944
+ # Criteria for restricting the resulting list of platform branches. The
2945
+ # filter is evaluated as a logical conjunction (AND) of the separate
2946
+ # `SearchFilter` terms.
2947
+ #
2948
+ # The following list shows valid attribute values for each of the
2949
+ # `SearchFilter` terms. Most operators take a single value. The `in` and
2950
+ # `not_in` operators can take multiple values.
2951
+ #
2952
+ # * `Attribute = BranchName`\:
2953
+ #
2954
+ # * `Operator`\: `=` \| `!=` \| `begins_with` \| `ends_with` \|
2955
+ # `contains` \| `in` \| `not_in`
2956
+ #
2957
+ # ^
2958
+ #
2959
+ # * `Attribute = LifecycleState`\:
2960
+ #
2961
+ # * `Operator`\: `=` \| `!=` \| `in` \| `not_in`
2962
+ #
2963
+ # * `Values`\: `beta` \| `supported` \| `deprecated` \| `retired`
2964
+ #
2965
+ # * `Attribute = PlatformName`\:
2966
+ #
2967
+ # * `Operator`\: `=` \| `!=` \| `begins_with` \| `ends_with` \|
2968
+ # `contains` \| `in` \| `not_in`
2969
+ #
2970
+ # ^
2971
+ #
2972
+ # * `Attribute = TierType`\:
2973
+ #
2974
+ # * `Operator`\: `=` \| `!=`
2975
+ #
2976
+ # * `Values`\: `WebServer/Standard` \| `Worker/SQS/HTTP`
2977
+ #
2978
+ # Array size: limited to 10 `SearchFilter` objects.
2979
+ #
2980
+ # Within each `SearchFilter` item, the `Values` array is limited to 10
2981
+ # items.
2982
+ #
2983
+ # @option params [Integer] :max_records
2984
+ # The maximum number of platform branch values returned in one call.
2985
+ #
2986
+ # @option params [String] :next_token
2987
+ # For a paginated request. Specify a token from a previous response page
2988
+ # to retrieve the next response page. All other parameter values must be
2989
+ # identical to the ones specified in the initial request.
2990
+ #
2991
+ # If no `NextToken` is specified, the first page is retrieved.
2992
+ #
2993
+ # @return [Types::ListPlatformBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2994
+ #
2995
+ # * {Types::ListPlatformBranchesResult#platform_branch_summary_list #platform_branch_summary_list} => Array&lt;Types::PlatformBranchSummary&gt;
2996
+ # * {Types::ListPlatformBranchesResult#next_token #next_token} => String
2997
+ #
2998
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2999
+ #
3000
+ # @example Request syntax with placeholder values
3001
+ #
3002
+ # resp = client.list_platform_branches({
3003
+ # filters: [
3004
+ # {
3005
+ # attribute: "SearchFilterAttribute",
3006
+ # operator: "SearchFilterOperator",
3007
+ # values: ["SearchFilterValue"],
3008
+ # },
3009
+ # ],
3010
+ # max_records: 1,
3011
+ # next_token: "Token",
3012
+ # })
3013
+ #
3014
+ # @example Response structure
3015
+ #
3016
+ # resp.platform_branch_summary_list #=> Array
3017
+ # resp.platform_branch_summary_list[0].platform_name #=> String
3018
+ # resp.platform_branch_summary_list[0].branch_name #=> String
3019
+ # resp.platform_branch_summary_list[0].lifecycle_state #=> String
3020
+ # resp.platform_branch_summary_list[0].branch_order #=> Integer
3021
+ # resp.platform_branch_summary_list[0].supported_tier_list #=> Array
3022
+ # resp.platform_branch_summary_list[0].supported_tier_list[0] #=> String
3023
+ # resp.next_token #=> String
3024
+ #
3025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformBranches AWS API Documentation
3026
+ #
3027
+ # @overload list_platform_branches(params = {})
3028
+ # @param [Hash] params ({})
3029
+ def list_platform_branches(params = {}, options = {})
3030
+ req = build_request(:list_platform_branches, params)
3031
+ req.send_request(options)
3032
+ end
3033
+
3034
+ # Lists the platform versions available for your account in an AWS
3035
+ # Region. Provides summary information about each platform version.
3036
+ # Compare to DescribePlatformVersion, which provides full details about
3037
+ # a single platform version.
3038
+ #
3039
+ # For definitions of platform version and other platform-related terms,
3040
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
3041
+ #
3042
+ #
3043
+ #
3044
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
2826
3045
  #
2827
3046
  # @option params [Array<Types::PlatformFilter>] :filters
2828
- # List only the platforms where the platform member value relates to one
2829
- # of the supplied values.
3047
+ # Criteria for restricting the resulting list of platform versions. The
3048
+ # filter is interpreted as a logical conjunction (AND) of the separate
3049
+ # `PlatformFilter` terms.
2830
3050
  #
2831
3051
  # @option params [Integer] :max_records
2832
- # The maximum number of platform values returned in one call.
3052
+ # The maximum number of platform version values returned in one call.
2833
3053
  #
2834
3054
  # @option params [String] :next_token
2835
- # The starting index into the remaining list of platforms. Use the
2836
- # `NextToken` value from a previous `ListPlatformVersion` call.
3055
+ # For a paginated request. Specify a token from a previous response page
3056
+ # to retrieve the next response page. All other parameter values must be
3057
+ # identical to the ones specified in the initial request.
3058
+ #
3059
+ # If no `NextToken` is specified, the first page is retrieved.
2837
3060
  #
2838
3061
  # @return [Types::ListPlatformVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2839
3062
  #
@@ -2867,6 +3090,10 @@ module Aws::ElasticBeanstalk
2867
3090
  # resp.platform_summary_list[0].supported_tier_list[0] #=> String
2868
3091
  # resp.platform_summary_list[0].supported_addon_list #=> Array
2869
3092
  # resp.platform_summary_list[0].supported_addon_list[0] #=> String
3093
+ # resp.platform_summary_list[0].platform_lifecycle_state #=> String
3094
+ # resp.platform_summary_list[0].platform_version #=> String
3095
+ # resp.platform_summary_list[0].platform_branch_name #=> String
3096
+ # resp.platform_summary_list[0].platform_branch_lifecycle_state #=> String
2870
3097
  # resp.next_token #=> String
2871
3098
  #
2872
3099
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformVersions AWS API Documentation
@@ -2878,22 +3105,22 @@ module Aws::ElasticBeanstalk
2878
3105
  req.send_request(options)
2879
3106
  end
2880
3107
 
2881
- # Returns the tags applied to an AWS Elastic Beanstalk resource. The
3108
+ # Return the tags applied to an AWS Elastic Beanstalk resource. The
2882
3109
  # response contains a list of tag key-value pairs.
2883
3110
  #
2884
- # Currently, Elastic Beanstalk only supports tagging of Elastic
2885
- # Beanstalk environments. For details about environment tagging, see
2886
- # [Tagging Resources in Your Elastic Beanstalk Environment][1].
3111
+ # Elastic Beanstalk supports tagging of all of its resources. For
3112
+ # details about resource tagging, see [Tagging Application
3113
+ # Resources][1].
2887
3114
  #
2888
3115
  #
2889
3116
  #
2890
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html
3117
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html
2891
3118
  #
2892
3119
  # @option params [required, String] :resource_arn
2893
3120
  # The Amazon Resource Name (ARN) of the resouce for which a tag list is
2894
3121
  # requested.
2895
3122
  #
2896
- # Must be the ARN of an Elastic Beanstalk environment.
3123
+ # Must be the ARN of an Elastic Beanstalk resource.
2897
3124
  #
2898
3125
  # @return [Types::ResourceTagsDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2899
3126
  #
@@ -3990,9 +4217,9 @@ module Aws::ElasticBeanstalk
3990
4217
  # Two lists can be passed: `TagsToAdd` for tags to add or update, and
3991
4218
  # `TagsToRemove`.
3992
4219
  #
3993
- # Currently, Elastic Beanstalk only supports tagging of Elastic
3994
- # Beanstalk environments. For details about environment tagging, see
3995
- # [Tagging Resources in Your Elastic Beanstalk Environment][1].
4220
+ # Elastic Beanstalk supports tagging of all of its resources. For
4221
+ # details about resource tagging, see [Tagging Application
4222
+ # Resources][1].
3996
4223
  #
3997
4224
  # If you create a custom IAM user policy to control permission to this
3998
4225
  # operation, specify one of the following two virtual actions (or both)
@@ -4013,13 +4240,13 @@ module Aws::ElasticBeanstalk
4013
4240
  #
4014
4241
  #
4015
4242
  #
4016
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html
4243
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html
4017
4244
  # [2]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies
4018
4245
  #
4019
4246
  # @option params [required, String] :resource_arn
4020
4247
  # The Amazon Resource Name (ARN) of the resouce to be updated.
4021
4248
  #
4022
- # Must be the ARN of an Elastic Beanstalk environment.
4249
+ # Must be the ARN of an Elastic Beanstalk resource.
4023
4250
  #
4024
4251
  # @option params [Array<Types::Tag>] :tags_to_add
4025
4252
  # A list of tags to add or update.
@@ -4154,7 +4381,7 @@ module Aws::ElasticBeanstalk
4154
4381
  params: params,
4155
4382
  config: config)
4156
4383
  context[:gem_name] = 'aws-sdk-elasticbeanstalk'
4157
- context[:gem_version] = '1.25.0'
4384
+ context[:gem_version] = '1.30.0'
4158
4385
  Seahorse::Client::Request.new(handlers, context)
4159
4386
  end
4160
4387