aws-sdk-proton 1.0.0 → 1.4.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 +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-proton.rb +2 -1
- data/lib/aws-sdk-proton/client.rb +244 -65
- data/lib/aws-sdk-proton/client_api.rb +4 -1
- data/lib/aws-sdk-proton/types.rb +51 -50
- data/lib/aws-sdk-proton/waiters.rb +484 -0
- metadata +5 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 617d46e5b620d95ede0388f0e74a60adb622260a44432870221b81ff2b32e80e
|
|
4
|
+
data.tar.gz: 94ca48109475f3c6953e48b83ae95e4266c828f1af7ee48f1ceb538b4dfbc577
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ff8a6f15fff1931ae5743bc46916311a42edc627d332f3ff6657d4c1905acacd8fed2925c319dcb19d4b3df724bf520a1343f1df24117fbcb260ee59d12d1fbd
|
|
7
|
+
data.tar.gz: 11afca972c6897661683026d1004fa04aafdf32db9531ab778852a229eb7a07345f2a27f2130fafd3f5d8e6d653b48068ce9ba7516a8dffd05088ad94b8a5b09
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.4.0 (2021-07-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.3.0 (2021-07-26)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Documentation-only update links
|
|
13
|
+
|
|
14
|
+
1.2.0 (2021-07-21)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Documentation updates for AWS Proton
|
|
18
|
+
|
|
19
|
+
1.1.0 (2021-06-25)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Added waiters for template registration, service operations, and environment deployments.
|
|
23
|
+
|
|
4
24
|
1.0.0 (2021-06-09)
|
|
5
25
|
------------------
|
|
6
26
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.4.0
|
data/lib/aws-sdk-proton.rb
CHANGED
|
@@ -15,6 +15,7 @@ require_relative 'aws-sdk-proton/types'
|
|
|
15
15
|
require_relative 'aws-sdk-proton/client_api'
|
|
16
16
|
require_relative 'aws-sdk-proton/client'
|
|
17
17
|
require_relative 'aws-sdk-proton/errors'
|
|
18
|
+
require_relative 'aws-sdk-proton/waiters'
|
|
18
19
|
require_relative 'aws-sdk-proton/resource'
|
|
19
20
|
require_relative 'aws-sdk-proton/customizations'
|
|
20
21
|
|
|
@@ -48,6 +49,6 @@ require_relative 'aws-sdk-proton/customizations'
|
|
|
48
49
|
# @!group service
|
|
49
50
|
module Aws::Proton
|
|
50
51
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
52
|
+
GEM_VERSION = '1.4.0'
|
|
52
53
|
|
|
53
54
|
end
|
|
@@ -342,9 +342,12 @@ module Aws::Proton
|
|
|
342
342
|
# AWS Proton can use the associated IAM role to provision environment
|
|
343
343
|
# infrastructure resources in the associated environment account.
|
|
344
344
|
#
|
|
345
|
-
# For more information, see [Environment account
|
|
346
|
-
#
|
|
347
|
-
#
|
|
345
|
+
# For more information, see [Environment account connections][1] in the
|
|
346
|
+
# *AWS Proton Administrator guide*.
|
|
347
|
+
#
|
|
348
|
+
#
|
|
349
|
+
#
|
|
350
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
348
351
|
#
|
|
349
352
|
# @option params [required, String] :id
|
|
350
353
|
# The ID of the environment account connection.
|
|
@@ -382,7 +385,7 @@ module Aws::Proton
|
|
|
382
385
|
|
|
383
386
|
# Attempts to cancel an environment deployment on an UpdateEnvironment
|
|
384
387
|
# action, if the deployment is `IN_PROGRESS`. For more information, see
|
|
385
|
-
# [Update an environment][1] in the *AWS Proton
|
|
388
|
+
# [Update an environment][1] in the *AWS Proton Administrator guide*.
|
|
386
389
|
#
|
|
387
390
|
# The following list includes potential cancellation scenarios.
|
|
388
391
|
#
|
|
@@ -444,7 +447,7 @@ module Aws::Proton
|
|
|
444
447
|
# Attempts to cancel a service instance deployment on an
|
|
445
448
|
# UpdateServiceInstance action, if the deployment is `IN_PROGRESS`. For
|
|
446
449
|
# more information, see *Update a service instance* in the [AWS Proton
|
|
447
|
-
#
|
|
450
|
+
# Administrator guide][1] or the [AWS Proton User guide][2].
|
|
448
451
|
#
|
|
449
452
|
# The following list includes potential cancellation scenarios.
|
|
450
453
|
#
|
|
@@ -509,7 +512,7 @@ module Aws::Proton
|
|
|
509
512
|
# Attempts to cancel a service pipeline deployment on an
|
|
510
513
|
# UpdateServicePipeline action, if the deployment is `IN_PROGRESS`. For
|
|
511
514
|
# more information, see *Update a service pipeline* in the [AWS Proton
|
|
512
|
-
#
|
|
515
|
+
# Administrator guide][1] or the [AWS Proton User guide][2].
|
|
513
516
|
#
|
|
514
517
|
# The following list includes potential cancellation scenarios.
|
|
515
518
|
#
|
|
@@ -567,7 +570,7 @@ module Aws::Proton
|
|
|
567
570
|
# Deploy a new environment. An AWS Proton environment is created from an
|
|
568
571
|
# environment template that defines infrastructure and resources that
|
|
569
572
|
# can be shared across services. For more information, see the
|
|
570
|
-
# [Environments][1] in the *AWS Proton
|
|
573
|
+
# [Environments][1] in the *AWS Proton Administrator Guide.*
|
|
571
574
|
#
|
|
572
575
|
#
|
|
573
576
|
#
|
|
@@ -582,8 +585,11 @@ module Aws::Proton
|
|
|
582
585
|
# environment account. You must include either the
|
|
583
586
|
# `environmentAccountConnectionId` or `protonServiceRoleArn` parameter
|
|
584
587
|
# and value. For more information, see [Environment account
|
|
585
|
-
# connections]
|
|
586
|
-
#
|
|
588
|
+
# connections][1] in the *AWS Proton Administrator guide*.
|
|
589
|
+
#
|
|
590
|
+
#
|
|
591
|
+
#
|
|
592
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
587
593
|
#
|
|
588
594
|
# @option params [required, String] :name
|
|
589
595
|
# The name of the environment.
|
|
@@ -597,15 +603,15 @@ module Aws::Proton
|
|
|
597
603
|
# @option params [required, String] :spec
|
|
598
604
|
# A link to a YAML formatted spec file that provides inputs as defined
|
|
599
605
|
# in the environment template bundle schema file. For more information,
|
|
600
|
-
# see [Environments][1] in the *AWS Proton
|
|
606
|
+
# see [Environments][1] in the *AWS Proton Administrator Guide*.
|
|
601
607
|
#
|
|
602
608
|
#
|
|
603
609
|
#
|
|
604
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-
|
|
610
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html
|
|
605
611
|
#
|
|
606
612
|
# @option params [Array<Types::Tag>] :tags
|
|
607
613
|
# Create tags for your environment. For more information, see *AWS
|
|
608
|
-
# Proton resources and tagging* in the [AWS Proton
|
|
614
|
+
# Proton resources and tagging* in the [AWS Proton Administrator
|
|
609
615
|
# Guide][1] or [AWS Proton User Guide][2].
|
|
610
616
|
#
|
|
611
617
|
#
|
|
@@ -621,11 +627,11 @@ module Aws::Proton
|
|
|
621
627
|
#
|
|
622
628
|
# @option params [required, String] :template_name
|
|
623
629
|
# The name of the environment template. For more information, see
|
|
624
|
-
# [Environment Templates][1] in the *AWS Proton
|
|
630
|
+
# [Environment Templates][1] in the *AWS Proton Administrator Guide*.
|
|
625
631
|
#
|
|
626
632
|
#
|
|
627
633
|
#
|
|
628
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-
|
|
634
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-templates.html
|
|
629
635
|
#
|
|
630
636
|
# @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
631
637
|
#
|
|
@@ -680,14 +686,17 @@ module Aws::Proton
|
|
|
680
686
|
|
|
681
687
|
# Create an environment account connection in an environment account so
|
|
682
688
|
# that environment infrastructure resources can be provisioned in the
|
|
683
|
-
# environment account from
|
|
689
|
+
# environment account from a management account.
|
|
684
690
|
#
|
|
685
691
|
# An environment account connection is a secure bi-directional
|
|
686
692
|
# connection between a *management account* and an *environment account*
|
|
687
693
|
# that maintains authorization and permissions. For more information,
|
|
688
|
-
# see [Environment account
|
|
689
|
-
#
|
|
690
|
-
#
|
|
694
|
+
# see [Environment account connections][1] in the *AWS Proton
|
|
695
|
+
# Administrator guide*.
|
|
696
|
+
#
|
|
697
|
+
#
|
|
698
|
+
#
|
|
699
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
691
700
|
#
|
|
692
701
|
# @option params [String] :client_token
|
|
693
702
|
# When included, if two identicial requests are made with the same
|
|
@@ -749,7 +758,7 @@ module Aws::Proton
|
|
|
749
758
|
end
|
|
750
759
|
|
|
751
760
|
# Create an environment template for AWS Proton. For more information,
|
|
752
|
-
# see [Environment Templates][1] in the *AWS Proton
|
|
761
|
+
# see [Environment Templates][1] in the *AWS Proton Administrator
|
|
753
762
|
# Guide*.
|
|
754
763
|
#
|
|
755
764
|
# You can create an environment template in one of the two following
|
|
@@ -766,12 +775,12 @@ module Aws::Proton
|
|
|
766
775
|
# provisioned and managed infrastructure, include the `provisioning`
|
|
767
776
|
# parameter and set the value to `CUSTOMER_MANAGED`. For more
|
|
768
777
|
# information, see [Register and publish an environment template][2]
|
|
769
|
-
# in the *AWS Proton
|
|
778
|
+
# in the *AWS Proton Administrator Guide*.
|
|
770
779
|
#
|
|
771
780
|
#
|
|
772
781
|
#
|
|
773
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-
|
|
774
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/adminguide/
|
|
782
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-templates.html
|
|
783
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/adminguide/template-create.html
|
|
775
784
|
#
|
|
776
785
|
# @option params [String] :description
|
|
777
786
|
# A description of the environment template.
|
|
@@ -792,7 +801,7 @@ module Aws::Proton
|
|
|
792
801
|
#
|
|
793
802
|
# @option params [Array<Types::Tag>] :tags
|
|
794
803
|
# Create tags for your environment template. For more information, see
|
|
795
|
-
# *AWS Proton resources and tagging* in the [AWS Proton
|
|
804
|
+
# *AWS Proton resources and tagging* in the [AWS Proton Administrator
|
|
796
805
|
# Guide][1] or [AWS Proton User Guide][2].
|
|
797
806
|
#
|
|
798
807
|
#
|
|
@@ -862,7 +871,7 @@ module Aws::Proton
|
|
|
862
871
|
# `majorVersion`.
|
|
863
872
|
#
|
|
864
873
|
# To create a new major and minor version of the environment template,
|
|
865
|
-
# exclude `majorVersion`.
|
|
874
|
+
# *exclude* `majorVersion`.
|
|
866
875
|
#
|
|
867
876
|
# @option params [required, Types::TemplateVersionSourceInput] :source
|
|
868
877
|
# An object that includes the template bundle S3 bucket path and name
|
|
@@ -925,7 +934,7 @@ module Aws::Proton
|
|
|
925
934
|
# Create an AWS Proton service. An AWS Proton service is an
|
|
926
935
|
# instantiation of a service template and often includes several service
|
|
927
936
|
# instances and pipeline. For more information, see [Services][1] in the
|
|
928
|
-
# *AWS Proton
|
|
937
|
+
# *AWS Proton Administrator Guide* and [Services][2] in the *AWS Proton
|
|
929
938
|
# User Guide*.
|
|
930
939
|
#
|
|
931
940
|
#
|
|
@@ -945,16 +954,16 @@ module Aws::Proton
|
|
|
945
954
|
# The service name.
|
|
946
955
|
#
|
|
947
956
|
# @option params [String] :repository_connection_arn
|
|
948
|
-
# The ARN of the repository connection. For more
|
|
949
|
-
# up repository connection][1] in the *AWS Proton
|
|
950
|
-
# and [
|
|
951
|
-
# include this parameter if your service
|
|
952
|
-
# service pipeline.
|
|
957
|
+
# The Amazon Resource Name (ARN) of the repository connection. For more
|
|
958
|
+
# information, see [Set up repository connection][1] in the *AWS Proton
|
|
959
|
+
# Administrator Guide* and [Setting up with AWS Proton][2] in the *AWS
|
|
960
|
+
# Proton User Guide*. *Don't* include this parameter if your service
|
|
961
|
+
# template *doesn't* include a service pipeline.
|
|
953
962
|
#
|
|
954
963
|
#
|
|
955
964
|
#
|
|
956
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#
|
|
957
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/
|
|
965
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol
|
|
966
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection
|
|
958
967
|
#
|
|
959
968
|
# @option params [String] :repository_id
|
|
960
969
|
# The ID of the code repository. *Don't* include this parameter if your
|
|
@@ -963,9 +972,9 @@ module Aws::Proton
|
|
|
963
972
|
# @option params [required, String] :spec
|
|
964
973
|
# A link to a spec file that provides inputs as defined in the service
|
|
965
974
|
# template bundle schema file. The spec file is in YAML format. Don’t
|
|
966
|
-
# include pipeline inputs in the spec if your service template doesn’t
|
|
975
|
+
# include pipeline inputs in the spec if your service template *doesn’t*
|
|
967
976
|
# include a service pipeline. For more information, see [Create a
|
|
968
|
-
# service][1] in the *AWS Proton
|
|
977
|
+
# service][1] in the *AWS Proton Administrator Guide* and [Create a
|
|
969
978
|
# service][2] in the *AWS Proton User Guide*.
|
|
970
979
|
#
|
|
971
980
|
#
|
|
@@ -975,7 +984,7 @@ module Aws::Proton
|
|
|
975
984
|
#
|
|
976
985
|
# @option params [Array<Types::Tag>] :tags
|
|
977
986
|
# Create tags for your service. For more information, see *AWS Proton
|
|
978
|
-
# resources and tagging* in the [AWS Proton
|
|
987
|
+
# resources and tagging* in the [AWS Proton Administrator Guide][1] or
|
|
979
988
|
# [AWS Proton User Guide][2].
|
|
980
989
|
#
|
|
981
990
|
#
|
|
@@ -1059,7 +1068,7 @@ module Aws::Proton
|
|
|
1059
1068
|
# pipeline definition, they provide a link to their source code
|
|
1060
1069
|
# repository. AWS Proton then deploys and manages the infrastructure
|
|
1061
1070
|
# defined by the selected service template. For more information, see
|
|
1062
|
-
# [Service Templates][1] in the *AWS Proton
|
|
1071
|
+
# [Service Templates][1] in the *AWS Proton Administrator Guide*.
|
|
1063
1072
|
#
|
|
1064
1073
|
#
|
|
1065
1074
|
#
|
|
@@ -1083,15 +1092,15 @@ module Aws::Proton
|
|
|
1083
1092
|
# When included, this parameter indicates that an AWS Proton service
|
|
1084
1093
|
# pipeline *won't* be included for your service. Once specified, this
|
|
1085
1094
|
# parameter *can't* be changed. For more information, see [Service
|
|
1086
|
-
# template bundles][1] in the *AWS Proton
|
|
1095
|
+
# template bundles][1] in the *AWS Proton Administrator Guide*.
|
|
1087
1096
|
#
|
|
1088
1097
|
#
|
|
1089
1098
|
#
|
|
1090
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-
|
|
1099
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html
|
|
1091
1100
|
#
|
|
1092
1101
|
# @option params [Array<Types::Tag>] :tags
|
|
1093
1102
|
# Create tags for your service template. For more information, see *AWS
|
|
1094
|
-
# Proton resources and tagging* in the [AWS Proton
|
|
1103
|
+
# Proton resources and tagging* in the [AWS Proton Administrator
|
|
1095
1104
|
# Guide][1] or [AWS Proton User Guide][2].
|
|
1096
1105
|
#
|
|
1097
1106
|
#
|
|
@@ -1286,9 +1295,12 @@ module Aws::Proton
|
|
|
1286
1295
|
# You're responsible for cleaning up provisioned resources that remain
|
|
1287
1296
|
# without an environment connection.
|
|
1288
1297
|
#
|
|
1289
|
-
# For more information, see [Environment account
|
|
1290
|
-
#
|
|
1291
|
-
#
|
|
1298
|
+
# For more information, see [Environment account connections][1] in the
|
|
1299
|
+
# *AWS Proton Administrator guide*.
|
|
1300
|
+
#
|
|
1301
|
+
#
|
|
1302
|
+
#
|
|
1303
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
1292
1304
|
#
|
|
1293
1305
|
# @option params [required, String] :id
|
|
1294
1306
|
# The ID of the environment account connection to delete.
|
|
@@ -1617,6 +1629,11 @@ module Aws::Proton
|
|
|
1617
1629
|
# resp.environment.template_minor_version #=> String
|
|
1618
1630
|
# resp.environment.template_name #=> String
|
|
1619
1631
|
#
|
|
1632
|
+
#
|
|
1633
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1634
|
+
#
|
|
1635
|
+
# * environment_deployed
|
|
1636
|
+
#
|
|
1620
1637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironment AWS API Documentation
|
|
1621
1638
|
#
|
|
1622
1639
|
# @overload get_environment(params = {})
|
|
@@ -1629,9 +1646,12 @@ module Aws::Proton
|
|
|
1629
1646
|
# In an environment account, view the detail data for an environment
|
|
1630
1647
|
# account connection.
|
|
1631
1648
|
#
|
|
1632
|
-
# For more information, see [Environment account
|
|
1633
|
-
#
|
|
1634
|
-
#
|
|
1649
|
+
# For more information, see [Environment account connections][1] in the
|
|
1650
|
+
# *AWS Proton Administrator guide*.
|
|
1651
|
+
#
|
|
1652
|
+
#
|
|
1653
|
+
#
|
|
1654
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
1635
1655
|
#
|
|
1636
1656
|
# @option params [required, String] :id
|
|
1637
1657
|
# The ID of the environment account connection.
|
|
@@ -1744,6 +1764,11 @@ module Aws::Proton
|
|
|
1744
1764
|
# resp.environment_template_version.status_message #=> String
|
|
1745
1765
|
# resp.environment_template_version.template_name #=> String
|
|
1746
1766
|
#
|
|
1767
|
+
#
|
|
1768
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1769
|
+
#
|
|
1770
|
+
# * environment_template_version_registered
|
|
1771
|
+
#
|
|
1747
1772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersion AWS API Documentation
|
|
1748
1773
|
#
|
|
1749
1774
|
# @overload get_environment_template_version(params = {})
|
|
@@ -1793,6 +1818,14 @@ module Aws::Proton
|
|
|
1793
1818
|
# resp.service.status_message #=> String
|
|
1794
1819
|
# resp.service.template_name #=> String
|
|
1795
1820
|
#
|
|
1821
|
+
#
|
|
1822
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1823
|
+
#
|
|
1824
|
+
# * service_created
|
|
1825
|
+
# * service_deleted
|
|
1826
|
+
# * service_pipeline_deployed
|
|
1827
|
+
# * service_updated
|
|
1828
|
+
#
|
|
1796
1829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetService AWS API Documentation
|
|
1797
1830
|
#
|
|
1798
1831
|
# @overload get_service(params = {})
|
|
@@ -1840,6 +1873,11 @@ module Aws::Proton
|
|
|
1840
1873
|
# resp.service_instance.template_minor_version #=> String
|
|
1841
1874
|
# resp.service_instance.template_name #=> String
|
|
1842
1875
|
#
|
|
1876
|
+
#
|
|
1877
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1878
|
+
#
|
|
1879
|
+
# * service_instance_deployed
|
|
1880
|
+
#
|
|
1843
1881
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstance AWS API Documentation
|
|
1844
1882
|
#
|
|
1845
1883
|
# @overload get_service_instance(params = {})
|
|
@@ -1927,6 +1965,11 @@ module Aws::Proton
|
|
|
1927
1965
|
# resp.service_template_version.status_message #=> String
|
|
1928
1966
|
# resp.service_template_version.template_name #=> String
|
|
1929
1967
|
#
|
|
1968
|
+
#
|
|
1969
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
1970
|
+
#
|
|
1971
|
+
# * service_template_version_registered
|
|
1972
|
+
#
|
|
1930
1973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersion AWS API Documentation
|
|
1931
1974
|
#
|
|
1932
1975
|
# @overload get_service_template_version(params = {})
|
|
@@ -1938,9 +1981,12 @@ module Aws::Proton
|
|
|
1938
1981
|
|
|
1939
1982
|
# View a list of environment account connections.
|
|
1940
1983
|
#
|
|
1941
|
-
# For more information, see [Environment account
|
|
1942
|
-
#
|
|
1943
|
-
#
|
|
1984
|
+
# For more information, see [Environment account connections][1] in the
|
|
1985
|
+
# *AWS Proton Administrator guide*.
|
|
1986
|
+
#
|
|
1987
|
+
#
|
|
1988
|
+
#
|
|
1989
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
1944
1990
|
#
|
|
1945
1991
|
# @option params [String] :environment_name
|
|
1946
1992
|
# The environment name that's associated with each listed environment
|
|
@@ -2378,7 +2424,7 @@ module Aws::Proton
|
|
|
2378
2424
|
end
|
|
2379
2425
|
|
|
2380
2426
|
# List tags for a resource. For more information, see *AWS Proton
|
|
2381
|
-
# resources and tagging* in the [AWS Proton
|
|
2427
|
+
# resources and tagging* in the [AWS Proton Administrator Guide][1] or
|
|
2382
2428
|
# [AWS Proton User Guide][2].
|
|
2383
2429
|
#
|
|
2384
2430
|
#
|
|
@@ -2395,7 +2441,7 @@ module Aws::Proton
|
|
|
2395
2441
|
# requested.
|
|
2396
2442
|
#
|
|
2397
2443
|
# @option params [required, String] :resource_arn
|
|
2398
|
-
# The ARN of the resource for the listed tags.
|
|
2444
|
+
# The Amazon Resource Name (ARN) of the resource for the listed tags.
|
|
2399
2445
|
#
|
|
2400
2446
|
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2401
2447
|
#
|
|
@@ -2438,9 +2484,12 @@ module Aws::Proton
|
|
|
2438
2484
|
# You *can’t* reject an environment account connection that is connected
|
|
2439
2485
|
# to an environment.
|
|
2440
2486
|
#
|
|
2441
|
-
# For more information, see [Environment account
|
|
2442
|
-
#
|
|
2443
|
-
#
|
|
2487
|
+
# For more information, see [Environment account connections][1] in the
|
|
2488
|
+
# *AWS Proton Administrator guide*.
|
|
2489
|
+
#
|
|
2490
|
+
#
|
|
2491
|
+
#
|
|
2492
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
2444
2493
|
#
|
|
2445
2494
|
# @option params [required, String] :id
|
|
2446
2495
|
# The ID of the environment account connection to reject.
|
|
@@ -2477,7 +2526,7 @@ module Aws::Proton
|
|
|
2477
2526
|
end
|
|
2478
2527
|
|
|
2479
2528
|
# Tag a resource. For more information, see *AWS Proton resources and
|
|
2480
|
-
# tagging* in the [AWS Proton
|
|
2529
|
+
# tagging* in the [AWS Proton Administrator Guide][1] or [AWS Proton
|
|
2481
2530
|
# User Guide][2].
|
|
2482
2531
|
#
|
|
2483
2532
|
#
|
|
@@ -2516,7 +2565,7 @@ module Aws::Proton
|
|
|
2516
2565
|
end
|
|
2517
2566
|
|
|
2518
2567
|
# Remove a tag from a resource. For more information, see *AWS Proton
|
|
2519
|
-
# resources and tagging* in the [AWS Proton
|
|
2568
|
+
# resources and tagging* in the [AWS Proton Administrator Guide][1] or
|
|
2520
2569
|
# [AWS Proton User Guide][2].
|
|
2521
2570
|
#
|
|
2522
2571
|
#
|
|
@@ -2587,7 +2636,7 @@ module Aws::Proton
|
|
|
2587
2636
|
#
|
|
2588
2637
|
# You can only update to a new environment account connection if it was
|
|
2589
2638
|
# created in the same environment account that the current environment
|
|
2590
|
-
# account connection was created in and associated with the current
|
|
2639
|
+
# account connection was created in and is associated with the current
|
|
2591
2640
|
# environment.
|
|
2592
2641
|
#
|
|
2593
2642
|
# If the environment *isn't* associated with an environment account
|
|
@@ -2683,15 +2732,15 @@ module Aws::Proton
|
|
|
2683
2732
|
#
|
|
2684
2733
|
# You can only update to a new environment account connection if it was
|
|
2685
2734
|
# created in the same environment account that the current environment
|
|
2686
|
-
# account connection was created in and associated with the current
|
|
2735
|
+
# account connection was created in and is associated with the current
|
|
2687
2736
|
# environment.
|
|
2688
2737
|
#
|
|
2689
2738
|
# @option params [required, String] :name
|
|
2690
2739
|
# The name of the environment to update.
|
|
2691
2740
|
#
|
|
2692
2741
|
# @option params [String] :proton_service_role_arn
|
|
2693
|
-
# The ARN of the AWS Proton service role that
|
|
2694
|
-
# API calls to other services your behalf.
|
|
2742
|
+
# The Amazon Resource Name (ARN) of the AWS Proton service role that
|
|
2743
|
+
# allows AWS Proton to make API calls to other services your behalf.
|
|
2695
2744
|
#
|
|
2696
2745
|
# @option params [String] :spec
|
|
2697
2746
|
# The formatted specification that defines the update.
|
|
@@ -2750,9 +2799,12 @@ module Aws::Proton
|
|
|
2750
2799
|
# In an environment account, update an environment account connection to
|
|
2751
2800
|
# use a new IAM role.
|
|
2752
2801
|
#
|
|
2753
|
-
# For more information, see [Environment account
|
|
2754
|
-
#
|
|
2755
|
-
#
|
|
2802
|
+
# For more information, see [Environment account connections][1] in the
|
|
2803
|
+
# *AWS Proton Administrator guide*.
|
|
2804
|
+
#
|
|
2805
|
+
#
|
|
2806
|
+
#
|
|
2807
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html
|
|
2756
2808
|
#
|
|
2757
2809
|
# @option params [required, String] :id
|
|
2758
2810
|
# The ID of the environment account connection to update.
|
|
@@ -2917,7 +2969,7 @@ module Aws::Proton
|
|
|
2917
2969
|
# to remain. Omit the existing service instances to delete from the
|
|
2918
2970
|
# list. *Don't* include edits to the existing service instances or
|
|
2919
2971
|
# pipeline. For more information, see *Edit a service* in the [AWS
|
|
2920
|
-
# Proton
|
|
2972
|
+
# Proton Administrator Guide][1] or the [AWS Proton User Guide][2].
|
|
2921
2973
|
#
|
|
2922
2974
|
#
|
|
2923
2975
|
#
|
|
@@ -3364,14 +3416,141 @@ module Aws::Proton
|
|
|
3364
3416
|
params: params,
|
|
3365
3417
|
config: config)
|
|
3366
3418
|
context[:gem_name] = 'aws-sdk-proton'
|
|
3367
|
-
context[:gem_version] = '1.
|
|
3419
|
+
context[:gem_version] = '1.4.0'
|
|
3368
3420
|
Seahorse::Client::Request.new(handlers, context)
|
|
3369
3421
|
end
|
|
3370
3422
|
|
|
3423
|
+
# Polls an API operation until a resource enters a desired state.
|
|
3424
|
+
#
|
|
3425
|
+
# ## Basic Usage
|
|
3426
|
+
#
|
|
3427
|
+
# A waiter will call an API operation until:
|
|
3428
|
+
#
|
|
3429
|
+
# * It is successful
|
|
3430
|
+
# * It enters a terminal state
|
|
3431
|
+
# * It makes the maximum number of attempts
|
|
3432
|
+
#
|
|
3433
|
+
# In between attempts, the waiter will sleep.
|
|
3434
|
+
#
|
|
3435
|
+
# # polls in a loop, sleeping between attempts
|
|
3436
|
+
# client.wait_until(waiter_name, params)
|
|
3437
|
+
#
|
|
3438
|
+
# ## Configuration
|
|
3439
|
+
#
|
|
3440
|
+
# You can configure the maximum number of polling attempts, and the
|
|
3441
|
+
# delay (in seconds) between each polling attempt. You can pass
|
|
3442
|
+
# configuration as the final arguments hash.
|
|
3443
|
+
#
|
|
3444
|
+
# # poll for ~25 seconds
|
|
3445
|
+
# client.wait_until(waiter_name, params, {
|
|
3446
|
+
# max_attempts: 5,
|
|
3447
|
+
# delay: 5,
|
|
3448
|
+
# })
|
|
3449
|
+
#
|
|
3450
|
+
# ## Callbacks
|
|
3451
|
+
#
|
|
3452
|
+
# You can be notified before each polling attempt and before each
|
|
3453
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
|
3454
|
+
# it will terminate the waiter.
|
|
3455
|
+
#
|
|
3456
|
+
# started_at = Time.now
|
|
3457
|
+
# client.wait_until(waiter_name, params, {
|
|
3458
|
+
#
|
|
3459
|
+
# # disable max attempts
|
|
3460
|
+
# max_attempts: nil,
|
|
3461
|
+
#
|
|
3462
|
+
# # poll for 1 hour, instead of a number of attempts
|
|
3463
|
+
# before_wait: -> (attempts, response) do
|
|
3464
|
+
# throw :failure if Time.now - started_at > 3600
|
|
3465
|
+
# end
|
|
3466
|
+
# })
|
|
3467
|
+
#
|
|
3468
|
+
# ## Handling Errors
|
|
3469
|
+
#
|
|
3470
|
+
# When a waiter is unsuccessful, it will raise an error.
|
|
3471
|
+
# All of the failure errors extend from
|
|
3472
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
|
3473
|
+
#
|
|
3474
|
+
# begin
|
|
3475
|
+
# client.wait_until(...)
|
|
3476
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
|
3477
|
+
# # resource did not enter the desired state in time
|
|
3478
|
+
# end
|
|
3479
|
+
#
|
|
3480
|
+
# ## Valid Waiters
|
|
3481
|
+
#
|
|
3482
|
+
# The following table lists the valid waiter names, the operations they call,
|
|
3483
|
+
# and the default `:delay` and `:max_attempts` values.
|
|
3484
|
+
#
|
|
3485
|
+
# | waiter_name | params | :delay | :max_attempts |
|
|
3486
|
+
# | --------------------------------------- | ----------------------------------------- | -------- | ------------- |
|
|
3487
|
+
# | environment_deployed | {Client#get_environment} | 5 | 999 |
|
|
3488
|
+
# | environment_template_version_registered | {Client#get_environment_template_version} | 2 | 150 |
|
|
3489
|
+
# | service_created | {Client#get_service} | 5 | 999 |
|
|
3490
|
+
# | service_deleted | {Client#get_service} | 5 | 999 |
|
|
3491
|
+
# | service_instance_deployed | {Client#get_service_instance} | 5 | 999 |
|
|
3492
|
+
# | service_pipeline_deployed | {Client#get_service} | 10 | 360 |
|
|
3493
|
+
# | service_template_version_registered | {Client#get_service_template_version} | 2 | 150 |
|
|
3494
|
+
# | service_updated | {Client#get_service} | 5 | 999 |
|
|
3495
|
+
#
|
|
3496
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
|
3497
|
+
# because the waiter has entered a state that it will not transition
|
|
3498
|
+
# out of, preventing success.
|
|
3499
|
+
#
|
|
3500
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
|
3501
|
+
# maximum number of attempts have been made, and the waiter is not
|
|
3502
|
+
# yet successful.
|
|
3503
|
+
#
|
|
3504
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
|
3505
|
+
# while polling for a resource that is not expected.
|
|
3506
|
+
#
|
|
3507
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
|
3508
|
+
# for an unknown state.
|
|
3509
|
+
#
|
|
3510
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
|
3511
|
+
# @param [Symbol] waiter_name
|
|
3512
|
+
# @param [Hash] params ({})
|
|
3513
|
+
# @param [Hash] options ({})
|
|
3514
|
+
# @option options [Integer] :max_attempts
|
|
3515
|
+
# @option options [Integer] :delay
|
|
3516
|
+
# @option options [Proc] :before_attempt
|
|
3517
|
+
# @option options [Proc] :before_wait
|
|
3518
|
+
def wait_until(waiter_name, params = {}, options = {})
|
|
3519
|
+
w = waiter(waiter_name, options)
|
|
3520
|
+
yield(w.waiter) if block_given? # deprecated
|
|
3521
|
+
w.wait(params)
|
|
3522
|
+
end
|
|
3523
|
+
|
|
3371
3524
|
# @api private
|
|
3372
3525
|
# @deprecated
|
|
3373
3526
|
def waiter_names
|
|
3374
|
-
|
|
3527
|
+
waiters.keys
|
|
3528
|
+
end
|
|
3529
|
+
|
|
3530
|
+
private
|
|
3531
|
+
|
|
3532
|
+
# @param [Symbol] waiter_name
|
|
3533
|
+
# @param [Hash] options ({})
|
|
3534
|
+
def waiter(waiter_name, options = {})
|
|
3535
|
+
waiter_class = waiters[waiter_name]
|
|
3536
|
+
if waiter_class
|
|
3537
|
+
waiter_class.new(options.merge(client: self))
|
|
3538
|
+
else
|
|
3539
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
|
3540
|
+
end
|
|
3541
|
+
end
|
|
3542
|
+
|
|
3543
|
+
def waiters
|
|
3544
|
+
{
|
|
3545
|
+
environment_deployed: Waiters::EnvironmentDeployed,
|
|
3546
|
+
environment_template_version_registered: Waiters::EnvironmentTemplateVersionRegistered,
|
|
3547
|
+
service_created: Waiters::ServiceCreated,
|
|
3548
|
+
service_deleted: Waiters::ServiceDeleted,
|
|
3549
|
+
service_instance_deployed: Waiters::ServiceInstanceDeployed,
|
|
3550
|
+
service_pipeline_deployed: Waiters::ServicePipelineDeployed,
|
|
3551
|
+
service_template_version_registered: Waiters::ServiceTemplateVersionRegistered,
|
|
3552
|
+
service_updated: Waiters::ServiceUpdated
|
|
3553
|
+
}
|
|
3375
3554
|
end
|
|
3376
3555
|
|
|
3377
3556
|
class << self
|