aws-sdk-appconfig 1.23.0 → 1.26.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-appconfig/client.rb +664 -27
- data/lib/aws-sdk-appconfig/client_api.rb +296 -4
- data/lib/aws-sdk-appconfig/types.rb +788 -7
- data/lib/aws-sdk-appconfig.rb +1 -1
- metadata +4 -4
@@ -10,6 +10,121 @@
|
|
10
10
|
module Aws::AppConfig
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An action defines the tasks the extension performs during the
|
14
|
+
# AppConfig workflow. Each action includes an action point such as
|
15
|
+
# `ON_CREATE_HOSTED_CONFIGURATION`, `PRE_DEPLOYMENT`, or
|
16
|
+
# `ON_DEPLOYMENT`. Each action also includes a name, a URI to an Lambda
|
17
|
+
# function, and an Amazon Resource Name (ARN) for an Identity and Access
|
18
|
+
# Management assume role. You specify the name, URI, and ARN for each
|
19
|
+
# *action point* defined in the extension. You can specify the following
|
20
|
+
# actions for an extension:
|
21
|
+
#
|
22
|
+
# * `PRE_CREATE_HOSTED_CONFIGURATION_VERSION`
|
23
|
+
#
|
24
|
+
# * `PRE_START_DEPLOYMENT`
|
25
|
+
#
|
26
|
+
# * `ON_DEPLOYMENT_START`
|
27
|
+
#
|
28
|
+
# * `ON_DEPLOYMENT_STEP`
|
29
|
+
#
|
30
|
+
# * `ON_DEPLOYMENT_BAKING`
|
31
|
+
#
|
32
|
+
# * `ON_DEPLOYMENT_COMPLETE`
|
33
|
+
#
|
34
|
+
# * `ON_DEPLOYMENT_ROLLED_BACK`
|
35
|
+
#
|
36
|
+
# @note When making an API call, you may pass Action
|
37
|
+
# data as a hash:
|
38
|
+
#
|
39
|
+
# {
|
40
|
+
# name: "Name",
|
41
|
+
# description: "Description",
|
42
|
+
# uri: "Uri",
|
43
|
+
# role_arn: "Arn",
|
44
|
+
# }
|
45
|
+
#
|
46
|
+
# @!attribute [rw] name
|
47
|
+
# The action name.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] description
|
51
|
+
# Information about the action.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @!attribute [rw] uri
|
55
|
+
# The extension URI associated to the action point in the extension
|
56
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
57
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
58
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
59
|
+
# EventBridge default event bus.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] role_arn
|
63
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
64
|
+
# assume role.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Action AWS API Documentation
|
68
|
+
#
|
69
|
+
class Action < Struct.new(
|
70
|
+
:name,
|
71
|
+
:description,
|
72
|
+
:uri,
|
73
|
+
:role_arn)
|
74
|
+
SENSITIVE = []
|
75
|
+
include Aws::Structure
|
76
|
+
end
|
77
|
+
|
78
|
+
# An extension that was invoked as part of a deployment event.
|
79
|
+
#
|
80
|
+
# @!attribute [rw] extension_identifier
|
81
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
82
|
+
# extension.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] action_name
|
86
|
+
# The name of the action.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] uri
|
90
|
+
# The extension URI associated to the action point in the extension
|
91
|
+
# definition. The URI can be an Amazon Resource Name (ARN) for one of
|
92
|
+
# the following: an Lambda function, an Amazon Simple Queue Service
|
93
|
+
# queue, an Amazon Simple Notification Service topic, or the Amazon
|
94
|
+
# EventBridge default event bus.
|
95
|
+
# @return [String]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] role_arn
|
98
|
+
# An Amazon Resource Name (ARN) for an Identity and Access Management
|
99
|
+
# assume role.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @!attribute [rw] error_message
|
103
|
+
# The error message when an extension invocation fails.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] error_code
|
107
|
+
# The error code when an extension invocation fails.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] invocation_id
|
111
|
+
# A system-generated ID for this invocation.
|
112
|
+
# @return [String]
|
113
|
+
#
|
114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ActionInvocation AWS API Documentation
|
115
|
+
#
|
116
|
+
class ActionInvocation < Struct.new(
|
117
|
+
:extension_identifier,
|
118
|
+
:action_name,
|
119
|
+
:uri,
|
120
|
+
:role_arn,
|
121
|
+
:error_message,
|
122
|
+
:error_code,
|
123
|
+
:invocation_id)
|
124
|
+
SENSITIVE = []
|
125
|
+
include Aws::Structure
|
126
|
+
end
|
127
|
+
|
13
128
|
# @!attribute [rw] id
|
14
129
|
# The application ID.
|
15
130
|
# @return [String]
|
@@ -50,6 +165,35 @@ module Aws::AppConfig
|
|
50
165
|
include Aws::Structure
|
51
166
|
end
|
52
167
|
|
168
|
+
# An extension that was invoked during a deployment.
|
169
|
+
#
|
170
|
+
# @!attribute [rw] extension_id
|
171
|
+
# The system-generated ID of the extension.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] extension_association_id
|
175
|
+
# The system-generated ID for the association.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] version_number
|
179
|
+
# The extension version number.
|
180
|
+
# @return [Integer]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] parameters
|
183
|
+
# One or more parameters for the actions called by the extension.
|
184
|
+
# @return [Hash<String,String>]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/AppliedExtension AWS API Documentation
|
187
|
+
#
|
188
|
+
class AppliedExtension < Struct.new(
|
189
|
+
:extension_id,
|
190
|
+
:extension_association_id,
|
191
|
+
:version_number,
|
192
|
+
:parameters)
|
193
|
+
SENSITIVE = []
|
194
|
+
include Aws::Structure
|
195
|
+
end
|
196
|
+
|
53
197
|
# Detailed information about the input that failed to satisfy the
|
54
198
|
# constraints specified by a call.
|
55
199
|
#
|
@@ -305,7 +449,7 @@ module Aws::AppConfig
|
|
305
449
|
#
|
306
450
|
# {
|
307
451
|
# application_id: "Id", # required
|
308
|
-
# name: "
|
452
|
+
# name: "LongName", # required
|
309
453
|
# description: "Description",
|
310
454
|
# location_uri: "Uri", # required
|
311
455
|
# retrieval_role_arn: "RoleArn",
|
@@ -404,7 +548,7 @@ module Aws::AppConfig
|
|
404
548
|
# final_bake_time_in_minutes: 1,
|
405
549
|
# growth_factor: 1.0, # required
|
406
550
|
# growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
|
407
|
-
# replicate_to: "NONE", #
|
551
|
+
# replicate_to: "NONE", # accepts NONE, SSM_DOCUMENT
|
408
552
|
# tags: {
|
409
553
|
# "TagKey" => "TagValue",
|
410
554
|
# },
|
@@ -423,9 +567,18 @@ module Aws::AppConfig
|
|
423
567
|
# @return [Integer]
|
424
568
|
#
|
425
569
|
# @!attribute [rw] final_bake_time_in_minutes
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
570
|
+
# Specifies the amount of time AppConfig monitors for Amazon
|
571
|
+
# CloudWatch alarms after the configuration has been deployed to 100%
|
572
|
+
# of its targets, before considering the deployment to be complete. If
|
573
|
+
# an alarm is triggered during this time, AppConfig rolls back the
|
574
|
+
# deployment. You must configure permissions for AppConfig to roll
|
575
|
+
# back based on CloudWatch alarms. For more information, see
|
576
|
+
# [Configuring permissions for rollback based on Amazon CloudWatch
|
577
|
+
# alarms][1] in the *AppConfig User Guide*.
|
578
|
+
#
|
579
|
+
#
|
580
|
+
#
|
581
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html
|
429
582
|
# @return [Integer]
|
430
583
|
#
|
431
584
|
# @!attribute [rw] growth_factor
|
@@ -540,6 +693,134 @@ module Aws::AppConfig
|
|
540
693
|
include Aws::Structure
|
541
694
|
end
|
542
695
|
|
696
|
+
# @note When making an API call, you may pass CreateExtensionAssociationRequest
|
697
|
+
# data as a hash:
|
698
|
+
#
|
699
|
+
# {
|
700
|
+
# extension_identifier: "Identifier", # required
|
701
|
+
# extension_version_number: 1,
|
702
|
+
# resource_identifier: "Identifier", # required
|
703
|
+
# parameters: {
|
704
|
+
# "Name" => "StringWithLengthBetween1And2048",
|
705
|
+
# },
|
706
|
+
# tags: {
|
707
|
+
# "TagKey" => "TagValue",
|
708
|
+
# },
|
709
|
+
# }
|
710
|
+
#
|
711
|
+
# @!attribute [rw] extension_identifier
|
712
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
713
|
+
# extension.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] extension_version_number
|
717
|
+
# The version number of the extension. If not specified, AppConfig
|
718
|
+
# uses the maximum version of the extension.
|
719
|
+
# @return [Integer]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] resource_identifier
|
722
|
+
# The ARN of an application, configuration profile, or environment.
|
723
|
+
# @return [String]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] parameters
|
726
|
+
# The parameter names and values defined in the extensions. Extension
|
727
|
+
# parameters marked `Required` must be entered for this field.
|
728
|
+
# @return [Hash<String,String>]
|
729
|
+
#
|
730
|
+
# @!attribute [rw] tags
|
731
|
+
# Adds one or more tags for the specified extension association. Tags
|
732
|
+
# are metadata that help you categorize resources in different ways,
|
733
|
+
# for example, by purpose, owner, or environment. Each tag consists of
|
734
|
+
# a key and an optional value, both of which you define.
|
735
|
+
# @return [Hash<String,String>]
|
736
|
+
#
|
737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionAssociationRequest AWS API Documentation
|
738
|
+
#
|
739
|
+
class CreateExtensionAssociationRequest < Struct.new(
|
740
|
+
:extension_identifier,
|
741
|
+
:extension_version_number,
|
742
|
+
:resource_identifier,
|
743
|
+
:parameters,
|
744
|
+
:tags)
|
745
|
+
SENSITIVE = []
|
746
|
+
include Aws::Structure
|
747
|
+
end
|
748
|
+
|
749
|
+
# @note When making an API call, you may pass CreateExtensionRequest
|
750
|
+
# data as a hash:
|
751
|
+
#
|
752
|
+
# {
|
753
|
+
# name: "Name", # required
|
754
|
+
# description: "Description",
|
755
|
+
# actions: { # required
|
756
|
+
# "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" => [
|
757
|
+
# {
|
758
|
+
# name: "Name",
|
759
|
+
# description: "Description",
|
760
|
+
# uri: "Uri",
|
761
|
+
# role_arn: "Arn",
|
762
|
+
# },
|
763
|
+
# ],
|
764
|
+
# },
|
765
|
+
# parameters: {
|
766
|
+
# "Name" => {
|
767
|
+
# description: "Description",
|
768
|
+
# required: false,
|
769
|
+
# },
|
770
|
+
# },
|
771
|
+
# tags: {
|
772
|
+
# "TagKey" => "TagValue",
|
773
|
+
# },
|
774
|
+
# latest_version_number: 1,
|
775
|
+
# }
|
776
|
+
#
|
777
|
+
# @!attribute [rw] name
|
778
|
+
# A name for the extension. Each extension name in your account must
|
779
|
+
# be unique. Extension versions use the same name.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] description
|
783
|
+
# Information about the extension.
|
784
|
+
# @return [String]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] actions
|
787
|
+
# The actions defined in the extension.
|
788
|
+
# @return [Hash<String,Array<Types::Action>>]
|
789
|
+
#
|
790
|
+
# @!attribute [rw] parameters
|
791
|
+
# The parameters accepted by the extension. You specify parameter
|
792
|
+
# values when you associate the extension to an AppConfig resource by
|
793
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
794
|
+
# extension actions, these parameters are included in the Lambda
|
795
|
+
# request object.
|
796
|
+
# @return [Hash<String,Types::Parameter>]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] tags
|
799
|
+
# Adds one or more tags for the specified extension. Tags are metadata
|
800
|
+
# that help you categorize resources in different ways, for example,
|
801
|
+
# by purpose, owner, or environment. Each tag consists of a key and an
|
802
|
+
# optional value, both of which you define.
|
803
|
+
# @return [Hash<String,String>]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] latest_version_number
|
806
|
+
# You can omit this field when you create an extension. When you
|
807
|
+
# create a new version, specify the most recent current version
|
808
|
+
# number. For example, you create version 3, enter 2 for this field.
|
809
|
+
# @return [Integer]
|
810
|
+
#
|
811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateExtensionRequest AWS API Documentation
|
812
|
+
#
|
813
|
+
class CreateExtensionRequest < Struct.new(
|
814
|
+
:name,
|
815
|
+
:description,
|
816
|
+
:actions,
|
817
|
+
:parameters,
|
818
|
+
:tags,
|
819
|
+
:latest_version_number)
|
820
|
+
SENSITIVE = []
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
543
824
|
# @note When making an API call, you may pass CreateHostedConfigurationVersionRequest
|
544
825
|
# data as a hash:
|
545
826
|
#
|
@@ -688,6 +969,52 @@ module Aws::AppConfig
|
|
688
969
|
include Aws::Structure
|
689
970
|
end
|
690
971
|
|
972
|
+
# @note When making an API call, you may pass DeleteExtensionAssociationRequest
|
973
|
+
# data as a hash:
|
974
|
+
#
|
975
|
+
# {
|
976
|
+
# extension_association_id: "Id", # required
|
977
|
+
# }
|
978
|
+
#
|
979
|
+
# @!attribute [rw] extension_association_id
|
980
|
+
# The ID of the extension association to delete.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionAssociationRequest AWS API Documentation
|
984
|
+
#
|
985
|
+
class DeleteExtensionAssociationRequest < Struct.new(
|
986
|
+
:extension_association_id)
|
987
|
+
SENSITIVE = []
|
988
|
+
include Aws::Structure
|
989
|
+
end
|
990
|
+
|
991
|
+
# @note When making an API call, you may pass DeleteExtensionRequest
|
992
|
+
# data as a hash:
|
993
|
+
#
|
994
|
+
# {
|
995
|
+
# extension_identifier: "Identifier", # required
|
996
|
+
# version_number: 1,
|
997
|
+
# }
|
998
|
+
#
|
999
|
+
# @!attribute [rw] extension_identifier
|
1000
|
+
# The name, ID, or Amazon Resource Name (ARN) of the extension you
|
1001
|
+
# want to delete.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] version_number
|
1005
|
+
# A specific version of an extension to delete. If omitted, the
|
1006
|
+
# highest version is deleted.
|
1007
|
+
# @return [Integer]
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteExtensionRequest AWS API Documentation
|
1010
|
+
#
|
1011
|
+
class DeleteExtensionRequest < Struct.new(
|
1012
|
+
:extension_identifier,
|
1013
|
+
:version_number)
|
1014
|
+
SENSITIVE = []
|
1015
|
+
include Aws::Structure
|
1016
|
+
end
|
1017
|
+
|
691
1018
|
# @note When making an API call, you may pass DeleteHostedConfigurationVersionRequest
|
692
1019
|
# data as a hash:
|
693
1020
|
#
|
@@ -795,6 +1122,13 @@ module Aws::AppConfig
|
|
795
1122
|
# The time the deployment completed.
|
796
1123
|
# @return [Time]
|
797
1124
|
#
|
1125
|
+
# @!attribute [rw] applied_extensions
|
1126
|
+
# A list of extensions that were processed as part of the deployment.
|
1127
|
+
# The extensions that were previously associated to the configuration
|
1128
|
+
# profile, environment, or the application when `StartDeployment` was
|
1129
|
+
# called.
|
1130
|
+
# @return [Array<Types::AppliedExtension>]
|
1131
|
+
#
|
798
1132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Deployment AWS API Documentation
|
799
1133
|
#
|
800
1134
|
class Deployment < Struct.new(
|
@@ -815,7 +1149,8 @@ module Aws::AppConfig
|
|
815
1149
|
:event_log,
|
816
1150
|
:percentage_complete,
|
817
1151
|
:started_at,
|
818
|
-
:completed_at
|
1152
|
+
:completed_at,
|
1153
|
+
:applied_extensions)
|
819
1154
|
SENSITIVE = []
|
820
1155
|
include Aws::Structure
|
821
1156
|
end
|
@@ -843,6 +1178,10 @@ module Aws::AppConfig
|
|
843
1178
|
# attempt a new deployment.
|
844
1179
|
# @return [String]
|
845
1180
|
#
|
1181
|
+
# @!attribute [rw] action_invocations
|
1182
|
+
# The list of extensions that were invoked as part of the deployment.
|
1183
|
+
# @return [Array<Types::ActionInvocation>]
|
1184
|
+
#
|
846
1185
|
# @!attribute [rw] occurred_at
|
847
1186
|
# The date and time the event occurred.
|
848
1187
|
# @return [Time]
|
@@ -853,6 +1192,7 @@ module Aws::AppConfig
|
|
853
1192
|
:event_type,
|
854
1193
|
:triggered_by,
|
855
1194
|
:description,
|
1195
|
+
:action_invocations,
|
856
1196
|
:occurred_at)
|
857
1197
|
SENSITIVE = []
|
858
1198
|
include Aws::Structure
|
@@ -1068,6 +1408,194 @@ module Aws::AppConfig
|
|
1068
1408
|
include Aws::Structure
|
1069
1409
|
end
|
1070
1410
|
|
1411
|
+
# @!attribute [rw] id
|
1412
|
+
# The system-generated ID of the extension.
|
1413
|
+
# @return [String]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] name
|
1416
|
+
# The extension name.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] version_number
|
1420
|
+
# The extension version number.
|
1421
|
+
# @return [Integer]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] arn
|
1424
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1425
|
+
# @return [String]
|
1426
|
+
#
|
1427
|
+
# @!attribute [rw] description
|
1428
|
+
# Information about the extension.
|
1429
|
+
# @return [String]
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] actions
|
1432
|
+
# The actions defined in the extension.
|
1433
|
+
# @return [Hash<String,Array<Types::Action>>]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] parameters
|
1436
|
+
# The parameters accepted by the extension. You specify parameter
|
1437
|
+
# values when you associate the extension to an AppConfig resource by
|
1438
|
+
# using the `CreateExtensionAssociation` API action. For Lambda
|
1439
|
+
# extension actions, these parameters are included in the Lambda
|
1440
|
+
# request object.
|
1441
|
+
# @return [Hash<String,Types::Parameter>]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extension AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class Extension < Struct.new(
|
1446
|
+
:id,
|
1447
|
+
:name,
|
1448
|
+
:version_number,
|
1449
|
+
:arn,
|
1450
|
+
:description,
|
1451
|
+
:actions,
|
1452
|
+
:parameters)
|
1453
|
+
SENSITIVE = []
|
1454
|
+
include Aws::Structure
|
1455
|
+
end
|
1456
|
+
|
1457
|
+
# @!attribute [rw] id
|
1458
|
+
# The system-generated ID for the association.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] extension_arn
|
1462
|
+
# The ARN of the extension defined in the association.
|
1463
|
+
# @return [String]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] resource_arn
|
1466
|
+
# The ARNs of applications, configuration profiles, or environments
|
1467
|
+
# defined in the association.
|
1468
|
+
# @return [String]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] arn
|
1471
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] parameters
|
1475
|
+
# The parameter names and values defined in the association.
|
1476
|
+
# @return [Hash<String,String>]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] extension_version_number
|
1479
|
+
# The version number for the extension defined in the association.
|
1480
|
+
# @return [Integer]
|
1481
|
+
#
|
1482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociation AWS API Documentation
|
1483
|
+
#
|
1484
|
+
class ExtensionAssociation < Struct.new(
|
1485
|
+
:id,
|
1486
|
+
:extension_arn,
|
1487
|
+
:resource_arn,
|
1488
|
+
:arn,
|
1489
|
+
:parameters,
|
1490
|
+
:extension_version_number)
|
1491
|
+
SENSITIVE = []
|
1492
|
+
include Aws::Structure
|
1493
|
+
end
|
1494
|
+
|
1495
|
+
# Information about an association between an extension and an AppConfig
|
1496
|
+
# resource such as an application, environment, or configuration
|
1497
|
+
# profile. Call `GetExtensionAssociation` to get more information about
|
1498
|
+
# an association.
|
1499
|
+
#
|
1500
|
+
# @!attribute [rw] id
|
1501
|
+
# The extension association ID. This ID is used to call other
|
1502
|
+
# `ExtensionAssociation` API actions such as `GetExtensionAssociation`
|
1503
|
+
# or `DeleteExtensionAssociation`.
|
1504
|
+
# @return [String]
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] extension_arn
|
1507
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] resource_arn
|
1511
|
+
# The ARNs of applications, configuration profiles, or environments
|
1512
|
+
# defined in the association.
|
1513
|
+
# @return [String]
|
1514
|
+
#
|
1515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociationSummary AWS API Documentation
|
1516
|
+
#
|
1517
|
+
class ExtensionAssociationSummary < Struct.new(
|
1518
|
+
:id,
|
1519
|
+
:extension_arn,
|
1520
|
+
:resource_arn)
|
1521
|
+
SENSITIVE = []
|
1522
|
+
include Aws::Structure
|
1523
|
+
end
|
1524
|
+
|
1525
|
+
# @!attribute [rw] items
|
1526
|
+
# The list of extension associations. Each item represents an
|
1527
|
+
# extension association to an application, environment, or
|
1528
|
+
# configuration profile.
|
1529
|
+
# @return [Array<Types::ExtensionAssociationSummary>]
|
1530
|
+
#
|
1531
|
+
# @!attribute [rw] next_token
|
1532
|
+
# The token for the next set of items to return. Use this token to get
|
1533
|
+
# the next set of results.
|
1534
|
+
# @return [String]
|
1535
|
+
#
|
1536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionAssociations AWS API Documentation
|
1537
|
+
#
|
1538
|
+
class ExtensionAssociations < Struct.new(
|
1539
|
+
:items,
|
1540
|
+
:next_token)
|
1541
|
+
SENSITIVE = []
|
1542
|
+
include Aws::Structure
|
1543
|
+
end
|
1544
|
+
|
1545
|
+
# Information about an extension. Call `GetExtension` to get more
|
1546
|
+
# information about an extension.
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] id
|
1549
|
+
# The system-generated ID of the extension.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] name
|
1553
|
+
# The extension name.
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] version_number
|
1557
|
+
# The extension version number.
|
1558
|
+
# @return [Integer]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] arn
|
1561
|
+
# The system-generated Amazon Resource Name (ARN) for the extension.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] description
|
1565
|
+
# Information about the extension.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ExtensionSummary AWS API Documentation
|
1569
|
+
#
|
1570
|
+
class ExtensionSummary < Struct.new(
|
1571
|
+
:id,
|
1572
|
+
:name,
|
1573
|
+
:version_number,
|
1574
|
+
:arn,
|
1575
|
+
:description)
|
1576
|
+
SENSITIVE = []
|
1577
|
+
include Aws::Structure
|
1578
|
+
end
|
1579
|
+
|
1580
|
+
# @!attribute [rw] items
|
1581
|
+
# The list of available extensions. The list includes Amazon Web
|
1582
|
+
# Services-authored and user-created extensions.
|
1583
|
+
# @return [Array<Types::ExtensionSummary>]
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] next_token
|
1586
|
+
# The token for the next set of items to return. Use this token to get
|
1587
|
+
# the next set of results.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Extensions AWS API Documentation
|
1591
|
+
#
|
1592
|
+
class Extensions < Struct.new(
|
1593
|
+
:items,
|
1594
|
+
:next_token)
|
1595
|
+
SENSITIVE = []
|
1596
|
+
include Aws::Structure
|
1597
|
+
end
|
1598
|
+
|
1071
1599
|
# @note When making an API call, you may pass GetApplicationRequest
|
1072
1600
|
# data as a hash:
|
1073
1601
|
#
|
@@ -1260,6 +1788,52 @@ module Aws::AppConfig
|
|
1260
1788
|
include Aws::Structure
|
1261
1789
|
end
|
1262
1790
|
|
1791
|
+
# @note When making an API call, you may pass GetExtensionAssociationRequest
|
1792
|
+
# data as a hash:
|
1793
|
+
#
|
1794
|
+
# {
|
1795
|
+
# extension_association_id: "Id", # required
|
1796
|
+
# }
|
1797
|
+
#
|
1798
|
+
# @!attribute [rw] extension_association_id
|
1799
|
+
# The extension association ID to get.
|
1800
|
+
# @return [String]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionAssociationRequest AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class GetExtensionAssociationRequest < Struct.new(
|
1805
|
+
:extension_association_id)
|
1806
|
+
SENSITIVE = []
|
1807
|
+
include Aws::Structure
|
1808
|
+
end
|
1809
|
+
|
1810
|
+
# @note When making an API call, you may pass GetExtensionRequest
|
1811
|
+
# data as a hash:
|
1812
|
+
#
|
1813
|
+
# {
|
1814
|
+
# extension_identifier: "Identifier", # required
|
1815
|
+
# version_number: 1,
|
1816
|
+
# }
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] extension_identifier
|
1819
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
1820
|
+
# extension.
|
1821
|
+
# @return [String]
|
1822
|
+
#
|
1823
|
+
# @!attribute [rw] version_number
|
1824
|
+
# The extension version number. If no version number was defined,
|
1825
|
+
# AppConfig uses the highest version.
|
1826
|
+
# @return [Integer]
|
1827
|
+
#
|
1828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetExtensionRequest AWS API Documentation
|
1829
|
+
#
|
1830
|
+
class GetExtensionRequest < Struct.new(
|
1831
|
+
:extension_identifier,
|
1832
|
+
:version_number)
|
1833
|
+
SENSITIVE = []
|
1834
|
+
include Aws::Structure
|
1835
|
+
end
|
1836
|
+
|
1263
1837
|
# @note When making an API call, you may pass GetHostedConfigurationVersionRequest
|
1264
1838
|
# data as a hash:
|
1265
1839
|
#
|
@@ -1424,13 +1998,19 @@ module Aws::AppConfig
|
|
1424
1998
|
# The type of error for an invalid configuration.
|
1425
1999
|
# @return [String]
|
1426
2000
|
#
|
2001
|
+
# @!attribute [rw] value
|
2002
|
+
# Details about an error with Lambda when a synchronous extension
|
2003
|
+
# experiences an error during an invocation.
|
2004
|
+
# @return [String]
|
2005
|
+
#
|
1427
2006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/InvalidConfigurationDetail AWS API Documentation
|
1428
2007
|
#
|
1429
2008
|
class InvalidConfigurationDetail < Struct.new(
|
1430
2009
|
:constraint,
|
1431
2010
|
:location,
|
1432
2011
|
:reason,
|
1433
|
-
:type
|
2012
|
+
:type,
|
2013
|
+
:value)
|
1434
2014
|
SENSITIVE = []
|
1435
2015
|
include Aws::Structure
|
1436
2016
|
end
|
@@ -1613,6 +2193,87 @@ module Aws::AppConfig
|
|
1613
2193
|
include Aws::Structure
|
1614
2194
|
end
|
1615
2195
|
|
2196
|
+
# @note When making an API call, you may pass ListExtensionAssociationsRequest
|
2197
|
+
# data as a hash:
|
2198
|
+
#
|
2199
|
+
# {
|
2200
|
+
# resource_identifier: "Arn",
|
2201
|
+
# extension_identifier: "Identifier",
|
2202
|
+
# extension_version_number: 1,
|
2203
|
+
# max_results: 1,
|
2204
|
+
# next_token: "NextToken",
|
2205
|
+
# }
|
2206
|
+
#
|
2207
|
+
# @!attribute [rw] resource_identifier
|
2208
|
+
# The ARN of an application, configuration profile, or environment.
|
2209
|
+
# @return [String]
|
2210
|
+
#
|
2211
|
+
# @!attribute [rw] extension_identifier
|
2212
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2213
|
+
# extension.
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] extension_version_number
|
2217
|
+
# The version number for the extension defined in the association.
|
2218
|
+
# @return [Integer]
|
2219
|
+
#
|
2220
|
+
# @!attribute [rw] max_results
|
2221
|
+
# The maximum number of items to return for this call. The call also
|
2222
|
+
# returns a token that you can specify in a subsequent call to get the
|
2223
|
+
# next set of results.
|
2224
|
+
# @return [Integer]
|
2225
|
+
#
|
2226
|
+
# @!attribute [rw] next_token
|
2227
|
+
# A token to start the list. Use this token to get the next set of
|
2228
|
+
# results or pass null to get the first set of results.
|
2229
|
+
# @return [String]
|
2230
|
+
#
|
2231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionAssociationsRequest AWS API Documentation
|
2232
|
+
#
|
2233
|
+
class ListExtensionAssociationsRequest < Struct.new(
|
2234
|
+
:resource_identifier,
|
2235
|
+
:extension_identifier,
|
2236
|
+
:extension_version_number,
|
2237
|
+
:max_results,
|
2238
|
+
:next_token)
|
2239
|
+
SENSITIVE = []
|
2240
|
+
include Aws::Structure
|
2241
|
+
end
|
2242
|
+
|
2243
|
+
# @note When making an API call, you may pass ListExtensionsRequest
|
2244
|
+
# data as a hash:
|
2245
|
+
#
|
2246
|
+
# {
|
2247
|
+
# max_results: 1,
|
2248
|
+
# next_token: "NextToken",
|
2249
|
+
# name: "QueryName",
|
2250
|
+
# }
|
2251
|
+
#
|
2252
|
+
# @!attribute [rw] max_results
|
2253
|
+
# The maximum number of items to return for this call. The call also
|
2254
|
+
# returns a token that you can specify in a subsequent call to get the
|
2255
|
+
# next set of results.
|
2256
|
+
# @return [Integer]
|
2257
|
+
#
|
2258
|
+
# @!attribute [rw] next_token
|
2259
|
+
# A token to start the list. Use this token to get the next set of
|
2260
|
+
# results.
|
2261
|
+
# @return [String]
|
2262
|
+
#
|
2263
|
+
# @!attribute [rw] name
|
2264
|
+
# The extension name.
|
2265
|
+
# @return [String]
|
2266
|
+
#
|
2267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListExtensionsRequest AWS API Documentation
|
2268
|
+
#
|
2269
|
+
class ListExtensionsRequest < Struct.new(
|
2270
|
+
:max_results,
|
2271
|
+
:next_token,
|
2272
|
+
:name)
|
2273
|
+
SENSITIVE = []
|
2274
|
+
include Aws::Structure
|
2275
|
+
end
|
2276
|
+
|
1616
2277
|
# @note When making an API call, you may pass ListHostedConfigurationVersionsRequest
|
1617
2278
|
# data as a hash:
|
1618
2279
|
#
|
@@ -1700,6 +2361,41 @@ module Aws::AppConfig
|
|
1700
2361
|
include Aws::Structure
|
1701
2362
|
end
|
1702
2363
|
|
2364
|
+
# A value such as an Amazon Resource Name (ARN) or an Amazon Simple
|
2365
|
+
# Notification Service topic entered in an extension when invoked.
|
2366
|
+
# Parameter values are specified in an extension association. For more
|
2367
|
+
# information about extensions, see [Working with AppConfig
|
2368
|
+
# extensions][1] in the *AppConfig User Guide*.
|
2369
|
+
#
|
2370
|
+
#
|
2371
|
+
#
|
2372
|
+
# [1]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html
|
2373
|
+
#
|
2374
|
+
# @note When making an API call, you may pass Parameter
|
2375
|
+
# data as a hash:
|
2376
|
+
#
|
2377
|
+
# {
|
2378
|
+
# description: "Description",
|
2379
|
+
# required: false,
|
2380
|
+
# }
|
2381
|
+
#
|
2382
|
+
# @!attribute [rw] description
|
2383
|
+
# Information about the parameter.
|
2384
|
+
# @return [String]
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] required
|
2387
|
+
# A parameter value must be specified in the extension association.
|
2388
|
+
# @return [Boolean]
|
2389
|
+
#
|
2390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/Parameter AWS API Documentation
|
2391
|
+
#
|
2392
|
+
class Parameter < Struct.new(
|
2393
|
+
:description,
|
2394
|
+
:required)
|
2395
|
+
SENSITIVE = []
|
2396
|
+
include Aws::Structure
|
2397
|
+
end
|
2398
|
+
|
1703
2399
|
# The configuration size is too large.
|
1704
2400
|
#
|
1705
2401
|
# @!attribute [rw] message
|
@@ -2128,6 +2824,91 @@ module Aws::AppConfig
|
|
2128
2824
|
include Aws::Structure
|
2129
2825
|
end
|
2130
2826
|
|
2827
|
+
# @note When making an API call, you may pass UpdateExtensionAssociationRequest
|
2828
|
+
# data as a hash:
|
2829
|
+
#
|
2830
|
+
# {
|
2831
|
+
# extension_association_id: "Id", # required
|
2832
|
+
# parameters: {
|
2833
|
+
# "Name" => "StringWithLengthBetween1And2048",
|
2834
|
+
# },
|
2835
|
+
# }
|
2836
|
+
#
|
2837
|
+
# @!attribute [rw] extension_association_id
|
2838
|
+
# The system-generated ID for the association.
|
2839
|
+
# @return [String]
|
2840
|
+
#
|
2841
|
+
# @!attribute [rw] parameters
|
2842
|
+
# The parameter names and values defined in the extension.
|
2843
|
+
# @return [Hash<String,String>]
|
2844
|
+
#
|
2845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionAssociationRequest AWS API Documentation
|
2846
|
+
#
|
2847
|
+
class UpdateExtensionAssociationRequest < Struct.new(
|
2848
|
+
:extension_association_id,
|
2849
|
+
:parameters)
|
2850
|
+
SENSITIVE = []
|
2851
|
+
include Aws::Structure
|
2852
|
+
end
|
2853
|
+
|
2854
|
+
# @note When making an API call, you may pass UpdateExtensionRequest
|
2855
|
+
# data as a hash:
|
2856
|
+
#
|
2857
|
+
# {
|
2858
|
+
# extension_identifier: "Identifier", # required
|
2859
|
+
# description: "Description",
|
2860
|
+
# actions: {
|
2861
|
+
# "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" => [
|
2862
|
+
# {
|
2863
|
+
# name: "Name",
|
2864
|
+
# description: "Description",
|
2865
|
+
# uri: "Uri",
|
2866
|
+
# role_arn: "Arn",
|
2867
|
+
# },
|
2868
|
+
# ],
|
2869
|
+
# },
|
2870
|
+
# parameters: {
|
2871
|
+
# "Name" => {
|
2872
|
+
# description: "Description",
|
2873
|
+
# required: false,
|
2874
|
+
# },
|
2875
|
+
# },
|
2876
|
+
# version_number: 1,
|
2877
|
+
# }
|
2878
|
+
#
|
2879
|
+
# @!attribute [rw] extension_identifier
|
2880
|
+
# The name, the ID, or the Amazon Resource Name (ARN) of the
|
2881
|
+
# extension.
|
2882
|
+
# @return [String]
|
2883
|
+
#
|
2884
|
+
# @!attribute [rw] description
|
2885
|
+
# Information about the extension.
|
2886
|
+
# @return [String]
|
2887
|
+
#
|
2888
|
+
# @!attribute [rw] actions
|
2889
|
+
# The actions defined in the extension.
|
2890
|
+
# @return [Hash<String,Array<Types::Action>>]
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] parameters
|
2893
|
+
# One or more parameters for the actions called by the extension.
|
2894
|
+
# @return [Hash<String,Types::Parameter>]
|
2895
|
+
#
|
2896
|
+
# @!attribute [rw] version_number
|
2897
|
+
# The extension version number.
|
2898
|
+
# @return [Integer]
|
2899
|
+
#
|
2900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateExtensionRequest AWS API Documentation
|
2901
|
+
#
|
2902
|
+
class UpdateExtensionRequest < Struct.new(
|
2903
|
+
:extension_identifier,
|
2904
|
+
:description,
|
2905
|
+
:actions,
|
2906
|
+
:parameters,
|
2907
|
+
:version_number)
|
2908
|
+
SENSITIVE = []
|
2909
|
+
include Aws::Structure
|
2910
|
+
end
|
2911
|
+
|
2131
2912
|
# @note When making an API call, you may pass ValidateConfigurationRequest
|
2132
2913
|
# data as a hash:
|
2133
2914
|
#
|