aws-sdk-elasticbeanstalk 1.27.0 → 1.28.0

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 414b399834661d392021ca069c084455bf5dd98a
4
- data.tar.gz: bd8469057503233c553cb9bec4f8f903f376cdc6
3
+ metadata.gz: 05a6aa41dc737ded21cf488089cf8bc42a128f46
4
+ data.tar.gz: 2d99b7a1ab878bbf238b3b3c1957259a91b758ad
5
5
  SHA512:
6
- metadata.gz: 8806dcfb5a079346df5b3b629f9a4f37a9d6f75f226053dc73d87326cc3faaf5ac154ec6fe99eb9e52497dc2f2c273b9b27e9779477af0cafe637f1f6299b38d
7
- data.tar.gz: 8c78386ef6c2aea4b994f074f68645bde35ff14141c06d00c6286f1fa457443c6c10174e3272668e3d95baec4a7e190b8ebf95da63436fb3511e8c498fdbc6c0
6
+ metadata.gz: 79a97040474d8aa99db583c088d05025738a068653e5a7ecfbf4bd44a6389cc8dc6a90fbf4b4e33cc329bebf5a78ff2b252e042d6cc64d454f5b83b17b54a9b0
7
+ data.tar.gz: 1c3415d77e48ee8cfcb13cc812519841f91eb0cb547d7b68e5a950c1c0a791199f9b52157af9060a4ef81ff4a0d14ee32cc332f7535796f85bd816e5187d84f8
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
45
45
  # @service
46
46
  module Aws::ElasticBeanstalk
47
47
 
48
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.28.0'
49
49
 
50
50
  end
@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:elasticbeanstalk)
32
32
  module Aws::ElasticBeanstalk
33
33
  # An API client for ElasticBeanstalk. To construct a client, you need to configure a `:region` and `:credentials`.
34
34
  #
35
- # client = Aws::ElasticBeanstalk::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
35
+ # client = Aws::ElasticBeanstalk::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
40
  #
41
41
  # For details on configuring region and credentials see
42
42
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -229,15 +229,19 @@ module Aws::ElasticBeanstalk
229
229
  #
230
230
  # @option options [String] :retry_mode ("legacy")
231
231
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
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
+ #
241
245
  #
242
246
  # @option options [String] :secret_access_key
243
247
  #
@@ -265,8 +269,7 @@ module Aws::ElasticBeanstalk
265
269
  #
266
270
  # @option options [Integer] :http_read_timeout (60) The default
267
271
  # number of seconds to wait for response data. This value can
268
- # safely be set
269
- # per-request on the session yielded by {#session_for}.
272
+ # safely be set per-request on the session.
270
273
  #
271
274
  # @option options [Float] :http_idle_timeout (5) The number of
272
275
  # seconds a connection is allowed to sit idle before it is
@@ -278,7 +281,7 @@ module Aws::ElasticBeanstalk
278
281
  # request body. This option has no effect unless the request has
279
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
280
283
  # disables this behaviour. This value can safely be set per
281
- # request on the session yielded by {#session_for}.
284
+ # request on the session.
282
285
  #
283
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
284
287
  # HTTP debug output will be sent to the `:logger`.
@@ -523,17 +526,13 @@ module Aws::ElasticBeanstalk
523
526
  # `default` and no application versions.
524
527
  #
525
528
  # @option params [required, String] :application_name
526
- # The name of the application.
527
- #
528
- # Constraint: This name must be unique within your account. If the
529
- # specified name already exists, the action returns an
530
- # `InvalidParameterValue` error.
529
+ # The name of the application. Must be unique within your account.
531
530
  #
532
531
  # @option params [String] :description
533
- # Describes the application.
532
+ # Your description of the application.
534
533
  #
535
534
  # @option params [Types::ApplicationResourceLifecycleConfig] :resource_lifecycle_config
536
- # Specify an application resource lifecycle configuration to prevent
535
+ # Specifies an application resource lifecycle configuration to prevent
537
536
  # your application from accumulating too many versions.
538
537
  #
539
538
  # @option params [Array<Types::Tag>] :tags
@@ -641,8 +640,8 @@ module Aws::ElasticBeanstalk
641
640
  # Omit both `SourceBuildInformation` and `SourceBundle` to use the
642
641
  # default sample application.
643
642
  #
644
- # <note markdown="1"> Once you create an application version with a specified Amazon S3
645
- # 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
646
645
  # you change the Amazon S3 location, you receive an exception when you
647
646
  # attempt to launch an environment from the application version.
648
647
  #
@@ -661,7 +660,7 @@ module Aws::ElasticBeanstalk
661
660
  # Elastic Beanstalk returns an `InvalidParameterValue` error.
662
661
  #
663
662
  # @option params [String] :description
664
- # Describes this version.
663
+ # A description of this application version.
665
664
  #
666
665
  # @option params [Types::SourceBuildInformation] :source_build_information
667
666
  # Specify a commit in an AWS CodeCommit Git repository to use as the
@@ -802,8 +801,10 @@ module Aws::ElasticBeanstalk
802
801
  req.send_request(options)
803
802
  end
804
803
 
805
- # Creates a configuration template. Templates are associated with a
806
- # 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
807
808
  # application with the same configuration settings.
808
809
  #
809
810
  # Templates aren't associated with any environment. The
@@ -818,64 +819,80 @@ module Aws::ElasticBeanstalk
818
819
  # * ListAvailableSolutionStacks
819
820
  #
820
821
  # @option params [required, String] :application_name
821
- # The name of the application to associate with this configuration
822
- # template. If no application is found with this name, AWS Elastic
823
- # Beanstalk returns an `InvalidParameterValue` error.
822
+ # The name of the Elastic Beanstalk application to associate with this
823
+ # configuration template.
824
824
  #
825
825
  # @option params [required, String] :template_name
826
826
  # The name of the configuration template.
827
827
  #
828
828
  # Constraint: This name must be unique per application.
829
829
  #
830
- # Default: If a configuration template already exists with this name,
831
- # AWS Elastic Beanstalk returns an `InvalidParameterValue` error.
832
- #
833
830
  # @option params [String] :solution_stack_name
834
- # The name of the solution stack used by this configuration. The
835
- # solution stack specifies the operating system, architecture, and
836
- # application server for a configuration template. It determines the set
837
- # 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*.
838
838
  #
839
- # Use ListAvailableSolutionStacks to obtain a list of available solution
840
- # stacks.
839
+ # You must specify `SolutionStackName` if you don't specify
840
+ # `PlatformArn`, `EnvironmentId`, or `SourceConfiguration`.
841
+ #
842
+ # Use the [ `ListAvailableSolutionStacks` ][2] API to obtain a list of
843
+ # available solution stacks.
841
844
  #
842
- # A solution stack name or a source configuration parameter must be
843
- # specified, otherwise AWS Elastic Beanstalk returns an
844
- # `InvalidParameterValue` error.
845
845
  #
846
- # If a solution stack name is not specified and the source configuration
847
- # parameter is specified, AWS Elastic Beanstalk uses the same solution
848
- # stack as the source configuration template.
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
849
849
  #
850
850
  # @option params [String] :platform_arn
851
- # 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
852
862
  #
853
863
  # @option params [Types::SourceConfiguration] :source_configuration
854
- # If specified, AWS Elastic Beanstalk uses the configuration values from
855
- # 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.
856
867
  #
857
- # Values specified in the `OptionSettings` parameter of this call
858
- # overrides any values obtained from the `SourceConfiguration`.
868
+ # Values specified in `OptionSettings` override any values obtained from
869
+ # the `SourceConfiguration`.
859
870
  #
860
- # If no configuration template is found, returns an
861
- # `InvalidParameterValue` error.
871
+ # You must specify `SourceConfiguration` if you don't specify
872
+ # `PlatformArn`, `EnvironmentId`, or `SolutionStackName`.
862
873
  #
863
- # Constraint: If both the solution stack name parameter and the source
864
- # configuration parameters are specified, the solution stack of the
865
- # source configuration template must match the specified solution stack
866
- # name or else AWS Elastic Beanstalk returns an
867
- # `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.
868
877
  #
869
878
  # @option params [String] :environment_id
870
- # 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`.
871
882
  #
872
883
  # @option params [String] :description
873
- # Describes this configuration.
884
+ # An optional description for this configuration.
874
885
  #
875
886
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
876
- # If specified, AWS Elastic Beanstalk sets the specified configuration
877
- # option to the requested value. The new value overrides the value
878
- # 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
879
896
  #
880
897
  # @option params [Array<Types::Tag>] :tags
881
898
  # Specifies the tags applied to the configuration template.
@@ -969,28 +986,24 @@ module Aws::ElasticBeanstalk
969
986
  req.send_request(options)
970
987
  end
971
988
 
972
- # Launches an environment for the specified application using the
973
- # specified configuration.
989
+ # Launches an AWS Elastic Beanstalk environment for the specified
990
+ # application using the specified configuration.
974
991
  #
975
992
  # @option params [required, String] :application_name
976
- # The name of the application that contains the version to be deployed.
977
- #
978
- # If no application is found with this name, `CreateEnvironment` returns
979
- # an `InvalidParameterValue` error.
993
+ # The name of the application that is associated with this environment.
980
994
  #
981
995
  # @option params [String] :environment_name
982
- # A unique name for the deployment environment. Used in the application
983
- # URL.
996
+ # A unique name for the environment.
984
997
  #
985
998
  # Constraint: Must be from 4 to 40 characters in length. The name can
986
- # contain only letters, numbers, and hyphens. It cannot start or end
999
+ # contain only letters, numbers, and hyphens. It can't start or end
987
1000
  # with a hyphen. This name must be unique within a region in your
988
- # account. If the specified name already exists in the region, AWS
989
- # Elastic Beanstalk returns an `InvalidParameterValue` error.
1001
+ # account. If the specified name already exists in the region, Elastic
1002
+ # Beanstalk returns an `InvalidParameterValue` error.
990
1003
  #
991
- # Default: If the CNAME parameter is not specified, the environment name
992
- # becomes part of the CNAME, and therefore part of the visible URL for
993
- # 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.
994
1007
  #
995
1008
  # @option params [String] :group_name
996
1009
  # The name of the group to which the target environment belongs. Specify
@@ -1003,15 +1016,20 @@ module Aws::ElasticBeanstalk
1003
1016
  # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
1004
1017
  #
1005
1018
  # @option params [String] :description
1006
- # Describes this environment.
1019
+ # Your description for this environment.
1007
1020
  #
1008
1021
  # @option params [String] :cname_prefix
1009
1022
  # If specified, the environment attempts to use this value as the prefix
1010
- # for the CNAME. If not specified, the CNAME is generated automatically
1011
- # 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.
1012
1026
  #
1013
1027
  # @option params [Types::EnvironmentTier] :tier
1014
- # 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.
1015
1033
  #
1016
1034
  # @option params [Array<Types::Tag>] :tags
1017
1035
  # Specifies the tags applied to resources in the environment.
@@ -1019,32 +1037,47 @@ module Aws::ElasticBeanstalk
1019
1037
  # @option params [String] :version_label
1020
1038
  # The name of the application version to deploy.
1021
1039
  #
1022
- # If the specified application has no associated application versions,
1023
- # AWS Elastic Beanstalk `UpdateEnvironment` returns an
1024
- # `InvalidParameterValue` error.
1025
- #
1026
- # Default: If not specified, AWS Elastic Beanstalk attempts to launch
1027
- # the sample application in the container.
1040
+ # Default: If not specified, Elastic Beanstalk attempts to deploy the
1041
+ # sample application.
1028
1042
  #
1029
1043
  # @option params [String] :template_name
1030
- # The name of the configuration template to use in deployment. If no
1031
- # configuration template is found with this name, AWS Elastic Beanstalk
1032
- # 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>
1033
1051
  #
1034
1052
  # @option params [String] :solution_stack_name
1035
- # This is an alternative to specifying a template name. If specified,
1036
- # AWS Elastic Beanstalk sets the configuration values to the default
1037
- # 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.
1038
1059
  #
1039
- # For a list of current solution stacks, see [Elastic Beanstalk
1040
- # Supported Platforms][1].
1060
+ # <note markdown="1"> If you specify `SolutionStackName`, don't specify `PlatformArn` or
1061
+ # `TemplateName`.
1041
1062
  #
1063
+ # </note>
1042
1064
  #
1043
1065
  #
1044
- # [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
1045
1068
  #
1046
1069
  # @option params [String] :platform_arn
1047
- # 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
1048
1081
  #
1049
1082
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
1050
1083
  # If specified, AWS Elastic Beanstalk sets the specified configuration
@@ -1258,6 +1291,10 @@ module Aws::ElasticBeanstalk
1258
1291
  # resp.platform_summary.supported_tier_list[0] #=> String
1259
1292
  # resp.platform_summary.supported_addon_list #=> Array
1260
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
1261
1298
  # resp.builder.arn #=> String
1262
1299
  #
1263
1300
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreatePlatformVersion AWS API Documentation
@@ -1511,6 +1548,10 @@ module Aws::ElasticBeanstalk
1511
1548
  # resp.platform_summary.supported_tier_list[0] #=> String
1512
1549
  # resp.platform_summary.supported_addon_list #=> Array
1513
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
1514
1555
  #
1515
1556
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeletePlatformVersion AWS API Documentation
1516
1557
  #
@@ -2474,7 +2515,9 @@ module Aws::ElasticBeanstalk
2474
2515
  # descriptions to those associated with this environment.
2475
2516
  #
2476
2517
  # @option params [String] :platform_arn
2477
- # 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.
2478
2521
  #
2479
2522
  # @option params [String] :request_id
2480
2523
  # If specified, AWS Elastic Beanstalk restricts the described events to
@@ -2506,6 +2549,8 @@ module Aws::ElasticBeanstalk
2506
2549
  # * {Types::EventDescriptionsMessage#events #events} => Array&lt;Types::EventDescription&gt;
2507
2550
  # * {Types::EventDescriptionsMessage#next_token #next_token} => String
2508
2551
  #
2552
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2553
+ #
2509
2554
  #
2510
2555
  # @example Example: To view events for an environment
2511
2556
  #
@@ -2743,10 +2788,19 @@ module Aws::ElasticBeanstalk
2743
2788
  req.send_request(options)
2744
2789
  end
2745
2790
 
2746
- # 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
2747
2801
  #
2748
2802
  # @option params [String] :platform_arn
2749
- # The ARN of the version of the platform.
2803
+ # The ARN of the platform version.
2750
2804
  #
2751
2805
  # @return [Types::DescribePlatformVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2752
2806
  #
@@ -2786,6 +2840,9 @@ module Aws::ElasticBeanstalk
2786
2840
  # resp.platform_description.supported_tier_list[0] #=> String
2787
2841
  # resp.platform_description.supported_addon_list #=> Array
2788
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
2789
2846
  #
2790
2847
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribePlatformVersion AWS API Documentation
2791
2848
  #
@@ -2873,18 +2930,133 @@ module Aws::ElasticBeanstalk
2873
2930
  req.send_request(options)
2874
2931
  end
2875
2932
 
2876
- # 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
2877
3045
  #
2878
3046
  # @option params [Array<Types::PlatformFilter>] :filters
2879
- # List only the platforms where the platform member value relates to one
2880
- # 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.
2881
3050
  #
2882
3051
  # @option params [Integer] :max_records
2883
- # The maximum number of platform values returned in one call.
3052
+ # The maximum number of platform version values returned in one call.
2884
3053
  #
2885
3054
  # @option params [String] :next_token
2886
- # The starting index into the remaining list of platforms. Use the
2887
- # `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.
2888
3060
  #
2889
3061
  # @return [Types::ListPlatformVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2890
3062
  #
@@ -2918,6 +3090,10 @@ module Aws::ElasticBeanstalk
2918
3090
  # resp.platform_summary_list[0].supported_tier_list[0] #=> String
2919
3091
  # resp.platform_summary_list[0].supported_addon_list #=> Array
2920
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
2921
3097
  # resp.next_token #=> String
2922
3098
  #
2923
3099
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformVersions AWS API Documentation
@@ -2929,22 +3105,22 @@ module Aws::ElasticBeanstalk
2929
3105
  req.send_request(options)
2930
3106
  end
2931
3107
 
2932
- # Returns the tags applied to an AWS Elastic Beanstalk resource. The
3108
+ # Return the tags applied to an AWS Elastic Beanstalk resource. The
2933
3109
  # response contains a list of tag key-value pairs.
2934
3110
  #
2935
- # Currently, Elastic Beanstalk only supports tagging of Elastic
2936
- # Beanstalk environments. For details about environment tagging, see
2937
- # [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].
2938
3114
  #
2939
3115
  #
2940
3116
  #
2941
- # [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
2942
3118
  #
2943
3119
  # @option params [required, String] :resource_arn
2944
3120
  # The Amazon Resource Name (ARN) of the resouce for which a tag list is
2945
3121
  # requested.
2946
3122
  #
2947
- # Must be the ARN of an Elastic Beanstalk environment.
3123
+ # Must be the ARN of an Elastic Beanstalk resource.
2948
3124
  #
2949
3125
  # @return [Types::ResourceTagsDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2950
3126
  #
@@ -4041,9 +4217,9 @@ module Aws::ElasticBeanstalk
4041
4217
  # Two lists can be passed: `TagsToAdd` for tags to add or update, and
4042
4218
  # `TagsToRemove`.
4043
4219
  #
4044
- # Currently, Elastic Beanstalk only supports tagging of Elastic
4045
- # Beanstalk environments. For details about environment tagging, see
4046
- # [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].
4047
4223
  #
4048
4224
  # If you create a custom IAM user policy to control permission to this
4049
4225
  # operation, specify one of the following two virtual actions (or both)
@@ -4064,13 +4240,13 @@ module Aws::ElasticBeanstalk
4064
4240
  #
4065
4241
  #
4066
4242
  #
4067
- # [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
4068
4244
  # [2]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies
4069
4245
  #
4070
4246
  # @option params [required, String] :resource_arn
4071
4247
  # The Amazon Resource Name (ARN) of the resouce to be updated.
4072
4248
  #
4073
- # Must be the ARN of an Elastic Beanstalk environment.
4249
+ # Must be the ARN of an Elastic Beanstalk resource.
4074
4250
  #
4075
4251
  # @option params [Array<Types::Tag>] :tags_to_add
4076
4252
  # A list of tags to add or update.
@@ -4205,7 +4381,7 @@ module Aws::ElasticBeanstalk
4205
4381
  params: params,
4206
4382
  config: config)
4207
4383
  context[:gem_name] = 'aws-sdk-elasticbeanstalk'
4208
- context[:gem_version] = '1.27.0'
4384
+ context[:gem_version] = '1.28.0'
4209
4385
  Seahorse::Client::Request.new(handlers, context)
4210
4386
  end
4211
4387