aws-sdk-amplify 1.15.0 → 1.20.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.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -28,6 +30,9 @@ module Aws::Amplify
28
30
  AutoBranchCreationConfig = Shapes::StructureShape.new(name: 'AutoBranchCreationConfig')
29
31
  AutoBranchCreationPattern = Shapes::StringShape.new(name: 'AutoBranchCreationPattern')
30
32
  AutoBranchCreationPatterns = Shapes::ListShape.new(name: 'AutoBranchCreationPatterns')
33
+ AutoSubDomainCreationPattern = Shapes::StringShape.new(name: 'AutoSubDomainCreationPattern')
34
+ AutoSubDomainCreationPatterns = Shapes::ListShape.new(name: 'AutoSubDomainCreationPatterns')
35
+ AutoSubDomainIAMRole = Shapes::StringShape.new(name: 'AutoSubDomainIAMRole')
31
36
  BackendEnvironment = Shapes::StructureShape.new(name: 'BackendEnvironment')
32
37
  BackendEnvironmentArn = Shapes::StringShape.new(name: 'BackendEnvironmentArn')
33
38
  BackendEnvironments = Shapes::ListShape.new(name: 'BackendEnvironments')
@@ -91,6 +96,7 @@ module Aws::Amplify
91
96
  EnableAutoSubDomain = Shapes::BooleanShape.new(name: 'EnableAutoSubDomain')
92
97
  EnableBasicAuth = Shapes::BooleanShape.new(name: 'EnableBasicAuth')
93
98
  EnableBranchAutoBuild = Shapes::BooleanShape.new(name: 'EnableBranchAutoBuild')
99
+ EnableBranchAutoDeletion = Shapes::BooleanShape.new(name: 'EnableBranchAutoDeletion')
94
100
  EnableNotification = Shapes::BooleanShape.new(name: 'EnableNotification')
95
101
  EnablePullRequestPreview = Shapes::BooleanShape.new(name: 'EnablePullRequestPreview')
96
102
  EndTime = Shapes::TimestampShape.new(name: 'EndTime')
@@ -227,6 +233,7 @@ module Aws::Amplify
227
233
  App.add_member(:environment_variables, Shapes::ShapeRef.new(shape: EnvironmentVariables, required: true, location_name: "environmentVariables"))
228
234
  App.add_member(:default_domain, Shapes::ShapeRef.new(shape: DefaultDomain, required: true, location_name: "defaultDomain"))
229
235
  App.add_member(:enable_branch_auto_build, Shapes::ShapeRef.new(shape: EnableBranchAutoBuild, required: true, location_name: "enableBranchAutoBuild"))
236
+ App.add_member(:enable_branch_auto_deletion, Shapes::ShapeRef.new(shape: EnableBranchAutoDeletion, location_name: "enableBranchAutoDeletion"))
230
237
  App.add_member(:enable_basic_auth, Shapes::ShapeRef.new(shape: EnableBasicAuth, required: true, location_name: "enableBasicAuth"))
231
238
  App.add_member(:basic_auth_credentials, Shapes::ShapeRef.new(shape: BasicAuthCredentials, location_name: "basicAuthCredentials"))
232
239
  App.add_member(:custom_rules, Shapes::ShapeRef.new(shape: CustomRules, location_name: "customRules"))
@@ -260,6 +267,8 @@ module Aws::Amplify
260
267
 
261
268
  AutoBranchCreationPatterns.member = Shapes::ShapeRef.new(shape: AutoBranchCreationPattern)
262
269
 
270
+ AutoSubDomainCreationPatterns.member = Shapes::ShapeRef.new(shape: AutoSubDomainCreationPattern)
271
+
263
272
  BackendEnvironment.add_member(:backend_environment_arn, Shapes::ShapeRef.new(shape: BackendEnvironmentArn, required: true, location_name: "backendEnvironmentArn"))
264
273
  BackendEnvironment.add_member(:environment_name, Shapes::ShapeRef.new(shape: EnvironmentName, required: true, location_name: "environmentName"))
265
274
  BackendEnvironment.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, location_name: "stackName"))
@@ -312,6 +321,7 @@ module Aws::Amplify
312
321
  CreateAppRequest.add_member(:access_token, Shapes::ShapeRef.new(shape: AccessToken, location_name: "accessToken"))
313
322
  CreateAppRequest.add_member(:environment_variables, Shapes::ShapeRef.new(shape: EnvironmentVariables, location_name: "environmentVariables"))
314
323
  CreateAppRequest.add_member(:enable_branch_auto_build, Shapes::ShapeRef.new(shape: EnableBranchAutoBuild, location_name: "enableBranchAutoBuild"))
324
+ CreateAppRequest.add_member(:enable_branch_auto_deletion, Shapes::ShapeRef.new(shape: EnableBranchAutoDeletion, location_name: "enableBranchAutoDeletion"))
315
325
  CreateAppRequest.add_member(:enable_basic_auth, Shapes::ShapeRef.new(shape: EnableBasicAuth, location_name: "enableBasicAuth"))
316
326
  CreateAppRequest.add_member(:basic_auth_credentials, Shapes::ShapeRef.new(shape: BasicAuthCredentials, location_name: "basicAuthCredentials"))
317
327
  CreateAppRequest.add_member(:custom_rules, Shapes::ShapeRef.new(shape: CustomRules, location_name: "customRules"))
@@ -370,6 +380,8 @@ module Aws::Amplify
370
380
  CreateDomainAssociationRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "domainName"))
371
381
  CreateDomainAssociationRequest.add_member(:enable_auto_sub_domain, Shapes::ShapeRef.new(shape: EnableAutoSubDomain, location_name: "enableAutoSubDomain"))
372
382
  CreateDomainAssociationRequest.add_member(:sub_domain_settings, Shapes::ShapeRef.new(shape: SubDomainSettings, required: true, location_name: "subDomainSettings"))
383
+ CreateDomainAssociationRequest.add_member(:auto_sub_domain_creation_patterns, Shapes::ShapeRef.new(shape: AutoSubDomainCreationPatterns, location_name: "autoSubDomainCreationPatterns"))
384
+ CreateDomainAssociationRequest.add_member(:auto_sub_domain_iam_role, Shapes::ShapeRef.new(shape: AutoSubDomainIAMRole, location_name: "autoSubDomainIAMRole"))
373
385
  CreateDomainAssociationRequest.struct_class = Types::CreateDomainAssociationRequest
374
386
 
375
387
  CreateDomainAssociationResult.add_member(:domain_association, Shapes::ShapeRef.new(shape: DomainAssociation, required: true, location_name: "domainAssociation"))
@@ -440,6 +452,8 @@ module Aws::Amplify
440
452
  DomainAssociation.add_member(:domain_association_arn, Shapes::ShapeRef.new(shape: DomainAssociationArn, required: true, location_name: "domainAssociationArn"))
441
453
  DomainAssociation.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "domainName"))
442
454
  DomainAssociation.add_member(:enable_auto_sub_domain, Shapes::ShapeRef.new(shape: EnableAutoSubDomain, required: true, location_name: "enableAutoSubDomain"))
455
+ DomainAssociation.add_member(:auto_sub_domain_creation_patterns, Shapes::ShapeRef.new(shape: AutoSubDomainCreationPatterns, location_name: "autoSubDomainCreationPatterns"))
456
+ DomainAssociation.add_member(:auto_sub_domain_iam_role, Shapes::ShapeRef.new(shape: AutoSubDomainIAMRole, location_name: "autoSubDomainIAMRole"))
443
457
  DomainAssociation.add_member(:domain_status, Shapes::ShapeRef.new(shape: DomainStatus, required: true, location_name: "domainStatus"))
444
458
  DomainAssociation.add_member(:status_reason, Shapes::ShapeRef.new(shape: StatusReason, required: true, location_name: "statusReason"))
445
459
  DomainAssociation.add_member(:certificate_verification_dns_record, Shapes::ShapeRef.new(shape: CertificateVerificationDNSRecord, location_name: "certificateVerificationDNSRecord"))
@@ -557,7 +571,7 @@ module Aws::Amplify
557
571
  ListArtifactsResult.struct_class = Types::ListArtifactsResult
558
572
 
559
573
  ListBackendEnvironmentsRequest.add_member(:app_id, Shapes::ShapeRef.new(shape: AppId, required: true, location: "uri", location_name: "appId"))
560
- ListBackendEnvironmentsRequest.add_member(:environment_name, Shapes::ShapeRef.new(shape: EnvironmentName, location_name: "environmentName"))
574
+ ListBackendEnvironmentsRequest.add_member(:environment_name, Shapes::ShapeRef.new(shape: EnvironmentName, location: "querystring", location_name: "environmentName"))
561
575
  ListBackendEnvironmentsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
562
576
  ListBackendEnvironmentsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
563
577
  ListBackendEnvironmentsRequest.struct_class = Types::ListBackendEnvironmentsRequest
@@ -710,6 +724,7 @@ module Aws::Amplify
710
724
  UpdateAppRequest.add_member(:iam_service_role_arn, Shapes::ShapeRef.new(shape: ServiceRoleArn, location_name: "iamServiceRoleArn"))
711
725
  UpdateAppRequest.add_member(:environment_variables, Shapes::ShapeRef.new(shape: EnvironmentVariables, location_name: "environmentVariables"))
712
726
  UpdateAppRequest.add_member(:enable_branch_auto_build, Shapes::ShapeRef.new(shape: EnableAutoBuild, location_name: "enableBranchAutoBuild"))
727
+ UpdateAppRequest.add_member(:enable_branch_auto_deletion, Shapes::ShapeRef.new(shape: EnableBranchAutoDeletion, location_name: "enableBranchAutoDeletion"))
713
728
  UpdateAppRequest.add_member(:enable_basic_auth, Shapes::ShapeRef.new(shape: EnableBasicAuth, location_name: "enableBasicAuth"))
714
729
  UpdateAppRequest.add_member(:basic_auth_credentials, Shapes::ShapeRef.new(shape: BasicAuthCredentials, location_name: "basicAuthCredentials"))
715
730
  UpdateAppRequest.add_member(:custom_rules, Shapes::ShapeRef.new(shape: CustomRules, location_name: "customRules"))
@@ -750,6 +765,8 @@ module Aws::Amplify
750
765
  UpdateDomainAssociationRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location: "uri", location_name: "domainName"))
751
766
  UpdateDomainAssociationRequest.add_member(:enable_auto_sub_domain, Shapes::ShapeRef.new(shape: EnableAutoSubDomain, location_name: "enableAutoSubDomain"))
752
767
  UpdateDomainAssociationRequest.add_member(:sub_domain_settings, Shapes::ShapeRef.new(shape: SubDomainSettings, required: true, location_name: "subDomainSettings"))
768
+ UpdateDomainAssociationRequest.add_member(:auto_sub_domain_creation_patterns, Shapes::ShapeRef.new(shape: AutoSubDomainCreationPatterns, location_name: "autoSubDomainCreationPatterns"))
769
+ UpdateDomainAssociationRequest.add_member(:auto_sub_domain_iam_role, Shapes::ShapeRef.new(shape: AutoSubDomainIAMRole, location_name: "autoSubDomainIAMRole"))
753
770
  UpdateDomainAssociationRequest.struct_class = Types::UpdateDomainAssociationRequest
754
771
 
755
772
  UpdateDomainAssociationResult.add_member(:domain_association, Shapes::ShapeRef.new(shape: DomainAssociation, required: true, location_name: "domainAssociation"))
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,13 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::Amplify
9
- # This class provides a resource oriented interface for Amplify.
10
- # To create a resource object:
11
- # resource = Aws::Amplify::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::Amplify::Client.new(region: 'us-west-2')
15
- # resource = Aws::Amplify::Resource.new(client: client)
11
+
16
12
  class Resource
17
13
 
18
14
  # @param options ({})
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -8,91 +10,102 @@
8
10
  module Aws::Amplify
9
11
  module Types
10
12
 
11
- # Amplify App represents different branches of a repository for
12
- # building, deploying, and hosting.
13
+ # Represents the different branches of a repository for building,
14
+ # deploying, and hosting an Amplify app.
13
15
  #
14
16
  # @!attribute [rw] app_id
15
- # Unique Id for the Amplify App.
17
+ # The unique ID of the Amplify app.
16
18
  # @return [String]
17
19
  #
18
20
  # @!attribute [rw] app_arn
19
- # ARN for the Amplify App.
21
+ # The Amazon Resource Name (ARN) of the Amplify app.
20
22
  # @return [String]
21
23
  #
22
24
  # @!attribute [rw] name
23
- # Name for the Amplify App.
25
+ # The name for the Amplify app.
24
26
  # @return [String]
25
27
  #
26
28
  # @!attribute [rw] tags
27
- # Tag for Amplify App.
29
+ # The tag for the Amplify app.
28
30
  # @return [Hash<String,String>]
29
31
  #
30
32
  # @!attribute [rw] description
31
- # Description for the Amplify App.
33
+ # The description for the Amplify app.
32
34
  # @return [String]
33
35
  #
34
36
  # @!attribute [rw] repository
35
- # Repository for the Amplify App.
37
+ # The repository for the Amplify app.
36
38
  # @return [String]
37
39
  #
38
40
  # @!attribute [rw] platform
39
- # Platform for the Amplify App.
41
+ # The platform for the Amplify app.
40
42
  # @return [String]
41
43
  #
42
44
  # @!attribute [rw] create_time
43
- # Create date / time for the Amplify App.
45
+ # Creates a date and time for the Amplify app.
44
46
  # @return [Time]
45
47
  #
46
48
  # @!attribute [rw] update_time
47
- # Update date / time for the Amplify App.
49
+ # Updates the date and time for the Amplify app.
48
50
  # @return [Time]
49
51
  #
50
52
  # @!attribute [rw] iam_service_role_arn
51
- # IAM service role ARN for the Amplify App.
53
+ # The AWS Identity and Access Management (IAM) service role for the
54
+ # Amazon Resource Name (ARN) of the Amplify app.
52
55
  # @return [String]
53
56
  #
54
57
  # @!attribute [rw] environment_variables
55
- # Environment Variables for the Amplify App.
58
+ # The environment variables for the Amplify app.
56
59
  # @return [Hash<String,String>]
57
60
  #
58
61
  # @!attribute [rw] default_domain
59
- # Default domain for the Amplify App.
62
+ # The default domain for the Amplify app.
60
63
  # @return [String]
61
64
  #
62
65
  # @!attribute [rw] enable_branch_auto_build
63
- # Enables auto-building of branches for the Amplify App.
66
+ # Enables the auto-building of branches for the Amplify app.
67
+ # @return [Boolean]
68
+ #
69
+ # @!attribute [rw] enable_branch_auto_deletion
70
+ # Automatically disconnects a branch in the Amplify Console when you
71
+ # delete a branch from your Git repository.
64
72
  # @return [Boolean]
65
73
  #
66
74
  # @!attribute [rw] enable_basic_auth
67
- # Enables Basic Authorization for branches for the Amplify App.
75
+ # Enables basic authorization for the Amplify app's branches.
68
76
  # @return [Boolean]
69
77
  #
70
78
  # @!attribute [rw] basic_auth_credentials
71
- # Basic Authorization credentials for branches for the Amplify App.
79
+ # The basic authorization credentials for branches for the Amplify
80
+ # app.
72
81
  # @return [String]
73
82
  #
74
83
  # @!attribute [rw] custom_rules
75
- # Custom redirect / rewrite rules for the Amplify App.
84
+ # Describes the custom redirect and rewrite rules for the Amplify app.
76
85
  # @return [Array<Types::CustomRule>]
77
86
  #
78
87
  # @!attribute [rw] production_branch
79
- # Structure with Production Branch information.
88
+ # Describes the information about a production branch of the Amplify
89
+ # app.
80
90
  # @return [Types::ProductionBranch]
81
91
  #
82
92
  # @!attribute [rw] build_spec
83
- # BuildSpec content for Amplify App.
93
+ # Describes the content of the build specification (build spec) for
94
+ # the Amplify app.
84
95
  # @return [String]
85
96
  #
86
97
  # @!attribute [rw] enable_auto_branch_creation
87
- # Enables automated branch creation for the Amplify App.
98
+ # Enables automated branch creation for the Amplify app.
88
99
  # @return [Boolean]
89
100
  #
90
101
  # @!attribute [rw] auto_branch_creation_patterns
91
- # Automated branch creation glob patterns for the Amplify App.
102
+ # Describes the automated branch creation glob patterns for the
103
+ # Amplify app.
92
104
  # @return [Array<String>]
93
105
  #
94
106
  # @!attribute [rw] auto_branch_creation_config
95
- # Automated branch creation config for the Amplify App.
107
+ # Describes the automated branch creation configuration for the
108
+ # Amplify app.
96
109
  # @return [Types::AutoBranchCreationConfig]
97
110
  #
98
111
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/App AWS API Documentation
@@ -111,6 +124,7 @@ module Aws::Amplify
111
124
  :environment_variables,
112
125
  :default_domain,
113
126
  :enable_branch_auto_build,
127
+ :enable_branch_auto_deletion,
114
128
  :enable_basic_auth,
115
129
  :basic_auth_credentials,
116
130
  :custom_rules,
@@ -119,17 +133,18 @@ module Aws::Amplify
119
133
  :enable_auto_branch_creation,
120
134
  :auto_branch_creation_patterns,
121
135
  :auto_branch_creation_config)
136
+ SENSITIVE = [:basic_auth_credentials]
122
137
  include Aws::Structure
123
138
  end
124
139
 
125
- # Structure for artifact.
140
+ # Describes an artifact.
126
141
  #
127
142
  # @!attribute [rw] artifact_file_name
128
- # File name for the artifact.
143
+ # The file name for the artifact.
129
144
  # @return [String]
130
145
  #
131
146
  # @!attribute [rw] artifact_id
132
- # Unique Id for a artifact.
147
+ # The unique ID for the artifact.
133
148
  # @return [String]
134
149
  #
135
150
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Artifact AWS API Documentation
@@ -137,10 +152,11 @@ module Aws::Amplify
137
152
  class Artifact < Struct.new(
138
153
  :artifact_file_name,
139
154
  :artifact_id)
155
+ SENSITIVE = []
140
156
  include Aws::Structure
141
157
  end
142
158
 
143
- # Structure with auto branch creation config.
159
+ # Describes the automated branch creation configuration.
144
160
  #
145
161
  # @note When making an API call, you may pass AutoBranchCreationConfig
146
162
  # data as a hash:
@@ -160,39 +176,39 @@ module Aws::Amplify
160
176
  # }
161
177
  #
162
178
  # @!attribute [rw] stage
163
- # Stage for the auto created branch.
179
+ # Describes the current stage for the autocreated branch.
164
180
  # @return [String]
165
181
  #
166
182
  # @!attribute [rw] framework
167
- # Framework for the auto created branch.
183
+ # The framework for the autocreated branch.
168
184
  # @return [String]
169
185
  #
170
186
  # @!attribute [rw] enable_auto_build
171
- # Enables auto building for the auto created branch.
187
+ # Enables auto building for the autocreated branch.
172
188
  # @return [Boolean]
173
189
  #
174
190
  # @!attribute [rw] environment_variables
175
- # Environment Variables for the auto created branch.
191
+ # The environment variables for the autocreated branch.
176
192
  # @return [Hash<String,String>]
177
193
  #
178
194
  # @!attribute [rw] basic_auth_credentials
179
- # Basic Authorization credentials for the auto created branch.
195
+ # The basic authorization credentials for the autocreated branch.
180
196
  # @return [String]
181
197
  #
182
198
  # @!attribute [rw] enable_basic_auth
183
- # Enables Basic Auth for the auto created branch.
199
+ # Enables basic authorization for the autocreated branch.
184
200
  # @return [Boolean]
185
201
  #
186
202
  # @!attribute [rw] build_spec
187
- # BuildSpec for the auto created branch.
203
+ # The build specification (build spec) for the autocreated branch.
188
204
  # @return [String]
189
205
  #
190
206
  # @!attribute [rw] enable_pull_request_preview
191
- # Enables Pull Request Preview for auto created branch.
207
+ # Enables pull request preview for the autocreated branch.
192
208
  # @return [Boolean]
193
209
  #
194
210
  # @!attribute [rw] pull_request_environment_name
195
- # The Amplify Environment name for the pull request.
211
+ # The Amplify environment name for the pull request.
196
212
  # @return [String]
197
213
  #
198
214
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/AutoBranchCreationConfig AWS API Documentation
@@ -207,35 +223,37 @@ module Aws::Amplify
207
223
  :build_spec,
208
224
  :enable_pull_request_preview,
209
225
  :pull_request_environment_name)
226
+ SENSITIVE = [:basic_auth_credentials]
210
227
  include Aws::Structure
211
228
  end
212
229
 
213
- # Backend environment for an Amplify App.
230
+ # Describes the backend environment for an Amplify app.
214
231
  #
215
232
  # @!attribute [rw] backend_environment_arn
216
- # Arn for a backend environment, part of an Amplify App.
233
+ # The Amazon Resource Name (ARN) for a backend environment that is
234
+ # part of an Amplify app.
217
235
  # @return [String]
218
236
  #
219
237
  # @!attribute [rw] environment_name
220
- # Name for a backend environment, part of an Amplify App.
238
+ # The name for a backend environment that is part of an Amplify app.
221
239
  # @return [String]
222
240
  #
223
241
  # @!attribute [rw] stack_name
224
- # CloudFormation stack name of backend environment.
242
+ # The AWS CloudFormation stack name of a backend environment.
225
243
  # @return [String]
226
244
  #
227
245
  # @!attribute [rw] deployment_artifacts
228
- # Name of deployment artifacts.
246
+ # The name of deployment artifacts.
229
247
  # @return [String]
230
248
  #
231
249
  # @!attribute [rw] create_time
232
- # Creation date and time for a backend environment, part of an Amplify
233
- # App.
250
+ # The creation date and time for a backend environment that is part of
251
+ # an Amplify app.
234
252
  # @return [Time]
235
253
  #
236
254
  # @!attribute [rw] update_time
237
- # Last updated date and time for a backend environment, part of an
238
- # Amplify App.
255
+ # The last updated date and time for a backend environment that is
256
+ # part of an Amplify app.
239
257
  # @return [Time]
240
258
  #
241
259
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/BackendEnvironment AWS API Documentation
@@ -247,10 +265,11 @@ module Aws::Amplify
247
265
  :deployment_artifacts,
248
266
  :create_time,
249
267
  :update_time)
268
+ SENSITIVE = []
250
269
  include Aws::Structure
251
270
  end
252
271
 
253
- # Exception thrown when a request contains unexpected data.
272
+ # A request contains unexpected data.
254
273
  #
255
274
  # @!attribute [rw] message
256
275
  # @return [String]
@@ -259,103 +278,108 @@ module Aws::Amplify
259
278
  #
260
279
  class BadRequestException < Struct.new(
261
280
  :message)
281
+ SENSITIVE = []
262
282
  include Aws::Structure
263
283
  end
264
284
 
265
- # Branch for an Amplify App, which maps to a 3rd party repository
285
+ # The branch for an Amplify app, which maps to a third-party repository
266
286
  # branch.
267
287
  #
268
288
  # @!attribute [rw] branch_arn
269
- # ARN for a branch, part of an Amplify App.
289
+ # The Amazon Resource Name (ARN) for a branch that is part of an
290
+ # Amplify app.
270
291
  # @return [String]
271
292
  #
272
293
  # @!attribute [rw] branch_name
273
- # Name for a branch, part of an Amplify App.
294
+ # The name for the branch that is part of an Amplify app.
274
295
  # @return [String]
275
296
  #
276
297
  # @!attribute [rw] description
277
- # Description for a branch, part of an Amplify App.
298
+ # The description for the branch that is part of an Amplify app.
278
299
  # @return [String]
279
300
  #
280
301
  # @!attribute [rw] tags
281
- # Tag for branch for Amplify App.
302
+ # The tag for the branch of an Amplify app.
282
303
  # @return [Hash<String,String>]
283
304
  #
284
305
  # @!attribute [rw] stage
285
- # Stage for a branch, part of an Amplify App.
306
+ # The current stage for the branch that is part of an Amplify app.
286
307
  # @return [String]
287
308
  #
288
309
  # @!attribute [rw] display_name
289
- # Display name for a branch, will use as the default domain prefix.
310
+ # The display name for the branch. This is used as the default domain
311
+ # prefix.
290
312
  # @return [String]
291
313
  #
292
314
  # @!attribute [rw] enable_notification
293
- # Enables notifications for a branch, part of an Amplify App.
315
+ # Enables notifications for a branch that is part of an Amplify app.
294
316
  # @return [Boolean]
295
317
  #
296
318
  # @!attribute [rw] create_time
297
- # Creation date and time for a branch, part of an Amplify App.
319
+ # The creation date and time for a branch that is part of an Amplify
320
+ # app.
298
321
  # @return [Time]
299
322
  #
300
323
  # @!attribute [rw] update_time
301
- # Last updated date and time for a branch, part of an Amplify App.
324
+ # The last updated date and time for a branch that is part of an
325
+ # Amplify app.
302
326
  # @return [Time]
303
327
  #
304
328
  # @!attribute [rw] environment_variables
305
- # Environment Variables specific to a branch, part of an Amplify App.
329
+ # The environment variables specific to a branch of an Amplify app.
306
330
  # @return [Hash<String,String>]
307
331
  #
308
332
  # @!attribute [rw] enable_auto_build
309
- # Enables auto-building on push for a branch, part of an Amplify App.
333
+ # Enables auto-building on push for a branch of an Amplify app.
310
334
  # @return [Boolean]
311
335
  #
312
336
  # @!attribute [rw] custom_domains
313
- # Custom domains for a branch, part of an Amplify App.
337
+ # The custom domains for a branch of an Amplify app.
314
338
  # @return [Array<String>]
315
339
  #
316
340
  # @!attribute [rw] framework
317
- # Framework for a branch, part of an Amplify App.
341
+ # The framework for a branch of an Amplify app.
318
342
  # @return [String]
319
343
  #
320
344
  # @!attribute [rw] active_job_id
321
- # Id of the active job for a branch, part of an Amplify App.
345
+ # The ID of the active job for a branch of an Amplify app.
322
346
  # @return [String]
323
347
  #
324
348
  # @!attribute [rw] total_number_of_jobs
325
- # Total number of Jobs part of an Amplify App.
349
+ # The total number of jobs that are part of an Amplify app.
326
350
  # @return [String]
327
351
  #
328
352
  # @!attribute [rw] enable_basic_auth
329
- # Enables Basic Authorization for a branch, part of an Amplify App.
353
+ # Enables basic authorization for a branch of an Amplify app.
330
354
  # @return [Boolean]
331
355
  #
332
356
  # @!attribute [rw] thumbnail_url
333
- # Thumbnail URL for the branch.
357
+ # The thumbnail URL for the branch of an Amplify app.
334
358
  # @return [String]
335
359
  #
336
360
  # @!attribute [rw] basic_auth_credentials
337
- # Basic Authorization credentials for a branch, part of an Amplify
338
- # App.
361
+ # The basic authorization credentials for a branch of an Amplify app.
339
362
  # @return [String]
340
363
  #
341
364
  # @!attribute [rw] build_spec
342
- # BuildSpec content for branch for Amplify App.
365
+ # The build specification (build spec) content for the branch of an
366
+ # Amplify app.
343
367
  # @return [String]
344
368
  #
345
369
  # @!attribute [rw] ttl
346
- # The content TTL for the website in seconds.
370
+ # The content Time to Live (TTL) for the website in seconds.
347
371
  # @return [String]
348
372
  #
349
373
  # @!attribute [rw] associated_resources
350
- # List of custom resources that are linked to this branch.
374
+ # A list of custom resources that are linked to this branch.
351
375
  # @return [Array<String>]
352
376
  #
353
377
  # @!attribute [rw] enable_pull_request_preview
354
- # Enables Pull Request Preview for this branch.
378
+ # Enables pull request preview for the branch.
355
379
  # @return [Boolean]
356
380
  #
357
381
  # @!attribute [rw] pull_request_environment_name
358
- # The Amplify Environment name for the pull request.
382
+ # The Amplify environment name for the pull request.
359
383
  # @return [String]
360
384
  #
361
385
  # @!attribute [rw] destination_branch
@@ -367,7 +391,8 @@ module Aws::Amplify
367
391
  # @return [String]
368
392
  #
369
393
  # @!attribute [rw] backend_environment_arn
370
- # ARN for a Backend Environment, part of an Amplify App.
394
+ # The Amazon Resource Name (ARN) for a backend environment that is
395
+ # part of an Amplify app.
371
396
  # @return [String]
372
397
  #
373
398
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Branch AWS API Documentation
@@ -399,10 +424,11 @@ module Aws::Amplify
399
424
  :destination_branch,
400
425
  :source_branch,
401
426
  :backend_environment_arn)
427
+ SENSITIVE = [:basic_auth_credentials]
402
428
  include Aws::Structure
403
429
  end
404
430
 
405
- # Request structure used to create Apps in Amplify.
431
+ # The request structure used to create apps in Amplify.
406
432
  #
407
433
  # @note When making an API call, you may pass CreateAppRequest
408
434
  # data as a hash:
@@ -419,6 +445,7 @@ module Aws::Amplify
419
445
  # "EnvKey" => "EnvValue",
420
446
  # },
421
447
  # enable_branch_auto_build: false,
448
+ # enable_branch_auto_deletion: false,
422
449
  # enable_basic_auth: false,
423
450
  # basic_auth_credentials: "BasicAuthCredentials",
424
451
  # custom_rules: [
@@ -451,76 +478,82 @@ module Aws::Amplify
451
478
  # }
452
479
  #
453
480
  # @!attribute [rw] name
454
- # Name for the Amplify App
481
+ # The name for the Amplify app.
455
482
  # @return [String]
456
483
  #
457
484
  # @!attribute [rw] description
458
- # Description for an Amplify App
485
+ # The description for an Amplify app.
459
486
  # @return [String]
460
487
  #
461
488
  # @!attribute [rw] repository
462
- # Repository for an Amplify App
489
+ # The repository for an Amplify app.
463
490
  # @return [String]
464
491
  #
465
492
  # @!attribute [rw] platform
466
- # Platform / framework for an Amplify App
493
+ # The platform or framework for an Amplify app.
467
494
  # @return [String]
468
495
  #
469
496
  # @!attribute [rw] iam_service_role_arn
470
- # AWS IAM service role for an Amplify App
497
+ # The AWS Identity and Access Management (IAM) service role for an
498
+ # Amplify app.
471
499
  # @return [String]
472
500
  #
473
501
  # @!attribute [rw] oauth_token
474
- # OAuth token for 3rd party source control system for an Amplify App,
475
- # used to create webhook and read-only deploy key. OAuth token is not
476
- # stored.
502
+ # The OAuth token for a third-party source control system for an
503
+ # Amplify app. The OAuth token is used to create a webhook and a
504
+ # read-only deploy key. The OAuth token is not stored.
477
505
  # @return [String]
478
506
  #
479
507
  # @!attribute [rw] access_token
480
- # Personal Access token for 3rd party source control system for an
481
- # Amplify App, used to create webhook and read-only deploy key. Token
482
- # is not stored.
508
+ # The personal access token for a third-party source control system
509
+ # for an Amplify app. The personal access token is used to create a
510
+ # webhook and a read-only deploy key. The token is not stored.
483
511
  # @return [String]
484
512
  #
485
513
  # @!attribute [rw] environment_variables
486
- # Environment variables map for an Amplify App.
514
+ # The environment variables map for an Amplify app.
487
515
  # @return [Hash<String,String>]
488
516
  #
489
517
  # @!attribute [rw] enable_branch_auto_build
490
- # Enable the auto building of branches for an Amplify App.
518
+ # Enables the auto building of branches for an Amplify app.
519
+ # @return [Boolean]
520
+ #
521
+ # @!attribute [rw] enable_branch_auto_deletion
522
+ # Automatically disconnects a branch in the Amplify Console when you
523
+ # delete a branch from your Git repository.
491
524
  # @return [Boolean]
492
525
  #
493
526
  # @!attribute [rw] enable_basic_auth
494
- # Enable Basic Authorization for an Amplify App, this will apply to
495
- # all branches part of this App.
527
+ # Enables basic authorization for an Amplify app. This will apply to
528
+ # all branches that are part of this app.
496
529
  # @return [Boolean]
497
530
  #
498
531
  # @!attribute [rw] basic_auth_credentials
499
- # Credentials for Basic Authorization for an Amplify App.
532
+ # The credentials for basic authorization for an Amplify app.
500
533
  # @return [String]
501
534
  #
502
535
  # @!attribute [rw] custom_rules
503
- # Custom rewrite / redirect rules for an Amplify App.
536
+ # The custom rewrite and redirect rules for an Amplify app.
504
537
  # @return [Array<Types::CustomRule>]
505
538
  #
506
539
  # @!attribute [rw] tags
507
- # Tag for an Amplify App
540
+ # The tag for an Amplify app.
508
541
  # @return [Hash<String,String>]
509
542
  #
510
543
  # @!attribute [rw] build_spec
511
- # BuildSpec for an Amplify App
544
+ # The build specification (build spec) for an Amplify app.
512
545
  # @return [String]
513
546
  #
514
547
  # @!attribute [rw] enable_auto_branch_creation
515
- # Enables automated branch creation for the Amplify App.
548
+ # Enables automated branch creation for the Amplify app.
516
549
  # @return [Boolean]
517
550
  #
518
551
  # @!attribute [rw] auto_branch_creation_patterns
519
- # Automated branch creation glob patterns for the Amplify App.
552
+ # The automated branch creation glob patterns for the Amplify app.
520
553
  # @return [Array<String>]
521
554
  #
522
555
  # @!attribute [rw] auto_branch_creation_config
523
- # Automated branch creation config for the Amplify App.
556
+ # The automated branch creation configuration for the Amplify app.
524
557
  # @return [Types::AutoBranchCreationConfig]
525
558
  #
526
559
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateAppRequest AWS API Documentation
@@ -535,6 +568,7 @@ module Aws::Amplify
535
568
  :access_token,
536
569
  :environment_variables,
537
570
  :enable_branch_auto_build,
571
+ :enable_branch_auto_deletion,
538
572
  :enable_basic_auth,
539
573
  :basic_auth_credentials,
540
574
  :custom_rules,
@@ -543,22 +577,24 @@ module Aws::Amplify
543
577
  :enable_auto_branch_creation,
544
578
  :auto_branch_creation_patterns,
545
579
  :auto_branch_creation_config)
580
+ SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials]
546
581
  include Aws::Structure
547
582
  end
548
583
 
549
584
  # @!attribute [rw] app
550
- # Amplify App represents different branches of a repository for
551
- # building, deploying, and hosting.
585
+ # Represents the different branches of a repository for building,
586
+ # deploying, and hosting an Amplify app.
552
587
  # @return [Types::App]
553
588
  #
554
589
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateAppResult AWS API Documentation
555
590
  #
556
591
  class CreateAppResult < Struct.new(
557
592
  :app)
593
+ SENSITIVE = []
558
594
  include Aws::Structure
559
595
  end
560
596
 
561
- # Request structure for a backend environment create request.
597
+ # The request structure for the backend environment create request.
562
598
  #
563
599
  # @note When making an API call, you may pass CreateBackendEnvironmentRequest
564
600
  # data as a hash:
@@ -571,19 +607,19 @@ module Aws::Amplify
571
607
  # }
572
608
  #
573
609
  # @!attribute [rw] app_id
574
- # Unique Id for an Amplify App.
610
+ # The unique ID for an Amplify app.
575
611
  # @return [String]
576
612
  #
577
613
  # @!attribute [rw] environment_name
578
- # Name for the backend environment.
614
+ # The name for the backend environment.
579
615
  # @return [String]
580
616
  #
581
617
  # @!attribute [rw] stack_name
582
- # CloudFormation stack name of backend environment.
618
+ # The AWS CloudFormation stack name of a backend environment.
583
619
  # @return [String]
584
620
  #
585
621
  # @!attribute [rw] deployment_artifacts
586
- # Name of deployment artifacts.
622
+ # The name of deployment artifacts.
587
623
  # @return [String]
588
624
  #
589
625
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironmentRequest AWS API Documentation
@@ -593,23 +629,25 @@ module Aws::Amplify
593
629
  :environment_name,
594
630
  :stack_name,
595
631
  :deployment_artifacts)
632
+ SENSITIVE = []
596
633
  include Aws::Structure
597
634
  end
598
635
 
599
- # Result structure for create backend environment.
636
+ # The result structure for the create backend environment request.
600
637
  #
601
638
  # @!attribute [rw] backend_environment
602
- # Backend environment structure for an amplify App.
639
+ # Describes the backend environment for an Amplify app.
603
640
  # @return [Types::BackendEnvironment]
604
641
  #
605
642
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironmentResult AWS API Documentation
606
643
  #
607
644
  class CreateBackendEnvironmentResult < Struct.new(
608
645
  :backend_environment)
646
+ SENSITIVE = []
609
647
  include Aws::Structure
610
648
  end
611
649
 
612
- # Request structure for a branch create request.
650
+ # The request structure for the create branch request.
613
651
  #
614
652
  # @note When making an API call, you may pass CreateBranchRequest
615
653
  # data as a hash:
@@ -639,23 +677,23 @@ module Aws::Amplify
639
677
  # }
640
678
  #
641
679
  # @!attribute [rw] app_id
642
- # Unique Id for an Amplify App.
680
+ # The unique ID for an Amplify app.
643
681
  # @return [String]
644
682
  #
645
683
  # @!attribute [rw] branch_name
646
- # Name for the branch.
684
+ # The name for the branch.
647
685
  # @return [String]
648
686
  #
649
687
  # @!attribute [rw] description
650
- # Description for the branch.
688
+ # The description for the branch.
651
689
  # @return [String]
652
690
  #
653
691
  # @!attribute [rw] stage
654
- # Stage for the branch.
692
+ # Describes the current stage for the branch.
655
693
  # @return [String]
656
694
  #
657
695
  # @!attribute [rw] framework
658
- # Framework for the branch.
696
+ # The framework for the branch.
659
697
  # @return [String]
660
698
  #
661
699
  # @!attribute [rw] enable_notification
@@ -667,43 +705,45 @@ module Aws::Amplify
667
705
  # @return [Boolean]
668
706
  #
669
707
  # @!attribute [rw] environment_variables
670
- # Environment Variables for the branch.
708
+ # The environment variables for the branch.
671
709
  # @return [Hash<String,String>]
672
710
  #
673
711
  # @!attribute [rw] basic_auth_credentials
674
- # Basic Authorization credentials for the branch.
712
+ # The basic authorization credentials for the branch.
675
713
  # @return [String]
676
714
  #
677
715
  # @!attribute [rw] enable_basic_auth
678
- # Enables Basic Auth for the branch.
716
+ # Enables basic authorization for the branch.
679
717
  # @return [Boolean]
680
718
  #
681
719
  # @!attribute [rw] tags
682
- # Tag for the branch.
720
+ # The tag for the branch.
683
721
  # @return [Hash<String,String>]
684
722
  #
685
723
  # @!attribute [rw] build_spec
686
- # BuildSpec for the branch.
724
+ # The build specification (build spec) for the branch.
687
725
  # @return [String]
688
726
  #
689
727
  # @!attribute [rw] ttl
690
- # The content TTL for the website in seconds.
728
+ # The content Time To Live (TTL) for the website in seconds.
691
729
  # @return [String]
692
730
  #
693
731
  # @!attribute [rw] display_name
694
- # Display name for a branch, will use as the default domain prefix.
732
+ # The display name for a branch. This is used as the default domain
733
+ # prefix.
695
734
  # @return [String]
696
735
  #
697
736
  # @!attribute [rw] enable_pull_request_preview
698
- # Enables Pull Request Preview for this branch.
737
+ # Enables pull request preview for this branch.
699
738
  # @return [Boolean]
700
739
  #
701
740
  # @!attribute [rw] pull_request_environment_name
702
- # The Amplify Environment name for the pull request.
741
+ # The Amplify environment name for the pull request.
703
742
  # @return [String]
704
743
  #
705
744
  # @!attribute [rw] backend_environment_arn
706
- # ARN for a Backend Environment, part of an Amplify App.
745
+ # The Amazon Resource Name (ARN) for a backend environment that is
746
+ # part of an Amplify app.
707
747
  # @return [String]
708
748
  #
709
749
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchRequest AWS API Documentation
@@ -726,23 +766,26 @@ module Aws::Amplify
726
766
  :enable_pull_request_preview,
727
767
  :pull_request_environment_name,
728
768
  :backend_environment_arn)
769
+ SENSITIVE = [:basic_auth_credentials]
729
770
  include Aws::Structure
730
771
  end
731
772
 
732
- # Result structure for create branch request.
773
+ # The result structure for create branch request.
733
774
  #
734
775
  # @!attribute [rw] branch
735
- # Branch structure for an Amplify App.
776
+ # Describes the branch for an Amplify app, which maps to a third-party
777
+ # repository branch.
736
778
  # @return [Types::Branch]
737
779
  #
738
780
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchResult AWS API Documentation
739
781
  #
740
782
  class CreateBranchResult < Struct.new(
741
783
  :branch)
784
+ SENSITIVE = []
742
785
  include Aws::Structure
743
786
  end
744
787
 
745
- # Request structure for create a new deployment.
788
+ # The request structure for the create a new deployment request.
746
789
  #
747
790
  # @note When making an API call, you may pass CreateDeploymentRequest
748
791
  # data as a hash:
@@ -756,18 +799,19 @@ module Aws::Amplify
756
799
  # }
757
800
  #
758
801
  # @!attribute [rw] app_id
759
- # Unique Id for an Amplify App.
802
+ # The unique ID for an Amplify app.
760
803
  # @return [String]
761
804
  #
762
805
  # @!attribute [rw] branch_name
763
- # Name for the branch, for the Job.
806
+ # The name for the branch, for the job.
764
807
  # @return [String]
765
808
  #
766
809
  # @!attribute [rw] file_map
767
- # Optional file map that contains file name as the key and file
768
- # content md5 hash as the value. If this argument is provided, the
769
- # service will generate different upload url per file. Otherwise, the
770
- # service will only generate a single upload url for the zipped files.
810
+ # An optional file map that contains the file name as the key and the
811
+ # file content md5 hash as the value. If this argument is provided,
812
+ # the service will generate a unique upload URL per file. Otherwise,
813
+ # the service will only generate a single upload URL for the zipped
814
+ # files.
771
815
  # @return [Hash<String,String>]
772
816
  #
773
817
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeploymentRequest AWS API Documentation
@@ -776,23 +820,24 @@ module Aws::Amplify
776
820
  :app_id,
777
821
  :branch_name,
778
822
  :file_map)
823
+ SENSITIVE = []
779
824
  include Aws::Structure
780
825
  end
781
826
 
782
- # Result structure for create a new deployment.
827
+ # The result structure for the create a new deployment request.
783
828
  #
784
829
  # @!attribute [rw] job_id
785
- # The jobId for this deployment, will supply to start deployment api.
830
+ # The job ID for this deployment. will supply to start deployment api.
786
831
  # @return [String]
787
832
  #
788
833
  # @!attribute [rw] file_upload_urls
789
- # When the fileMap argument is provided in the request, the
790
- # fileUploadUrls will contain a map of file names to upload url.
834
+ # When the `fileMap` argument is provided in the request,
835
+ # `fileUploadUrls` will contain a map of file names to upload URLs.
791
836
  # @return [Hash<String,String>]
792
837
  #
793
838
  # @!attribute [rw] zip_upload_url
794
- # When the fileMap argument is NOT provided. This zipUploadUrl will be
795
- # returned.
839
+ # When the `fileMap` argument is not provided in the request, this
840
+ # `zipUploadUrl` is returned.
796
841
  # @return [String]
797
842
  #
798
843
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeploymentResult AWS API Documentation
@@ -801,10 +846,11 @@ module Aws::Amplify
801
846
  :job_id,
802
847
  :file_upload_urls,
803
848
  :zip_upload_url)
849
+ SENSITIVE = []
804
850
  include Aws::Structure
805
851
  end
806
852
 
807
- # Request structure for create Domain Association request.
853
+ # The request structure for the create domain association request.
808
854
  #
809
855
  # @note When making an API call, you may pass CreateDomainAssociationRequest
810
856
  # data as a hash:
@@ -819,49 +865,65 @@ module Aws::Amplify
819
865
  # branch_name: "BranchName", # required
820
866
  # },
821
867
  # ],
868
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
869
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
822
870
  # }
823
871
  #
824
872
  # @!attribute [rw] app_id
825
- # Unique Id for an Amplify App.
873
+ # The unique ID for an Amplify app.
826
874
  # @return [String]
827
875
  #
828
876
  # @!attribute [rw] domain_name
829
- # Domain name for the Domain Association.
877
+ # The domain name for the domain association.
830
878
  # @return [String]
831
879
  #
832
880
  # @!attribute [rw] enable_auto_sub_domain
833
- # Enables automated creation of Subdomains for branches. (Currently
834
- # not supported)
881
+ # Enables the automated creation of subdomains for branches.
835
882
  # @return [Boolean]
836
883
  #
837
884
  # @!attribute [rw] sub_domain_settings
838
- # Setting structure for the Subdomain.
885
+ # The setting for the subdomain.
839
886
  # @return [Array<Types::SubDomainSetting>]
840
887
  #
888
+ # @!attribute [rw] auto_sub_domain_creation_patterns
889
+ # Sets the branch patterns for automatic subdomain creation.
890
+ # @return [Array<String>]
891
+ #
892
+ # @!attribute [rw] auto_sub_domain_iam_role
893
+ # The required AWS Identity and Access Management (IAM) service role
894
+ # for the Amazon Resource Name (ARN) for automatically creating
895
+ # subdomains.
896
+ # @return [String]
897
+ #
841
898
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociationRequest AWS API Documentation
842
899
  #
843
900
  class CreateDomainAssociationRequest < Struct.new(
844
901
  :app_id,
845
902
  :domain_name,
846
903
  :enable_auto_sub_domain,
847
- :sub_domain_settings)
904
+ :sub_domain_settings,
905
+ :auto_sub_domain_creation_patterns,
906
+ :auto_sub_domain_iam_role)
907
+ SENSITIVE = []
848
908
  include Aws::Structure
849
909
  end
850
910
 
851
- # Result structure for the create Domain Association request.
911
+ # The result structure for the create domain association request.
852
912
  #
853
913
  # @!attribute [rw] domain_association
854
- # Domain Association structure.
914
+ # Describes the structure of a domain association, which associates a
915
+ # custom domain with an Amplify app.
855
916
  # @return [Types::DomainAssociation]
856
917
  #
857
918
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociationResult AWS API Documentation
858
919
  #
859
920
  class CreateDomainAssociationResult < Struct.new(
860
921
  :domain_association)
922
+ SENSITIVE = []
861
923
  include Aws::Structure
862
924
  end
863
925
 
864
- # Request structure for create webhook request.
926
+ # The request structure for the create webhook request.
865
927
  #
866
928
  # @note When making an API call, you may pass CreateWebhookRequest
867
929
  # data as a hash:
@@ -873,15 +935,15 @@ module Aws::Amplify
873
935
  # }
874
936
  #
875
937
  # @!attribute [rw] app_id
876
- # Unique Id for an Amplify App.
938
+ # The unique ID for an Amplify app.
877
939
  # @return [String]
878
940
  #
879
941
  # @!attribute [rw] branch_name
880
- # Name for a branch, part of an Amplify App.
942
+ # The name for a branch that is part of an Amplify app.
881
943
  # @return [String]
882
944
  #
883
945
  # @!attribute [rw] description
884
- # Description for a webhook.
946
+ # The description for a webhook.
885
947
  # @return [String]
886
948
  #
887
949
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhookRequest AWS API Documentation
@@ -890,23 +952,26 @@ module Aws::Amplify
890
952
  :app_id,
891
953
  :branch_name,
892
954
  :description)
955
+ SENSITIVE = []
893
956
  include Aws::Structure
894
957
  end
895
958
 
896
- # Result structure for the create webhook request.
959
+ # The result structure for the create webhook request.
897
960
  #
898
961
  # @!attribute [rw] webhook
899
- # Webhook structure.
962
+ # Describes a webhook that connects repository events to an Amplify
963
+ # app.
900
964
  # @return [Types::Webhook]
901
965
  #
902
966
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhookResult AWS API Documentation
903
967
  #
904
968
  class CreateWebhookResult < Struct.new(
905
969
  :webhook)
970
+ SENSITIVE = []
906
971
  include Aws::Structure
907
972
  end
908
973
 
909
- # Custom rewrite / redirect rule.
974
+ # Describes a custom rewrite or redirect rule.
910
975
  #
911
976
  # @note When making an API call, you may pass CustomRule
912
977
  # data as a hash:
@@ -931,7 +996,8 @@ module Aws::Amplify
931
996
  # @return [String]
932
997
  #
933
998
  # @!attribute [rw] condition
934
- # The condition for a URL rewrite or redirect rule, e.g. country code.
999
+ # The condition for a URL rewrite or redirect rule, such as a country
1000
+ # code.
935
1001
  # @return [String]
936
1002
  #
937
1003
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CustomRule AWS API Documentation
@@ -941,10 +1007,11 @@ module Aws::Amplify
941
1007
  :target,
942
1008
  :status,
943
1009
  :condition)
1010
+ SENSITIVE = []
944
1011
  include Aws::Structure
945
1012
  end
946
1013
 
947
- # Request structure for an Amplify App delete request.
1014
+ # Describes the request structure for the delete app request.
948
1015
  #
949
1016
  # @note When making an API call, you may pass DeleteAppRequest
950
1017
  # data as a hash:
@@ -954,31 +1021,33 @@ module Aws::Amplify
954
1021
  # }
955
1022
  #
956
1023
  # @!attribute [rw] app_id
957
- # Unique Id for an Amplify App.
1024
+ # The unique ID for an Amplify app.
958
1025
  # @return [String]
959
1026
  #
960
1027
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteAppRequest AWS API Documentation
961
1028
  #
962
1029
  class DeleteAppRequest < Struct.new(
963
1030
  :app_id)
1031
+ SENSITIVE = []
964
1032
  include Aws::Structure
965
1033
  end
966
1034
 
967
- # Result structure for an Amplify App delete request.
1035
+ # The result structure for the delete app request.
968
1036
  #
969
1037
  # @!attribute [rw] app
970
- # Amplify App represents different branches of a repository for
971
- # building, deploying, and hosting.
1038
+ # Represents the different branches of a repository for building,
1039
+ # deploying, and hosting an Amplify app.
972
1040
  # @return [Types::App]
973
1041
  #
974
1042
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteAppResult AWS API Documentation
975
1043
  #
976
1044
  class DeleteAppResult < Struct.new(
977
1045
  :app)
1046
+ SENSITIVE = []
978
1047
  include Aws::Structure
979
1048
  end
980
1049
 
981
- # Request structure for delete backend environment request.
1050
+ # The request structure for the delete backend environment request.
982
1051
  #
983
1052
  # @note When making an API call, you may pass DeleteBackendEnvironmentRequest
984
1053
  # data as a hash:
@@ -989,11 +1058,11 @@ module Aws::Amplify
989
1058
  # }
990
1059
  #
991
1060
  # @!attribute [rw] app_id
992
- # Unique Id of an Amplify App.
1061
+ # The unique ID of an Amplify app.
993
1062
  # @return [String]
994
1063
  #
995
1064
  # @!attribute [rw] environment_name
996
- # Name of a backend environment of an Amplify App.
1065
+ # The name of a backend environment of an Amplify app.
997
1066
  # @return [String]
998
1067
  #
999
1068
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironmentRequest AWS API Documentation
@@ -1001,23 +1070,25 @@ module Aws::Amplify
1001
1070
  class DeleteBackendEnvironmentRequest < Struct.new(
1002
1071
  :app_id,
1003
1072
  :environment_name)
1073
+ SENSITIVE = []
1004
1074
  include Aws::Structure
1005
1075
  end
1006
1076
 
1007
- # Result structure of a delete backend environment result.
1077
+ # The result structure of the delete backend environment result.
1008
1078
  #
1009
1079
  # @!attribute [rw] backend_environment
1010
- # Backend environment structure for an Amplify App.
1080
+ # Describes the backend environment for an Amplify app.
1011
1081
  # @return [Types::BackendEnvironment]
1012
1082
  #
1013
1083
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironmentResult AWS API Documentation
1014
1084
  #
1015
1085
  class DeleteBackendEnvironmentResult < Struct.new(
1016
1086
  :backend_environment)
1087
+ SENSITIVE = []
1017
1088
  include Aws::Structure
1018
1089
  end
1019
1090
 
1020
- # Request structure for delete branch request.
1091
+ # The request structure for the delete branch request.
1021
1092
  #
1022
1093
  # @note When making an API call, you may pass DeleteBranchRequest
1023
1094
  # data as a hash:
@@ -1028,11 +1099,11 @@ module Aws::Amplify
1028
1099
  # }
1029
1100
  #
1030
1101
  # @!attribute [rw] app_id
1031
- # Unique Id for an Amplify App.
1102
+ # The unique ID for an Amplify app.
1032
1103
  # @return [String]
1033
1104
  #
1034
1105
  # @!attribute [rw] branch_name
1035
- # Name for the branch.
1106
+ # The name for the branch.
1036
1107
  # @return [String]
1037
1108
  #
1038
1109
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranchRequest AWS API Documentation
@@ -1040,23 +1111,26 @@ module Aws::Amplify
1040
1111
  class DeleteBranchRequest < Struct.new(
1041
1112
  :app_id,
1042
1113
  :branch_name)
1114
+ SENSITIVE = []
1043
1115
  include Aws::Structure
1044
1116
  end
1045
1117
 
1046
- # Result structure for delete branch request.
1118
+ # The result structure for the delete branch request.
1047
1119
  #
1048
1120
  # @!attribute [rw] branch
1049
- # Branch structure for an Amplify App.
1121
+ # The branch for an Amplify app, which maps to a third-party
1122
+ # repository branch.
1050
1123
  # @return [Types::Branch]
1051
1124
  #
1052
1125
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranchResult AWS API Documentation
1053
1126
  #
1054
1127
  class DeleteBranchResult < Struct.new(
1055
1128
  :branch)
1129
+ SENSITIVE = []
1056
1130
  include Aws::Structure
1057
1131
  end
1058
1132
 
1059
- # Request structure for the delete Domain Association request.
1133
+ # The request structure for the delete domain association request.
1060
1134
  #
1061
1135
  # @note When making an API call, you may pass DeleteDomainAssociationRequest
1062
1136
  # data as a hash:
@@ -1067,11 +1141,11 @@ module Aws::Amplify
1067
1141
  # }
1068
1142
  #
1069
1143
  # @!attribute [rw] app_id
1070
- # Unique Id for an Amplify App.
1144
+ # The unique id for an Amplify app.
1071
1145
  # @return [String]
1072
1146
  #
1073
1147
  # @!attribute [rw] domain_name
1074
- # Name of the domain.
1148
+ # The name of the domain.
1075
1149
  # @return [String]
1076
1150
  #
1077
1151
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociationRequest AWS API Documentation
@@ -1079,22 +1153,24 @@ module Aws::Amplify
1079
1153
  class DeleteDomainAssociationRequest < Struct.new(
1080
1154
  :app_id,
1081
1155
  :domain_name)
1156
+ SENSITIVE = []
1082
1157
  include Aws::Structure
1083
1158
  end
1084
1159
 
1085
1160
  # @!attribute [rw] domain_association
1086
- # Structure for Domain Association, which associates a custom domain
1087
- # with an Amplify App.
1161
+ # Describes a domain association that associates a custom domain with
1162
+ # an Amplify app.
1088
1163
  # @return [Types::DomainAssociation]
1089
1164
  #
1090
1165
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociationResult AWS API Documentation
1091
1166
  #
1092
1167
  class DeleteDomainAssociationResult < Struct.new(
1093
1168
  :domain_association)
1169
+ SENSITIVE = []
1094
1170
  include Aws::Structure
1095
1171
  end
1096
1172
 
1097
- # Request structure for delete job request.
1173
+ # The request structure for the delete job request.
1098
1174
  #
1099
1175
  # @note When making an API call, you may pass DeleteJobRequest
1100
1176
  # data as a hash:
@@ -1106,15 +1182,15 @@ module Aws::Amplify
1106
1182
  # }
1107
1183
  #
1108
1184
  # @!attribute [rw] app_id
1109
- # Unique Id for an Amplify App.
1185
+ # The unique ID for an Amplify app.
1110
1186
  # @return [String]
1111
1187
  #
1112
1188
  # @!attribute [rw] branch_name
1113
- # Name for the branch, for the Job.
1189
+ # The name for the branch, for the job.
1114
1190
  # @return [String]
1115
1191
  #
1116
1192
  # @!attribute [rw] job_id
1117
- # Unique Id for the Job.
1193
+ # The unique ID for the job.
1118
1194
  # @return [String]
1119
1195
  #
1120
1196
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJobRequest AWS API Documentation
@@ -1123,23 +1199,25 @@ module Aws::Amplify
1123
1199
  :app_id,
1124
1200
  :branch_name,
1125
1201
  :job_id)
1202
+ SENSITIVE = []
1126
1203
  include Aws::Structure
1127
1204
  end
1128
1205
 
1129
- # Result structure for the delete job request.
1206
+ # The result structure for the delete job request.
1130
1207
  #
1131
1208
  # @!attribute [rw] job_summary
1132
- # Structure for the summary of a Job.
1209
+ # Describes the summary for an execution job for an Amplify app.
1133
1210
  # @return [Types::JobSummary]
1134
1211
  #
1135
1212
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJobResult AWS API Documentation
1136
1213
  #
1137
1214
  class DeleteJobResult < Struct.new(
1138
1215
  :job_summary)
1216
+ SENSITIVE = []
1139
1217
  include Aws::Structure
1140
1218
  end
1141
1219
 
1142
- # Request structure for the delete webhook request.
1220
+ # The request structure for the delete webhook request.
1143
1221
  #
1144
1222
  # @note When making an API call, you may pass DeleteWebhookRequest
1145
1223
  # data as a hash:
@@ -1149,31 +1227,33 @@ module Aws::Amplify
1149
1227
  # }
1150
1228
  #
1151
1229
  # @!attribute [rw] webhook_id
1152
- # Unique Id for a webhook.
1230
+ # The unique ID for a webhook.
1153
1231
  # @return [String]
1154
1232
  #
1155
1233
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhookRequest AWS API Documentation
1156
1234
  #
1157
1235
  class DeleteWebhookRequest < Struct.new(
1158
1236
  :webhook_id)
1237
+ SENSITIVE = []
1159
1238
  include Aws::Structure
1160
1239
  end
1161
1240
 
1162
- # Result structure for the delete webhook request.
1241
+ # The result structure for the delete webhook request.
1163
1242
  #
1164
1243
  # @!attribute [rw] webhook
1165
- # Webhook structure.
1244
+ # Describes a webhook that connects repository events to an Amplify
1245
+ # app.
1166
1246
  # @return [Types::Webhook]
1167
1247
  #
1168
1248
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhookResult AWS API Documentation
1169
1249
  #
1170
1250
  class DeleteWebhookResult < Struct.new(
1171
1251
  :webhook)
1252
+ SENSITIVE = []
1172
1253
  include Aws::Structure
1173
1254
  end
1174
1255
 
1175
- # Exception thrown when an operation fails due to a dependent service
1176
- # throwing an exception.
1256
+ # An operation failed because a dependent service threw an exception.
1177
1257
  #
1178
1258
  # @!attribute [rw] message
1179
1259
  # @return [String]
@@ -1182,39 +1262,49 @@ module Aws::Amplify
1182
1262
  #
1183
1263
  class DependentServiceFailureException < Struct.new(
1184
1264
  :message)
1265
+ SENSITIVE = []
1185
1266
  include Aws::Structure
1186
1267
  end
1187
1268
 
1188
- # Structure for Domain Association, which associates a custom domain
1189
- # with an Amplify App.
1269
+ # Describes a domain association that associates a custom domain with an
1270
+ # Amplify app.
1190
1271
  #
1191
1272
  # @!attribute [rw] domain_association_arn
1192
- # ARN for the Domain Association.
1273
+ # The Amazon Resource Name (ARN) for the domain association.
1193
1274
  # @return [String]
1194
1275
  #
1195
1276
  # @!attribute [rw] domain_name
1196
- # Name of the domain.
1277
+ # The name of the domain.
1197
1278
  # @return [String]
1198
1279
  #
1199
1280
  # @!attribute [rw] enable_auto_sub_domain
1200
- # Enables automated creation of Subdomains for branches. (Currently
1201
- # not supported)
1281
+ # Enables the automated creation of subdomains for branches.
1202
1282
  # @return [Boolean]
1203
1283
  #
1284
+ # @!attribute [rw] auto_sub_domain_creation_patterns
1285
+ # Sets branch patterns for automatic subdomain creation.
1286
+ # @return [Array<String>]
1287
+ #
1288
+ # @!attribute [rw] auto_sub_domain_iam_role
1289
+ # The required AWS Identity and Access Management (IAM) service role
1290
+ # for the Amazon Resource Name (ARN) for automatically creating
1291
+ # subdomains.
1292
+ # @return [String]
1293
+ #
1204
1294
  # @!attribute [rw] domain_status
1205
- # Status fo the Domain Association.
1295
+ # The current status of the domain association.
1206
1296
  # @return [String]
1207
1297
  #
1208
1298
  # @!attribute [rw] status_reason
1209
- # Reason for the current status of the Domain Association.
1299
+ # The reason for the current status of the domain association.
1210
1300
  # @return [String]
1211
1301
  #
1212
1302
  # @!attribute [rw] certificate_verification_dns_record
1213
- # DNS Record for certificate verification.
1303
+ # The DNS record for certificate verification.
1214
1304
  # @return [String]
1215
1305
  #
1216
1306
  # @!attribute [rw] sub_domains
1217
- # Subdomains for the Domain Association.
1307
+ # The subdomains for the domain association.
1218
1308
  # @return [Array<Types::SubDomain>]
1219
1309
  #
1220
1310
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DomainAssociation AWS API Documentation
@@ -1223,14 +1313,17 @@ module Aws::Amplify
1223
1313
  :domain_association_arn,
1224
1314
  :domain_name,
1225
1315
  :enable_auto_sub_domain,
1316
+ :auto_sub_domain_creation_patterns,
1317
+ :auto_sub_domain_iam_role,
1226
1318
  :domain_status,
1227
1319
  :status_reason,
1228
1320
  :certificate_verification_dns_record,
1229
1321
  :sub_domains)
1322
+ SENSITIVE = []
1230
1323
  include Aws::Structure
1231
1324
  end
1232
1325
 
1233
- # Request structure for the generate access logs request.
1326
+ # The request structure for the generate access logs request.
1234
1327
  #
1235
1328
  # @note When making an API call, you may pass GenerateAccessLogsRequest
1236
1329
  # data as a hash:
@@ -1243,19 +1336,21 @@ module Aws::Amplify
1243
1336
  # }
1244
1337
  #
1245
1338
  # @!attribute [rw] start_time
1246
- # The time at which the logs should start, inclusive.
1339
+ # The time at which the logs should start. The time range specified is
1340
+ # inclusive of the start time.
1247
1341
  # @return [Time]
1248
1342
  #
1249
1343
  # @!attribute [rw] end_time
1250
- # The time at which the logs should end, inclusive.
1344
+ # The time at which the logs should end. The time range specified is
1345
+ # inclusive of the end time.
1251
1346
  # @return [Time]
1252
1347
  #
1253
1348
  # @!attribute [rw] domain_name
1254
- # Name of the domain.
1349
+ # The name of the domain.
1255
1350
  # @return [String]
1256
1351
  #
1257
1352
  # @!attribute [rw] app_id
1258
- # Unique Id for an Amplify App.
1353
+ # The unique ID for an Amplify app.
1259
1354
  # @return [String]
1260
1355
  #
1261
1356
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GenerateAccessLogsRequest AWS API Documentation
@@ -1265,23 +1360,25 @@ module Aws::Amplify
1265
1360
  :end_time,
1266
1361
  :domain_name,
1267
1362
  :app_id)
1363
+ SENSITIVE = []
1268
1364
  include Aws::Structure
1269
1365
  end
1270
1366
 
1271
- # Result structure for the generate access logs request.
1367
+ # The result structure for the generate access logs request.
1272
1368
  #
1273
1369
  # @!attribute [rw] log_url
1274
- # Pre-signed URL for the requested access logs.
1370
+ # The pre-signed URL for the requested access logs.
1275
1371
  # @return [String]
1276
1372
  #
1277
1373
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GenerateAccessLogsResult AWS API Documentation
1278
1374
  #
1279
1375
  class GenerateAccessLogsResult < Struct.new(
1280
1376
  :log_url)
1377
+ SENSITIVE = []
1281
1378
  include Aws::Structure
1282
1379
  end
1283
1380
 
1284
- # Request structure for get App request.
1381
+ # The request structure for the get app request.
1285
1382
  #
1286
1383
  # @note When making an API call, you may pass GetAppRequest
1287
1384
  # data as a hash:
@@ -1291,29 +1388,31 @@ module Aws::Amplify
1291
1388
  # }
1292
1389
  #
1293
1390
  # @!attribute [rw] app_id
1294
- # Unique Id for an Amplify App.
1391
+ # The unique ID for an Amplify app.
1295
1392
  # @return [String]
1296
1393
  #
1297
1394
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetAppRequest AWS API Documentation
1298
1395
  #
1299
1396
  class GetAppRequest < Struct.new(
1300
1397
  :app_id)
1398
+ SENSITIVE = []
1301
1399
  include Aws::Structure
1302
1400
  end
1303
1401
 
1304
1402
  # @!attribute [rw] app
1305
- # Amplify App represents different branches of a repository for
1306
- # building, deploying, and hosting.
1403
+ # Represents the different branches of a repository for building,
1404
+ # deploying, and hosting an Amplify app.
1307
1405
  # @return [Types::App]
1308
1406
  #
1309
1407
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetAppResult AWS API Documentation
1310
1408
  #
1311
1409
  class GetAppResult < Struct.new(
1312
1410
  :app)
1411
+ SENSITIVE = []
1313
1412
  include Aws::Structure
1314
1413
  end
1315
1414
 
1316
- # Request structure for the get artifact request.
1415
+ # Returns the request structure for the get artifact request.
1317
1416
  #
1318
1417
  # @note When making an API call, you may pass GetArtifactUrlRequest
1319
1418
  # data as a hash:
@@ -1323,24 +1422,25 @@ module Aws::Amplify
1323
1422
  # }
1324
1423
  #
1325
1424
  # @!attribute [rw] artifact_id
1326
- # Unique Id for a artifact.
1425
+ # The unique ID for an artifact.
1327
1426
  # @return [String]
1328
1427
  #
1329
1428
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetArtifactUrlRequest AWS API Documentation
1330
1429
  #
1331
1430
  class GetArtifactUrlRequest < Struct.new(
1332
1431
  :artifact_id)
1432
+ SENSITIVE = []
1333
1433
  include Aws::Structure
1334
1434
  end
1335
1435
 
1336
- # Result structure for the get artifact request.
1436
+ # Returns the result structure for the get artifact request.
1337
1437
  #
1338
1438
  # @!attribute [rw] artifact_id
1339
- # Unique Id for a artifact.
1439
+ # The unique ID for an artifact.
1340
1440
  # @return [String]
1341
1441
  #
1342
1442
  # @!attribute [rw] artifact_url
1343
- # Presigned url for the artifact.
1443
+ # The presigned URL for the artifact.
1344
1444
  # @return [String]
1345
1445
  #
1346
1446
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetArtifactUrlResult AWS API Documentation
@@ -1348,10 +1448,11 @@ module Aws::Amplify
1348
1448
  class GetArtifactUrlResult < Struct.new(
1349
1449
  :artifact_id,
1350
1450
  :artifact_url)
1451
+ SENSITIVE = []
1351
1452
  include Aws::Structure
1352
1453
  end
1353
1454
 
1354
- # Request structure for get backend environment request.
1455
+ # The request structure for the get backend environment request.
1355
1456
  #
1356
1457
  # @note When making an API call, you may pass GetBackendEnvironmentRequest
1357
1458
  # data as a hash:
@@ -1362,11 +1463,11 @@ module Aws::Amplify
1362
1463
  # }
1363
1464
  #
1364
1465
  # @!attribute [rw] app_id
1365
- # Unique Id for an Amplify App.
1466
+ # The unique id for an Amplify app.
1366
1467
  # @return [String]
1367
1468
  #
1368
1469
  # @!attribute [rw] environment_name
1369
- # Name for the backend environment.
1470
+ # The name for the backend environment.
1370
1471
  # @return [String]
1371
1472
  #
1372
1473
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironmentRequest AWS API Documentation
@@ -1374,23 +1475,25 @@ module Aws::Amplify
1374
1475
  class GetBackendEnvironmentRequest < Struct.new(
1375
1476
  :app_id,
1376
1477
  :environment_name)
1478
+ SENSITIVE = []
1377
1479
  include Aws::Structure
1378
1480
  end
1379
1481
 
1380
- # Result structure for get backend environment result.
1482
+ # The result structure for the get backend environment result.
1381
1483
  #
1382
1484
  # @!attribute [rw] backend_environment
1383
- # Backend environment structure for an an Amplify App.
1485
+ # Describes the backend environment for an Amplify app.
1384
1486
  # @return [Types::BackendEnvironment]
1385
1487
  #
1386
1488
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironmentResult AWS API Documentation
1387
1489
  #
1388
1490
  class GetBackendEnvironmentResult < Struct.new(
1389
1491
  :backend_environment)
1492
+ SENSITIVE = []
1390
1493
  include Aws::Structure
1391
1494
  end
1392
1495
 
1393
- # Request structure for get branch request.
1496
+ # The request structure for the get branch request.
1394
1497
  #
1395
1498
  # @note When making an API call, you may pass GetBranchRequest
1396
1499
  # data as a hash:
@@ -1401,11 +1504,11 @@ module Aws::Amplify
1401
1504
  # }
1402
1505
  #
1403
1506
  # @!attribute [rw] app_id
1404
- # Unique Id for an Amplify App.
1507
+ # The unique ID for an Amplify app.
1405
1508
  # @return [String]
1406
1509
  #
1407
1510
  # @!attribute [rw] branch_name
1408
- # Name for the branch.
1511
+ # The name for the branch.
1409
1512
  # @return [String]
1410
1513
  #
1411
1514
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranchRequest AWS API Documentation
@@ -1413,22 +1516,24 @@ module Aws::Amplify
1413
1516
  class GetBranchRequest < Struct.new(
1414
1517
  :app_id,
1415
1518
  :branch_name)
1519
+ SENSITIVE = []
1416
1520
  include Aws::Structure
1417
1521
  end
1418
1522
 
1419
1523
  # @!attribute [rw] branch
1420
- # Branch for an Amplify App, which maps to a 3rd party repository
1421
- # branch.
1524
+ # The branch for an Amplify app, which maps to a third-party
1525
+ # repository branch.
1422
1526
  # @return [Types::Branch]
1423
1527
  #
1424
1528
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranchResult AWS API Documentation
1425
1529
  #
1426
1530
  class GetBranchResult < Struct.new(
1427
1531
  :branch)
1532
+ SENSITIVE = []
1428
1533
  include Aws::Structure
1429
1534
  end
1430
1535
 
1431
- # Request structure for the get Domain Association request.
1536
+ # The request structure for the get domain association request.
1432
1537
  #
1433
1538
  # @note When making an API call, you may pass GetDomainAssociationRequest
1434
1539
  # data as a hash:
@@ -1439,11 +1544,11 @@ module Aws::Amplify
1439
1544
  # }
1440
1545
  #
1441
1546
  # @!attribute [rw] app_id
1442
- # Unique Id for an Amplify App.
1547
+ # The unique id for an Amplify app.
1443
1548
  # @return [String]
1444
1549
  #
1445
1550
  # @!attribute [rw] domain_name
1446
- # Name of the domain.
1551
+ # The name of the domain.
1447
1552
  # @return [String]
1448
1553
  #
1449
1554
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociationRequest AWS API Documentation
@@ -1451,23 +1556,26 @@ module Aws::Amplify
1451
1556
  class GetDomainAssociationRequest < Struct.new(
1452
1557
  :app_id,
1453
1558
  :domain_name)
1559
+ SENSITIVE = []
1454
1560
  include Aws::Structure
1455
1561
  end
1456
1562
 
1457
- # Result structure for the get Domain Association request.
1563
+ # The result structure for the get domain association request.
1458
1564
  #
1459
1565
  # @!attribute [rw] domain_association
1460
- # Domain Association structure.
1566
+ # Describes the structure of a domain association, which associates a
1567
+ # custom domain with an Amplify app.
1461
1568
  # @return [Types::DomainAssociation]
1462
1569
  #
1463
1570
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociationResult AWS API Documentation
1464
1571
  #
1465
1572
  class GetDomainAssociationResult < Struct.new(
1466
1573
  :domain_association)
1574
+ SENSITIVE = []
1467
1575
  include Aws::Structure
1468
1576
  end
1469
1577
 
1470
- # Request structure for get job request.
1578
+ # The request structure for the get job request.
1471
1579
  #
1472
1580
  # @note When making an API call, you may pass GetJobRequest
1473
1581
  # data as a hash:
@@ -1479,15 +1587,15 @@ module Aws::Amplify
1479
1587
  # }
1480
1588
  #
1481
1589
  # @!attribute [rw] app_id
1482
- # Unique Id for an Amplify App.
1590
+ # The unique ID for an Amplify app.
1483
1591
  # @return [String]
1484
1592
  #
1485
1593
  # @!attribute [rw] branch_name
1486
- # Name for the branch, for the Job.
1594
+ # The branch name for the job.
1487
1595
  # @return [String]
1488
1596
  #
1489
1597
  # @!attribute [rw] job_id
1490
- # Unique Id for the Job.
1598
+ # The unique ID for the job.
1491
1599
  # @return [String]
1492
1600
  #
1493
1601
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJobRequest AWS API Documentation
@@ -1496,21 +1604,23 @@ module Aws::Amplify
1496
1604
  :app_id,
1497
1605
  :branch_name,
1498
1606
  :job_id)
1607
+ SENSITIVE = []
1499
1608
  include Aws::Structure
1500
1609
  end
1501
1610
 
1502
1611
  # @!attribute [rw] job
1503
- # Structure for an execution job for an Amplify App.
1612
+ # Describes an execution job for an Amplify app.
1504
1613
  # @return [Types::Job]
1505
1614
  #
1506
1615
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJobResult AWS API Documentation
1507
1616
  #
1508
1617
  class GetJobResult < Struct.new(
1509
1618
  :job)
1619
+ SENSITIVE = []
1510
1620
  include Aws::Structure
1511
1621
  end
1512
1622
 
1513
- # Request structure for the get webhook request.
1623
+ # The request structure for the get webhook request.
1514
1624
  #
1515
1625
  # @note When making an API call, you may pass GetWebhookRequest
1516
1626
  # data as a hash:
@@ -1520,31 +1630,32 @@ module Aws::Amplify
1520
1630
  # }
1521
1631
  #
1522
1632
  # @!attribute [rw] webhook_id
1523
- # Unique Id for a webhook.
1633
+ # The unique ID for a webhook.
1524
1634
  # @return [String]
1525
1635
  #
1526
1636
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhookRequest AWS API Documentation
1527
1637
  #
1528
1638
  class GetWebhookRequest < Struct.new(
1529
1639
  :webhook_id)
1640
+ SENSITIVE = []
1530
1641
  include Aws::Structure
1531
1642
  end
1532
1643
 
1533
- # Result structure for the get webhook request.
1644
+ # The result structure for the get webhook request.
1534
1645
  #
1535
1646
  # @!attribute [rw] webhook
1536
- # Webhook structure.
1647
+ # Describes the structure of a webhook.
1537
1648
  # @return [Types::Webhook]
1538
1649
  #
1539
1650
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhookResult AWS API Documentation
1540
1651
  #
1541
1652
  class GetWebhookResult < Struct.new(
1542
1653
  :webhook)
1654
+ SENSITIVE = []
1543
1655
  include Aws::Structure
1544
1656
  end
1545
1657
 
1546
- # Exception thrown when the service fails to perform an operation due to
1547
- # an internal issue.
1658
+ # The service failed to perform an operation due to an internal issue.
1548
1659
  #
1549
1660
  # @!attribute [rw] message
1550
1661
  # @return [String]
@@ -1553,17 +1664,18 @@ module Aws::Amplify
1553
1664
  #
1554
1665
  class InternalFailureException < Struct.new(
1555
1666
  :message)
1667
+ SENSITIVE = []
1556
1668
  include Aws::Structure
1557
1669
  end
1558
1670
 
1559
- # Structure for an execution job for an Amplify App.
1671
+ # Describes an execution job for an Amplify app.
1560
1672
  #
1561
1673
  # @!attribute [rw] summary
1562
- # Summary for an execution job for an Amplify App.
1674
+ # Describes the summary for an execution job for an Amplify app.
1563
1675
  # @return [Types::JobSummary]
1564
1676
  #
1565
1677
  # @!attribute [rw] steps
1566
- # Execution steps for an execution job, for an Amplify App.
1678
+ # The execution steps for an execution job, for an Amplify app.
1567
1679
  # @return [Array<Types::Step>]
1568
1680
  #
1569
1681
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Job AWS API Documentation
@@ -1571,47 +1683,51 @@ module Aws::Amplify
1571
1683
  class Job < Struct.new(
1572
1684
  :summary,
1573
1685
  :steps)
1686
+ SENSITIVE = []
1574
1687
  include Aws::Structure
1575
1688
  end
1576
1689
 
1577
- # Structure for the summary of a Job.
1690
+ # Describes the summary for an execution job for an Amplify app.
1578
1691
  #
1579
1692
  # @!attribute [rw] job_arn
1580
- # Arn for the Job.
1693
+ # The Amazon Resource Name (ARN) for the job.
1581
1694
  # @return [String]
1582
1695
  #
1583
1696
  # @!attribute [rw] job_id
1584
- # Unique Id for the Job.
1697
+ # The unique ID for the job.
1585
1698
  # @return [String]
1586
1699
  #
1587
1700
  # @!attribute [rw] commit_id
1588
- # Commit Id from 3rd party repository provider for the Job.
1701
+ # The commit ID from a third-party repository provider for the job.
1589
1702
  # @return [String]
1590
1703
  #
1591
1704
  # @!attribute [rw] commit_message
1592
- # Commit message from 3rd party repository provider for the Job.
1705
+ # The commit message from a third-party repository provider for the
1706
+ # job.
1593
1707
  # @return [String]
1594
1708
  #
1595
1709
  # @!attribute [rw] commit_time
1596
- # Commit date / time for the Job.
1710
+ # The commit date and time for the job.
1597
1711
  # @return [Time]
1598
1712
  #
1599
1713
  # @!attribute [rw] start_time
1600
- # Start date / time for the Job.
1714
+ # The start date and time for the job.
1601
1715
  # @return [Time]
1602
1716
  #
1603
1717
  # @!attribute [rw] status
1604
- # Status for the Job.
1718
+ # The current status for the job.
1605
1719
  # @return [String]
1606
1720
  #
1607
1721
  # @!attribute [rw] end_time
1608
- # End date / time for the Job.
1722
+ # The end date and time for the job.
1609
1723
  # @return [Time]
1610
1724
  #
1611
1725
  # @!attribute [rw] job_type
1612
- # Type for the Job. \\n "RELEASE": Manually released from source by
1613
- # using StartJob API. "RETRY": Manually retried by using StartJob
1614
- # API. "WEB\_HOOK": Automatically triggered by WebHooks.
1726
+ # The type for the job. If the value is `RELEASE`, the job was
1727
+ # manually released from its source by using the `StartJob` API. If
1728
+ # the value is `RETRY`, the job was manually retried using the
1729
+ # `StartJob` API. If the value is `WEB_HOOK`, the job was
1730
+ # automatically triggered by webhooks.
1615
1731
  # @return [String]
1616
1732
  #
1617
1733
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/JobSummary AWS API Documentation
@@ -1626,11 +1742,11 @@ module Aws::Amplify
1626
1742
  :status,
1627
1743
  :end_time,
1628
1744
  :job_type)
1745
+ SENSITIVE = []
1629
1746
  include Aws::Structure
1630
1747
  end
1631
1748
 
1632
- # Exception thrown when a resource could not be created because of
1633
- # service limits.
1749
+ # A resource could not be created because service quotas were exceeded.
1634
1750
  #
1635
1751
  # @!attribute [rw] message
1636
1752
  # @return [String]
@@ -1639,10 +1755,11 @@ module Aws::Amplify
1639
1755
  #
1640
1756
  class LimitExceededException < Struct.new(
1641
1757
  :message)
1758
+ SENSITIVE = []
1642
1759
  include Aws::Structure
1643
1760
  end
1644
1761
 
1645
- # Request structure for an Amplify App list request.
1762
+ # The request structure for the list apps request.
1646
1763
  #
1647
1764
  # @note When making an API call, you may pass ListAppsRequest
1648
1765
  # data as a hash:
@@ -1653,13 +1770,13 @@ module Aws::Amplify
1653
1770
  # }
1654
1771
  #
1655
1772
  # @!attribute [rw] next_token
1656
- # Pagination token. If non-null pagination token is returned in a
1657
- # result, then pass its value in another request to fetch more
1773
+ # A pagination token. If non-null, the pagination token is returned in
1774
+ # a result. Pass its value in another request to retrieve more
1658
1775
  # entries.
1659
1776
  # @return [String]
1660
1777
  #
1661
1778
  # @!attribute [rw] max_results
1662
- # Maximum number of records to list in a single response.
1779
+ # The maximum number of records to list in a single response.
1663
1780
  # @return [Integer]
1664
1781
  #
1665
1782
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListAppsRequest AWS API Documentation
@@ -1667,18 +1784,19 @@ module Aws::Amplify
1667
1784
  class ListAppsRequest < Struct.new(
1668
1785
  :next_token,
1669
1786
  :max_results)
1787
+ SENSITIVE = []
1670
1788
  include Aws::Structure
1671
1789
  end
1672
1790
 
1673
- # Result structure for an Amplify App list request.
1791
+ # The result structure for an Amplify app list request.
1674
1792
  #
1675
1793
  # @!attribute [rw] apps
1676
- # List of Amplify Apps.
1794
+ # A list of Amplify apps.
1677
1795
  # @return [Array<Types::App>]
1678
1796
  #
1679
1797
  # @!attribute [rw] next_token
1680
- # Pagination token. Set to null to start listing Apps from start. If
1681
- # non-null pagination token is returned in a result, then pass its
1798
+ # A pagination token. Set to null to start listing apps from start. If
1799
+ # non-null, the pagination token is returned in a result. Pass its
1682
1800
  # value in here to list more projects.
1683
1801
  # @return [String]
1684
1802
  #
@@ -1687,10 +1805,11 @@ module Aws::Amplify
1687
1805
  class ListAppsResult < Struct.new(
1688
1806
  :apps,
1689
1807
  :next_token)
1808
+ SENSITIVE = []
1690
1809
  include Aws::Structure
1691
1810
  end
1692
1811
 
1693
- # Request structure for the list artifacts request.
1812
+ # Describes the request structure for the list artifacts request.
1694
1813
  #
1695
1814
  # @note When making an API call, you may pass ListArtifactsRequest
1696
1815
  # data as a hash:
@@ -1704,25 +1823,25 @@ module Aws::Amplify
1704
1823
  # }
1705
1824
  #
1706
1825
  # @!attribute [rw] app_id
1707
- # Unique Id for an Amplify App.
1826
+ # The unique ID for an Amplify app.
1708
1827
  # @return [String]
1709
1828
  #
1710
1829
  # @!attribute [rw] branch_name
1711
- # Name for a branch, part of an Amplify App.
1830
+ # The name of a branch that is part of an Amplify app.
1712
1831
  # @return [String]
1713
1832
  #
1714
1833
  # @!attribute [rw] job_id
1715
- # Unique Id for an Job.
1834
+ # The unique ID for a job.
1716
1835
  # @return [String]
1717
1836
  #
1718
1837
  # @!attribute [rw] next_token
1719
- # Pagination token. Set to null to start listing artifacts from start.
1720
- # If non-null pagination token is returned in a result, then pass its
1721
- # value in here to list more artifacts.
1838
+ # A pagination token. Set to null to start listing artifacts from
1839
+ # start. If a non-null pagination token is returned in a result, pass
1840
+ # its value in here to list more artifacts.
1722
1841
  # @return [String]
1723
1842
  #
1724
1843
  # @!attribute [rw] max_results
1725
- # Maximum number of records to list in a single response.
1844
+ # The maximum number of records to list in a single response.
1726
1845
  # @return [Integer]
1727
1846
  #
1728
1847
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifactsRequest AWS API Documentation
@@ -1733,19 +1852,19 @@ module Aws::Amplify
1733
1852
  :job_id,
1734
1853
  :next_token,
1735
1854
  :max_results)
1855
+ SENSITIVE = []
1736
1856
  include Aws::Structure
1737
1857
  end
1738
1858
 
1739
- # Result structure for the list artifacts request.
1859
+ # The result structure for the list artifacts request.
1740
1860
  #
1741
1861
  # @!attribute [rw] artifacts
1742
- # List of artifacts.
1862
+ # A list of artifacts.
1743
1863
  # @return [Array<Types::Artifact>]
1744
1864
  #
1745
1865
  # @!attribute [rw] next_token
1746
- # Pagination token. If non-null pagination token is returned in a
1747
- # result, then pass its value in another request to fetch more
1748
- # entries.
1866
+ # A pagination token. If a non-null pagination token is returned in a
1867
+ # result, pass its value in another request to retrieve more entries.
1749
1868
  # @return [String]
1750
1869
  #
1751
1870
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifactsResult AWS API Documentation
@@ -1753,10 +1872,11 @@ module Aws::Amplify
1753
1872
  class ListArtifactsResult < Struct.new(
1754
1873
  :artifacts,
1755
1874
  :next_token)
1875
+ SENSITIVE = []
1756
1876
  include Aws::Structure
1757
1877
  end
1758
1878
 
1759
- # Request structure for list backend environments request.
1879
+ # The request structure for the list backend environments request.
1760
1880
  #
1761
1881
  # @note When making an API call, you may pass ListBackendEnvironmentsRequest
1762
1882
  # data as a hash:
@@ -1769,21 +1889,22 @@ module Aws::Amplify
1769
1889
  # }
1770
1890
  #
1771
1891
  # @!attribute [rw] app_id
1772
- # Unique Id for an amplify App.
1892
+ # The unique ID for an Amplify app.
1773
1893
  # @return [String]
1774
1894
  #
1775
1895
  # @!attribute [rw] environment_name
1776
- # Name of the backend environment
1896
+ # The name of the backend environment
1777
1897
  # @return [String]
1778
1898
  #
1779
1899
  # @!attribute [rw] next_token
1780
- # Pagination token. Set to null to start listing backen environments
1781
- # from start. If a non-null pagination token is returned in a result,
1782
- # then pass its value in here to list more backend environments.
1900
+ # A pagination token. Set to null to start listing backend
1901
+ # environments from the start. If a non-null pagination token is
1902
+ # returned in a result, pass its value in here to list more backend
1903
+ # environments.
1783
1904
  # @return [String]
1784
1905
  #
1785
1906
  # @!attribute [rw] max_results
1786
- # Maximum number of records to list in a single response.
1907
+ # The maximum number of records to list in a single response.
1787
1908
  # @return [Integer]
1788
1909
  #
1789
1910
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironmentsRequest AWS API Documentation
@@ -1793,19 +1914,19 @@ module Aws::Amplify
1793
1914
  :environment_name,
1794
1915
  :next_token,
1795
1916
  :max_results)
1917
+ SENSITIVE = []
1796
1918
  include Aws::Structure
1797
1919
  end
1798
1920
 
1799
- # Result structure for list backend environments result.
1921
+ # The result structure for the list backend environments result.
1800
1922
  #
1801
1923
  # @!attribute [rw] backend_environments
1802
- # List of backend environments for an Amplify App.
1924
+ # The list of backend environments for an Amplify app.
1803
1925
  # @return [Array<Types::BackendEnvironment>]
1804
1926
  #
1805
1927
  # @!attribute [rw] next_token
1806
- # Pagination token. If non-null pagination token is returned in a
1807
- # result, then pass its value in another request to fetch more
1808
- # entries.
1928
+ # A pagination token. If a non-null pagination token is returned in a
1929
+ # result, pass its value in another request to retrieve more entries.
1809
1930
  # @return [String]
1810
1931
  #
1811
1932
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironmentsResult AWS API Documentation
@@ -1813,10 +1934,11 @@ module Aws::Amplify
1813
1934
  class ListBackendEnvironmentsResult < Struct.new(
1814
1935
  :backend_environments,
1815
1936
  :next_token)
1937
+ SENSITIVE = []
1816
1938
  include Aws::Structure
1817
1939
  end
1818
1940
 
1819
- # Request structure for list branches request.
1941
+ # The request structure for the list branches request.
1820
1942
  #
1821
1943
  # @note When making an API call, you may pass ListBranchesRequest
1822
1944
  # data as a hash:
@@ -1828,17 +1950,17 @@ module Aws::Amplify
1828
1950
  # }
1829
1951
  #
1830
1952
  # @!attribute [rw] app_id
1831
- # Unique Id for an Amplify App.
1953
+ # The unique ID for an Amplify app.
1832
1954
  # @return [String]
1833
1955
  #
1834
1956
  # @!attribute [rw] next_token
1835
- # Pagination token. Set to null to start listing branches from start.
1836
- # If a non-null pagination token is returned in a result, then pass
1957
+ # A pagination token. Set to null to start listing branches from the
1958
+ # start. If a non-null pagination token is returned in a result, pass
1837
1959
  # its value in here to list more branches.
1838
1960
  # @return [String]
1839
1961
  #
1840
1962
  # @!attribute [rw] max_results
1841
- # Maximum number of records to list in a single response.
1963
+ # The maximum number of records to list in a single response.
1842
1964
  # @return [Integer]
1843
1965
  #
1844
1966
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranchesRequest AWS API Documentation
@@ -1847,19 +1969,19 @@ module Aws::Amplify
1847
1969
  :app_id,
1848
1970
  :next_token,
1849
1971
  :max_results)
1972
+ SENSITIVE = []
1850
1973
  include Aws::Structure
1851
1974
  end
1852
1975
 
1853
- # Result structure for list branches request.
1976
+ # The result structure for the list branches request.
1854
1977
  #
1855
1978
  # @!attribute [rw] branches
1856
- # List of branches for an Amplify App.
1979
+ # A list of branches for an Amplify app.
1857
1980
  # @return [Array<Types::Branch>]
1858
1981
  #
1859
1982
  # @!attribute [rw] next_token
1860
- # Pagination token. If non-null pagination token is returned in a
1861
- # result, then pass its value in another request to fetch more
1862
- # entries.
1983
+ # A pagination token. If a non-null pagination token is returned in a
1984
+ # result, pass its value in another request to retrieve more entries.
1863
1985
  # @return [String]
1864
1986
  #
1865
1987
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranchesResult AWS API Documentation
@@ -1867,10 +1989,11 @@ module Aws::Amplify
1867
1989
  class ListBranchesResult < Struct.new(
1868
1990
  :branches,
1869
1991
  :next_token)
1992
+ SENSITIVE = []
1870
1993
  include Aws::Structure
1871
1994
  end
1872
1995
 
1873
- # Request structure for the list Domain Associations request.
1996
+ # The request structure for the list domain associations request.
1874
1997
  #
1875
1998
  # @note When making an API call, you may pass ListDomainAssociationsRequest
1876
1999
  # data as a hash:
@@ -1882,17 +2005,17 @@ module Aws::Amplify
1882
2005
  # }
1883
2006
  #
1884
2007
  # @!attribute [rw] app_id
1885
- # Unique Id for an Amplify App.
2008
+ # The unique ID for an Amplify app.
1886
2009
  # @return [String]
1887
2010
  #
1888
2011
  # @!attribute [rw] next_token
1889
- # Pagination token. Set to null to start listing Apps from start. If
1890
- # non-null pagination token is returned in a result, then pass its
1891
- # value in here to list more projects.
2012
+ # A pagination token. Set to null to start listing apps from the
2013
+ # start. If non-null, a pagination token is returned in a result. Pass
2014
+ # its value in here to list more projects.
1892
2015
  # @return [String]
1893
2016
  #
1894
2017
  # @!attribute [rw] max_results
1895
- # Maximum number of records to list in a single response.
2018
+ # The maximum number of records to list in a single response.
1896
2019
  # @return [Integer]
1897
2020
  #
1898
2021
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociationsRequest AWS API Documentation
@@ -1901,19 +2024,19 @@ module Aws::Amplify
1901
2024
  :app_id,
1902
2025
  :next_token,
1903
2026
  :max_results)
2027
+ SENSITIVE = []
1904
2028
  include Aws::Structure
1905
2029
  end
1906
2030
 
1907
- # Result structure for the list Domain Association request.
2031
+ # The result structure for the list domain association request.
1908
2032
  #
1909
2033
  # @!attribute [rw] domain_associations
1910
- # List of Domain Associations.
2034
+ # A list of domain associations.
1911
2035
  # @return [Array<Types::DomainAssociation>]
1912
2036
  #
1913
2037
  # @!attribute [rw] next_token
1914
- # Pagination token. If non-null pagination token is returned in a
1915
- # result, then pass its value in another request to fetch more
1916
- # entries.
2038
+ # A pagination token. If non-null, a pagination token is returned in a
2039
+ # result. Pass its value in another request to retrieve more entries.
1917
2040
  # @return [String]
1918
2041
  #
1919
2042
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociationsResult AWS API Documentation
@@ -1921,10 +2044,11 @@ module Aws::Amplify
1921
2044
  class ListDomainAssociationsResult < Struct.new(
1922
2045
  :domain_associations,
1923
2046
  :next_token)
2047
+ SENSITIVE = []
1924
2048
  include Aws::Structure
1925
2049
  end
1926
2050
 
1927
- # Request structure for list job request.
2051
+ # The request structure for the list jobs request.
1928
2052
  #
1929
2053
  # @note When making an API call, you may pass ListJobsRequest
1930
2054
  # data as a hash:
@@ -1937,21 +2061,21 @@ module Aws::Amplify
1937
2061
  # }
1938
2062
  #
1939
2063
  # @!attribute [rw] app_id
1940
- # Unique Id for an Amplify App.
2064
+ # The unique ID for an Amplify app.
1941
2065
  # @return [String]
1942
2066
  #
1943
2067
  # @!attribute [rw] branch_name
1944
- # Name for a branch.
2068
+ # The name for a branch.
1945
2069
  # @return [String]
1946
2070
  #
1947
2071
  # @!attribute [rw] next_token
1948
- # Pagination token. Set to null to start listing steps from start. If
1949
- # a non-null pagination token is returned in a result, then pass its
1950
- # value in here to list more steps.
2072
+ # A pagination token. Set to null to start listing steps from the
2073
+ # start. If a non-null pagination token is returned in a result, pass
2074
+ # its value in here to list more steps.
1951
2075
  # @return [String]
1952
2076
  #
1953
2077
  # @!attribute [rw] max_results
1954
- # Maximum number of records to list in a single response.
2078
+ # The maximum number of records to list in a single response.
1955
2079
  # @return [Integer]
1956
2080
  #
1957
2081
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobsRequest AWS API Documentation
@@ -1961,18 +2085,19 @@ module Aws::Amplify
1961
2085
  :branch_name,
1962
2086
  :next_token,
1963
2087
  :max_results)
2088
+ SENSITIVE = []
1964
2089
  include Aws::Structure
1965
2090
  end
1966
2091
 
1967
- # Maximum number of records to list in a single response.
2092
+ # The maximum number of records to list in a single response.
1968
2093
  #
1969
2094
  # @!attribute [rw] job_summaries
1970
- # Result structure for list job result request.
2095
+ # The result structure for the list job result request.
1971
2096
  # @return [Array<Types::JobSummary>]
1972
2097
  #
1973
2098
  # @!attribute [rw] next_token
1974
- # Pagination token. If non-null pagination token is returned in a
1975
- # result, then pass its value in another request to fetch more
2099
+ # A pagination token. If non-null the pagination token is returned in
2100
+ # a result. Pass its value in another request to retrieve more
1976
2101
  # entries.
1977
2102
  # @return [String]
1978
2103
  #
@@ -1981,10 +2106,11 @@ module Aws::Amplify
1981
2106
  class ListJobsResult < Struct.new(
1982
2107
  :job_summaries,
1983
2108
  :next_token)
2109
+ SENSITIVE = []
1984
2110
  include Aws::Structure
1985
2111
  end
1986
2112
 
1987
- # Request structure used to list tags for resource.
2113
+ # The request structure to use to list tags for a resource.
1988
2114
  #
1989
2115
  # @note When making an API call, you may pass ListTagsForResourceRequest
1990
2116
  # data as a hash:
@@ -1994,30 +2120,32 @@ module Aws::Amplify
1994
2120
  # }
1995
2121
  #
1996
2122
  # @!attribute [rw] resource_arn
1997
- # Resource arn used to list tags.
2123
+ # The Amazon Resource Name (ARN) to use to list tags.
1998
2124
  # @return [String]
1999
2125
  #
2000
2126
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResourceRequest AWS API Documentation
2001
2127
  #
2002
2128
  class ListTagsForResourceRequest < Struct.new(
2003
2129
  :resource_arn)
2130
+ SENSITIVE = []
2004
2131
  include Aws::Structure
2005
2132
  end
2006
2133
 
2007
- # Response for list tags.
2134
+ # The response for the list tags for resource request.
2008
2135
  #
2009
2136
  # @!attribute [rw] tags
2010
- # Tags result for response.
2137
+ # A list of tags for the specified The Amazon Resource Name (ARN).
2011
2138
  # @return [Hash<String,String>]
2012
2139
  #
2013
2140
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResourceResponse AWS API Documentation
2014
2141
  #
2015
2142
  class ListTagsForResourceResponse < Struct.new(
2016
2143
  :tags)
2144
+ SENSITIVE = []
2017
2145
  include Aws::Structure
2018
2146
  end
2019
2147
 
2020
- # Request structure for the list webhooks request.
2148
+ # The request structure for the list webhooks request.
2021
2149
  #
2022
2150
  # @note When making an API call, you may pass ListWebhooksRequest
2023
2151
  # data as a hash:
@@ -2029,17 +2157,17 @@ module Aws::Amplify
2029
2157
  # }
2030
2158
  #
2031
2159
  # @!attribute [rw] app_id
2032
- # Unique Id for an Amplify App.
2160
+ # The unique ID for an Amplify app.
2033
2161
  # @return [String]
2034
2162
  #
2035
2163
  # @!attribute [rw] next_token
2036
- # Pagination token. Set to null to start listing webhooks from start.
2037
- # If non-null pagination token is returned in a result, then pass its
2038
- # value in here to list more webhooks.
2164
+ # A pagination token. Set to null to start listing webhooks from the
2165
+ # start. If non-null,the pagination token is returned in a result.
2166
+ # Pass its value in here to list more webhooks.
2039
2167
  # @return [String]
2040
2168
  #
2041
2169
  # @!attribute [rw] max_results
2042
- # Maximum number of records to list in a single response.
2170
+ # The maximum number of records to list in a single response.
2043
2171
  # @return [Integer]
2044
2172
  #
2045
2173
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooksRequest AWS API Documentation
@@ -2048,18 +2176,19 @@ module Aws::Amplify
2048
2176
  :app_id,
2049
2177
  :next_token,
2050
2178
  :max_results)
2179
+ SENSITIVE = []
2051
2180
  include Aws::Structure
2052
2181
  end
2053
2182
 
2054
- # Result structure for the list webhooks request.
2183
+ # The result structure for the list webhooks request.
2055
2184
  #
2056
2185
  # @!attribute [rw] webhooks
2057
- # List of webhooks.
2186
+ # A list of webhooks.
2058
2187
  # @return [Array<Types::Webhook>]
2059
2188
  #
2060
2189
  # @!attribute [rw] next_token
2061
- # Pagination token. If non-null pagination token is returned in a
2062
- # result, then pass its value in another request to fetch more
2190
+ # A pagination token. If non-null, the pagination token is returned in
2191
+ # a result. Pass its value in another request to retrieve more
2063
2192
  # entries.
2064
2193
  # @return [String]
2065
2194
  #
@@ -2068,11 +2197,11 @@ module Aws::Amplify
2068
2197
  class ListWebhooksResult < Struct.new(
2069
2198
  :webhooks,
2070
2199
  :next_token)
2200
+ SENSITIVE = []
2071
2201
  include Aws::Structure
2072
2202
  end
2073
2203
 
2074
- # Exception thrown when an entity has not been found during an
2075
- # operation.
2204
+ # An entity was not found during an operation.
2076
2205
  #
2077
2206
  # @!attribute [rw] message
2078
2207
  # @return [String]
@@ -2081,25 +2210,27 @@ module Aws::Amplify
2081
2210
  #
2082
2211
  class NotFoundException < Struct.new(
2083
2212
  :message)
2213
+ SENSITIVE = []
2084
2214
  include Aws::Structure
2085
2215
  end
2086
2216
 
2087
- # Structure with Production Branch information.
2217
+ # Describes the information about a production branch for an Amplify
2218
+ # app.
2088
2219
  #
2089
2220
  # @!attribute [rw] last_deploy_time
2090
- # Last Deploy Time of Production Branch.
2221
+ # The last deploy time of the production branch.
2091
2222
  # @return [Time]
2092
2223
  #
2093
2224
  # @!attribute [rw] status
2094
- # Status of Production Branch.
2225
+ # The status of the production branch.
2095
2226
  # @return [String]
2096
2227
  #
2097
2228
  # @!attribute [rw] thumbnail_url
2098
- # Thumbnail URL for Production Branch.
2229
+ # The thumbnail URL for the production branch.
2099
2230
  # @return [String]
2100
2231
  #
2101
2232
  # @!attribute [rw] branch_name
2102
- # Branch Name for Production Branch.
2233
+ # The branch name for the production branch.
2103
2234
  # @return [String]
2104
2235
  #
2105
2236
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ProductionBranch AWS API Documentation
@@ -2109,10 +2240,11 @@ module Aws::Amplify
2109
2240
  :status,
2110
2241
  :thumbnail_url,
2111
2242
  :branch_name)
2243
+ SENSITIVE = []
2112
2244
  include Aws::Structure
2113
2245
  end
2114
2246
 
2115
- # Exception thrown when an operation fails due to non-existent resource.
2247
+ # An operation failed due to a non-existent resource.
2116
2248
  #
2117
2249
  # @!attribute [rw] code
2118
2250
  # @return [String]
@@ -2125,10 +2257,11 @@ module Aws::Amplify
2125
2257
  class ResourceNotFoundException < Struct.new(
2126
2258
  :code,
2127
2259
  :message)
2260
+ SENSITIVE = []
2128
2261
  include Aws::Structure
2129
2262
  end
2130
2263
 
2131
- # Request structure for start a deployment.
2264
+ # The request structure for the start a deployment request.
2132
2265
  #
2133
2266
  # @note When making an API call, you may pass StartDeploymentRequest
2134
2267
  # data as a hash:
@@ -2141,22 +2274,23 @@ module Aws::Amplify
2141
2274
  # }
2142
2275
  #
2143
2276
  # @!attribute [rw] app_id
2144
- # Unique Id for an Amplify App.
2277
+ # The unique ID for an Amplify app.
2145
2278
  # @return [String]
2146
2279
  #
2147
2280
  # @!attribute [rw] branch_name
2148
- # Name for the branch, for the Job.
2281
+ # The name for the branch, for the job.
2149
2282
  # @return [String]
2150
2283
  #
2151
2284
  # @!attribute [rw] job_id
2152
- # The job id for this deployment, generated by create deployment
2285
+ # The job ID for this deployment, generated by the create deployment
2153
2286
  # request.
2154
2287
  # @return [String]
2155
2288
  #
2156
2289
  # @!attribute [rw] source_url
2157
- # The sourceUrl for this deployment, used when calling start
2158
- # deployment without create deployment. SourceUrl can be any HTTP GET
2159
- # url that is public accessible and downloads a single zip.
2290
+ # The source URL for this deployment, used when calling start
2291
+ # deployment without create deployment. The source URL can be any HTTP
2292
+ # GET URL that is publicly accessible and downloads a single .zip
2293
+ # file.
2160
2294
  # @return [String]
2161
2295
  #
2162
2296
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeploymentRequest AWS API Documentation
@@ -2166,23 +2300,25 @@ module Aws::Amplify
2166
2300
  :branch_name,
2167
2301
  :job_id,
2168
2302
  :source_url)
2303
+ SENSITIVE = []
2169
2304
  include Aws::Structure
2170
2305
  end
2171
2306
 
2172
- # Result structure for start a deployment.
2307
+ # The result structure for the start a deployment request.
2173
2308
  #
2174
2309
  # @!attribute [rw] job_summary
2175
- # Summary for the Job.
2310
+ # The summary for the job.
2176
2311
  # @return [Types::JobSummary]
2177
2312
  #
2178
2313
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeploymentResult AWS API Documentation
2179
2314
  #
2180
2315
  class StartDeploymentResult < Struct.new(
2181
2316
  :job_summary)
2317
+ SENSITIVE = []
2182
2318
  include Aws::Structure
2183
2319
  end
2184
2320
 
2185
- # Request structure for Start job request.
2321
+ # The request structure for the start job request.
2186
2322
  #
2187
2323
  # @note When making an API call, you may pass StartJobRequest
2188
2324
  # data as a hash:
@@ -2199,38 +2335,41 @@ module Aws::Amplify
2199
2335
  # }
2200
2336
  #
2201
2337
  # @!attribute [rw] app_id
2202
- # Unique Id for an Amplify App.
2338
+ # The unique ID for an Amplify app.
2203
2339
  # @return [String]
2204
2340
  #
2205
2341
  # @!attribute [rw] branch_name
2206
- # Name for the branch, for the Job.
2342
+ # The branch name for the job.
2207
2343
  # @return [String]
2208
2344
  #
2209
2345
  # @!attribute [rw] job_id
2210
- # Unique Id for an existing job. Required for "RETRY" JobType.
2346
+ # The unique ID for an existing job. This is required if the value of
2347
+ # `jobType` is `RETRY`.
2211
2348
  # @return [String]
2212
2349
  #
2213
2350
  # @!attribute [rw] job_type
2214
- # Type for the Job. Available JobTypes are: \\n "RELEASE": Start a
2215
- # new job with the latest change from the specified branch. Only
2216
- # available for apps that have connected to a repository. "RETRY":
2217
- # Retry an existing job. JobId is required for this type of job.
2351
+ # Describes the type for the job. The job type `RELEASE` starts a new
2352
+ # job with the latest change from the specified branch. This value is
2353
+ # available only for apps that are connected to a repository. The job
2354
+ # type `RETRY` retries an existing job. If the job type value is
2355
+ # `RETRY`, the `jobId` is also required.
2218
2356
  # @return [String]
2219
2357
  #
2220
2358
  # @!attribute [rw] job_reason
2221
- # Descriptive reason for starting this job.
2359
+ # A descriptive reason for starting this job.
2222
2360
  # @return [String]
2223
2361
  #
2224
2362
  # @!attribute [rw] commit_id
2225
- # Commit Id from 3rd party repository provider for the Job.
2363
+ # The commit ID from a third-party repository provider for the job.
2226
2364
  # @return [String]
2227
2365
  #
2228
2366
  # @!attribute [rw] commit_message
2229
- # Commit message from 3rd party repository provider for the Job.
2367
+ # The commit message from a third-party repository provider for the
2368
+ # job.
2230
2369
  # @return [String]
2231
2370
  #
2232
2371
  # @!attribute [rw] commit_time
2233
- # Commit date / time for the Job.
2372
+ # The commit date and time for the job.
2234
2373
  # @return [Time]
2235
2374
  #
2236
2375
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJobRequest AWS API Documentation
@@ -2244,68 +2383,69 @@ module Aws::Amplify
2244
2383
  :commit_id,
2245
2384
  :commit_message,
2246
2385
  :commit_time)
2386
+ SENSITIVE = []
2247
2387
  include Aws::Structure
2248
2388
  end
2249
2389
 
2250
- # Result structure for run job request.
2390
+ # The result structure for the run job request.
2251
2391
  #
2252
2392
  # @!attribute [rw] job_summary
2253
- # Summary for the Job.
2393
+ # The summary for the job.
2254
2394
  # @return [Types::JobSummary]
2255
2395
  #
2256
2396
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJobResult AWS API Documentation
2257
2397
  #
2258
2398
  class StartJobResult < Struct.new(
2259
2399
  :job_summary)
2400
+ SENSITIVE = []
2260
2401
  include Aws::Structure
2261
2402
  end
2262
2403
 
2263
- # Structure for an execution step for an execution job, for an Amplify
2264
- # App.
2404
+ # Describes an execution step, for an execution job, for an Amplify app.
2265
2405
  #
2266
2406
  # @!attribute [rw] step_name
2267
- # Name of the execution step.
2407
+ # The name of the execution step.
2268
2408
  # @return [String]
2269
2409
  #
2270
2410
  # @!attribute [rw] start_time
2271
- # Start date/ time of the execution step.
2411
+ # The start date and time of the execution step.
2272
2412
  # @return [Time]
2273
2413
  #
2274
2414
  # @!attribute [rw] status
2275
- # Status of the execution step.
2415
+ # The status of the execution step.
2276
2416
  # @return [String]
2277
2417
  #
2278
2418
  # @!attribute [rw] end_time
2279
- # End date/ time of the execution step.
2419
+ # The end date and time of the execution step.
2280
2420
  # @return [Time]
2281
2421
  #
2282
2422
  # @!attribute [rw] log_url
2283
- # URL to the logs for the execution step.
2423
+ # The URL to the logs for the execution step.
2284
2424
  # @return [String]
2285
2425
  #
2286
2426
  # @!attribute [rw] artifacts_url
2287
- # URL to the artifact for the execution step.
2427
+ # The URL to the artifact for the execution step.
2288
2428
  # @return [String]
2289
2429
  #
2290
2430
  # @!attribute [rw] test_artifacts_url
2291
- # URL to the test artifact for the execution step.
2431
+ # The URL to the test artifact for the execution step.
2292
2432
  # @return [String]
2293
2433
  #
2294
2434
  # @!attribute [rw] test_config_url
2295
- # URL to the test config for the execution step.
2435
+ # The URL to the test configuration for the execution step.
2296
2436
  # @return [String]
2297
2437
  #
2298
2438
  # @!attribute [rw] screenshots
2299
- # List of screenshot URLs for the execution step, if relevant.
2439
+ # The list of screenshot URLs for the execution step, if relevant.
2300
2440
  # @return [Hash<String,String>]
2301
2441
  #
2302
2442
  # @!attribute [rw] status_reason
2303
- # The reason for current step status.
2443
+ # The reason for the current step status.
2304
2444
  # @return [String]
2305
2445
  #
2306
2446
  # @!attribute [rw] context
2307
- # The context for current step, will include build image if step is
2308
- # build.
2447
+ # The context for the current step. Includes a build image if the step
2448
+ # is build.
2309
2449
  # @return [String]
2310
2450
  #
2311
2451
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Step AWS API Documentation
@@ -2322,10 +2462,11 @@ module Aws::Amplify
2322
2462
  :screenshots,
2323
2463
  :status_reason,
2324
2464
  :context)
2465
+ SENSITIVE = []
2325
2466
  include Aws::Structure
2326
2467
  end
2327
2468
 
2328
- # Request structure for stop job request.
2469
+ # The request structure for the stop job request.
2329
2470
  #
2330
2471
  # @note When making an API call, you may pass StopJobRequest
2331
2472
  # data as a hash:
@@ -2337,15 +2478,15 @@ module Aws::Amplify
2337
2478
  # }
2338
2479
  #
2339
2480
  # @!attribute [rw] app_id
2340
- # Unique Id for an Amplify App.
2481
+ # The unique ID for an Amplify app.
2341
2482
  # @return [String]
2342
2483
  #
2343
2484
  # @!attribute [rw] branch_name
2344
- # Name for the branch, for the Job.
2485
+ # The name for the branch, for the job.
2345
2486
  # @return [String]
2346
2487
  #
2347
2488
  # @!attribute [rw] job_id
2348
- # Unique Id for the Job.
2489
+ # The unique id for the job.
2349
2490
  # @return [String]
2350
2491
  #
2351
2492
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJobRequest AWS API Documentation
@@ -2354,34 +2495,36 @@ module Aws::Amplify
2354
2495
  :app_id,
2355
2496
  :branch_name,
2356
2497
  :job_id)
2498
+ SENSITIVE = []
2357
2499
  include Aws::Structure
2358
2500
  end
2359
2501
 
2360
- # Result structure for the stop job request.
2502
+ # The result structure for the stop job request.
2361
2503
  #
2362
2504
  # @!attribute [rw] job_summary
2363
- # Summary for the Job.
2505
+ # The summary for the job.
2364
2506
  # @return [Types::JobSummary]
2365
2507
  #
2366
2508
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJobResult AWS API Documentation
2367
2509
  #
2368
2510
  class StopJobResult < Struct.new(
2369
2511
  :job_summary)
2512
+ SENSITIVE = []
2370
2513
  include Aws::Structure
2371
2514
  end
2372
2515
 
2373
- # Subdomain for the Domain Association.
2516
+ # The subdomain for the domain association.
2374
2517
  #
2375
2518
  # @!attribute [rw] sub_domain_setting
2376
- # Setting structure for the Subdomain.
2519
+ # Describes the settings for the subdomain.
2377
2520
  # @return [Types::SubDomainSetting]
2378
2521
  #
2379
2522
  # @!attribute [rw] verified
2380
- # Verified status of the Subdomain
2523
+ # The verified status of the subdomain
2381
2524
  # @return [Boolean]
2382
2525
  #
2383
2526
  # @!attribute [rw] dns_record
2384
- # DNS record for the Subdomain.
2527
+ # The DNS record for the subdomain.
2385
2528
  # @return [String]
2386
2529
  #
2387
2530
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/SubDomain AWS API Documentation
@@ -2390,10 +2533,11 @@ module Aws::Amplify
2390
2533
  :sub_domain_setting,
2391
2534
  :verified,
2392
2535
  :dns_record)
2536
+ SENSITIVE = []
2393
2537
  include Aws::Structure
2394
2538
  end
2395
2539
 
2396
- # Setting for the Subdomain.
2540
+ # Describes the settings for the subdomain.
2397
2541
  #
2398
2542
  # @note When making an API call, you may pass SubDomainSetting
2399
2543
  # data as a hash:
@@ -2404,11 +2548,11 @@ module Aws::Amplify
2404
2548
  # }
2405
2549
  #
2406
2550
  # @!attribute [rw] prefix
2407
- # Prefix setting for the Subdomain.
2551
+ # The prefix setting for the subdomain.
2408
2552
  # @return [String]
2409
2553
  #
2410
2554
  # @!attribute [rw] branch_name
2411
- # Branch name setting for the Subdomain.
2555
+ # The branch name setting for the subdomain.
2412
2556
  # @return [String]
2413
2557
  #
2414
2558
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/SubDomainSetting AWS API Documentation
@@ -2416,10 +2560,11 @@ module Aws::Amplify
2416
2560
  class SubDomainSetting < Struct.new(
2417
2561
  :prefix,
2418
2562
  :branch_name)
2563
+ SENSITIVE = []
2419
2564
  include Aws::Structure
2420
2565
  end
2421
2566
 
2422
- # Request structure used to tag resource.
2567
+ # The request structure to tag a resource with a tag key and value.
2423
2568
  #
2424
2569
  # @note When making an API call, you may pass TagResourceRequest
2425
2570
  # data as a hash:
@@ -2432,11 +2577,11 @@ module Aws::Amplify
2432
2577
  # }
2433
2578
  #
2434
2579
  # @!attribute [rw] resource_arn
2435
- # Resource arn used to tag resource.
2580
+ # The Amazon Resource Name (ARN) to use to tag a resource.
2436
2581
  # @return [String]
2437
2582
  #
2438
2583
  # @!attribute [rw] tags
2439
- # Tags used to tag resource.
2584
+ # The tags used to tag the resource.
2440
2585
  # @return [Hash<String,String>]
2441
2586
  #
2442
2587
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResourceRequest AWS API Documentation
@@ -2444,16 +2589,17 @@ module Aws::Amplify
2444
2589
  class TagResourceRequest < Struct.new(
2445
2590
  :resource_arn,
2446
2591
  :tags)
2592
+ SENSITIVE = []
2447
2593
  include Aws::Structure
2448
2594
  end
2449
2595
 
2450
- # Response for tag resource.
2596
+ # The response for the tag resource request.
2451
2597
  #
2452
2598
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResourceResponse AWS API Documentation
2453
2599
  #
2454
2600
  class TagResourceResponse < Aws::EmptyStructure; end
2455
2601
 
2456
- # Exception thrown when an operation fails due to a lack of access.
2602
+ # An operation failed due to a lack of access.
2457
2603
  #
2458
2604
  # @!attribute [rw] message
2459
2605
  # @return [String]
@@ -2462,10 +2608,11 @@ module Aws::Amplify
2462
2608
  #
2463
2609
  class UnauthorizedException < Struct.new(
2464
2610
  :message)
2611
+ SENSITIVE = []
2465
2612
  include Aws::Structure
2466
2613
  end
2467
2614
 
2468
- # Request structure used to untag resource.
2615
+ # The request structure for the untag resource request.
2469
2616
  #
2470
2617
  # @note When making an API call, you may pass UntagResourceRequest
2471
2618
  # data as a hash:
@@ -2476,11 +2623,11 @@ module Aws::Amplify
2476
2623
  # }
2477
2624
  #
2478
2625
  # @!attribute [rw] resource_arn
2479
- # Resource arn used to untag resource.
2626
+ # The Amazon Resource Name (ARN) to use to untag a resource.
2480
2627
  # @return [String]
2481
2628
  #
2482
2629
  # @!attribute [rw] tag_keys
2483
- # Tag keys used to untag resource.
2630
+ # The tag keys to use to untag a resource.
2484
2631
  # @return [Array<String>]
2485
2632
  #
2486
2633
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResourceRequest AWS API Documentation
@@ -2488,16 +2635,17 @@ module Aws::Amplify
2488
2635
  class UntagResourceRequest < Struct.new(
2489
2636
  :resource_arn,
2490
2637
  :tag_keys)
2638
+ SENSITIVE = []
2491
2639
  include Aws::Structure
2492
2640
  end
2493
2641
 
2494
- # Response for untag resource.
2642
+ # The response for the untag resource request.
2495
2643
  #
2496
2644
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResourceResponse AWS API Documentation
2497
2645
  #
2498
2646
  class UntagResourceResponse < Aws::EmptyStructure; end
2499
2647
 
2500
- # Request structure for update App request.
2648
+ # The request structure for the update app request.
2501
2649
  #
2502
2650
  # @note When making an API call, you may pass UpdateAppRequest
2503
2651
  # data as a hash:
@@ -2512,6 +2660,7 @@ module Aws::Amplify
2512
2660
  # "EnvKey" => "EnvValue",
2513
2661
  # },
2514
2662
  # enable_branch_auto_build: false,
2663
+ # enable_branch_auto_deletion: false,
2515
2664
  # enable_basic_auth: false,
2516
2665
  # basic_auth_credentials: "BasicAuthCredentials",
2517
2666
  # custom_rules: [
@@ -2544,75 +2693,82 @@ module Aws::Amplify
2544
2693
  # }
2545
2694
  #
2546
2695
  # @!attribute [rw] app_id
2547
- # Unique Id for an Amplify App.
2696
+ # The unique ID for an Amplify app.
2548
2697
  # @return [String]
2549
2698
  #
2550
2699
  # @!attribute [rw] name
2551
- # Name for an Amplify App.
2700
+ # The name for an Amplify app.
2552
2701
  # @return [String]
2553
2702
  #
2554
2703
  # @!attribute [rw] description
2555
- # Description for an Amplify App.
2704
+ # The description for an Amplify app.
2556
2705
  # @return [String]
2557
2706
  #
2558
2707
  # @!attribute [rw] platform
2559
- # Platform for an Amplify App.
2708
+ # The platform for an Amplify app.
2560
2709
  # @return [String]
2561
2710
  #
2562
2711
  # @!attribute [rw] iam_service_role_arn
2563
- # IAM service role for an Amplify App.
2712
+ # The AWS Identity and Access Management (IAM) service role for an
2713
+ # Amplify app.
2564
2714
  # @return [String]
2565
2715
  #
2566
2716
  # @!attribute [rw] environment_variables
2567
- # Environment Variables for an Amplify App.
2717
+ # The environment variables for an Amplify app.
2568
2718
  # @return [Hash<String,String>]
2569
2719
  #
2570
2720
  # @!attribute [rw] enable_branch_auto_build
2571
- # Enables branch auto-building for an Amplify App.
2721
+ # Enables branch auto-building for an Amplify app.
2722
+ # @return [Boolean]
2723
+ #
2724
+ # @!attribute [rw] enable_branch_auto_deletion
2725
+ # Automatically disconnects a branch in the Amplify Console when you
2726
+ # delete a branch from your Git repository.
2572
2727
  # @return [Boolean]
2573
2728
  #
2574
2729
  # @!attribute [rw] enable_basic_auth
2575
- # Enables Basic Authorization for an Amplify App.
2730
+ # Enables basic authorization for an Amplify app.
2576
2731
  # @return [Boolean]
2577
2732
  #
2578
2733
  # @!attribute [rw] basic_auth_credentials
2579
- # Basic Authorization credentials for an Amplify App.
2734
+ # The basic authorization credentials for an Amplify app.
2580
2735
  # @return [String]
2581
2736
  #
2582
2737
  # @!attribute [rw] custom_rules
2583
- # Custom redirect / rewrite rules for an Amplify App.
2738
+ # The custom redirect and rewrite rules for an Amplify app.
2584
2739
  # @return [Array<Types::CustomRule>]
2585
2740
  #
2586
2741
  # @!attribute [rw] build_spec
2587
- # BuildSpec for an Amplify App.
2742
+ # The build specification (build spec) for an Amplify app.
2588
2743
  # @return [String]
2589
2744
  #
2590
2745
  # @!attribute [rw] enable_auto_branch_creation
2591
- # Enables automated branch creation for the Amplify App.
2746
+ # Enables automated branch creation for the Amplify app.
2592
2747
  # @return [Boolean]
2593
2748
  #
2594
2749
  # @!attribute [rw] auto_branch_creation_patterns
2595
- # Automated branch creation glob patterns for the Amplify App.
2750
+ # Describes the automated branch creation glob patterns for the
2751
+ # Amplify app.
2596
2752
  # @return [Array<String>]
2597
2753
  #
2598
2754
  # @!attribute [rw] auto_branch_creation_config
2599
- # Automated branch creation branchConfig for the Amplify App.
2755
+ # The automated branch creation configuration for the Amplify app.
2600
2756
  # @return [Types::AutoBranchCreationConfig]
2601
2757
  #
2602
2758
  # @!attribute [rw] repository
2603
- # Repository for an Amplify App
2759
+ # The name of the repository for an Amplify app
2604
2760
  # @return [String]
2605
2761
  #
2606
2762
  # @!attribute [rw] oauth_token
2607
- # OAuth token for 3rd party source control system for an Amplify App,
2608
- # used to create webhook and read-only deploy key. OAuth token is not
2609
- # stored.
2763
+ # The OAuth token for a third-party source control system for an
2764
+ # Amplify app. The token is used to create a webhook and a read-only
2765
+ # deploy key. The OAuth token is not stored.
2610
2766
  # @return [String]
2611
2767
  #
2612
2768
  # @!attribute [rw] access_token
2613
- # Personal Access token for 3rd party source control system for an
2614
- # Amplify App, used to create webhook and read-only deploy key. Token
2615
- # is not stored.
2769
+ # The personal access token for a third-party source control system
2770
+ # for an Amplify app. The token is used to create webhook and a
2771
+ # read-only deploy key. The token is not stored.
2616
2772
  # @return [String]
2617
2773
  #
2618
2774
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppRequest AWS API Documentation
@@ -2625,6 +2781,7 @@ module Aws::Amplify
2625
2781
  :iam_service_role_arn,
2626
2782
  :environment_variables,
2627
2783
  :enable_branch_auto_build,
2784
+ :enable_branch_auto_deletion,
2628
2785
  :enable_basic_auth,
2629
2786
  :basic_auth_credentials,
2630
2787
  :custom_rules,
@@ -2635,23 +2792,25 @@ module Aws::Amplify
2635
2792
  :repository,
2636
2793
  :oauth_token,
2637
2794
  :access_token)
2795
+ SENSITIVE = [:basic_auth_credentials, :oauth_token, :access_token]
2638
2796
  include Aws::Structure
2639
2797
  end
2640
2798
 
2641
- # Result structure for an Amplify App update request.
2799
+ # The result structure for an Amplify app update request.
2642
2800
  #
2643
2801
  # @!attribute [rw] app
2644
- # App structure for the updated App.
2802
+ # Represents the updated Amplify app.
2645
2803
  # @return [Types::App]
2646
2804
  #
2647
2805
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppResult AWS API Documentation
2648
2806
  #
2649
2807
  class UpdateAppResult < Struct.new(
2650
2808
  :app)
2809
+ SENSITIVE = []
2651
2810
  include Aws::Structure
2652
2811
  end
2653
2812
 
2654
- # Request structure for update branch request.
2813
+ # The request structure for the update branch request.
2655
2814
  #
2656
2815
  # @note When making an API call, you may pass UpdateBranchRequest
2657
2816
  # data as a hash:
@@ -2678,23 +2837,23 @@ module Aws::Amplify
2678
2837
  # }
2679
2838
  #
2680
2839
  # @!attribute [rw] app_id
2681
- # Unique Id for an Amplify App.
2840
+ # The unique ID for an Amplify app.
2682
2841
  # @return [String]
2683
2842
  #
2684
2843
  # @!attribute [rw] branch_name
2685
- # Name for the branch.
2844
+ # The name for the branch.
2686
2845
  # @return [String]
2687
2846
  #
2688
2847
  # @!attribute [rw] description
2689
- # Description for the branch.
2848
+ # The description for the branch.
2690
2849
  # @return [String]
2691
2850
  #
2692
2851
  # @!attribute [rw] framework
2693
- # Framework for the branch.
2852
+ # The framework for the branch.
2694
2853
  # @return [String]
2695
2854
  #
2696
2855
  # @!attribute [rw] stage
2697
- # Stage for the branch.
2856
+ # Describes the current stage for the branch.
2698
2857
  # @return [String]
2699
2858
  #
2700
2859
  # @!attribute [rw] enable_notification
@@ -2706,39 +2865,41 @@ module Aws::Amplify
2706
2865
  # @return [Boolean]
2707
2866
  #
2708
2867
  # @!attribute [rw] environment_variables
2709
- # Environment Variables for the branch.
2868
+ # The environment variables for the branch.
2710
2869
  # @return [Hash<String,String>]
2711
2870
  #
2712
2871
  # @!attribute [rw] basic_auth_credentials
2713
- # Basic Authorization credentials for the branch.
2872
+ # The basic authorization credentials for the branch.
2714
2873
  # @return [String]
2715
2874
  #
2716
2875
  # @!attribute [rw] enable_basic_auth
2717
- # Enables Basic Auth for the branch.
2876
+ # Enables basic authorization for the branch.
2718
2877
  # @return [Boolean]
2719
2878
  #
2720
2879
  # @!attribute [rw] build_spec
2721
- # BuildSpec for the branch.
2880
+ # The build specification (build spec) for the branch.
2722
2881
  # @return [String]
2723
2882
  #
2724
2883
  # @!attribute [rw] ttl
2725
- # The content TTL for the website in seconds.
2884
+ # The content Time to Live (TTL) for the website in seconds.
2726
2885
  # @return [String]
2727
2886
  #
2728
2887
  # @!attribute [rw] display_name
2729
- # Display name for a branch, will use as the default domain prefix.
2888
+ # The display name for a branch. This is used as the default domain
2889
+ # prefix.
2730
2890
  # @return [String]
2731
2891
  #
2732
2892
  # @!attribute [rw] enable_pull_request_preview
2733
- # Enables Pull Request Preview for this branch.
2893
+ # Enables pull request preview for this branch.
2734
2894
  # @return [Boolean]
2735
2895
  #
2736
2896
  # @!attribute [rw] pull_request_environment_name
2737
- # The Amplify Environment name for the pull request.
2897
+ # The Amplify environment name for the pull request.
2738
2898
  # @return [String]
2739
2899
  #
2740
2900
  # @!attribute [rw] backend_environment_arn
2741
- # ARN for a Backend Environment, part of an Amplify App.
2901
+ # The Amazon Resource Name (ARN) for a backend environment that is
2902
+ # part of an Amplify app.
2742
2903
  # @return [String]
2743
2904
  #
2744
2905
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest AWS API Documentation
@@ -2760,23 +2921,26 @@ module Aws::Amplify
2760
2921
  :enable_pull_request_preview,
2761
2922
  :pull_request_environment_name,
2762
2923
  :backend_environment_arn)
2924
+ SENSITIVE = [:basic_auth_credentials]
2763
2925
  include Aws::Structure
2764
2926
  end
2765
2927
 
2766
- # Result structure for update branch request.
2928
+ # The result structure for the update branch request.
2767
2929
  #
2768
2930
  # @!attribute [rw] branch
2769
- # Branch structure for an Amplify App.
2931
+ # The branch for an Amplify app, which maps to a third-party
2932
+ # repository branch.
2770
2933
  # @return [Types::Branch]
2771
2934
  #
2772
2935
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchResult AWS API Documentation
2773
2936
  #
2774
2937
  class UpdateBranchResult < Struct.new(
2775
2938
  :branch)
2939
+ SENSITIVE = []
2776
2940
  include Aws::Structure
2777
2941
  end
2778
2942
 
2779
- # Request structure for update Domain Association request.
2943
+ # The request structure for the update domain association request.
2780
2944
  #
2781
2945
  # @note When making an API call, you may pass UpdateDomainAssociationRequest
2782
2946
  # data as a hash:
@@ -2791,49 +2955,65 @@ module Aws::Amplify
2791
2955
  # branch_name: "BranchName", # required
2792
2956
  # },
2793
2957
  # ],
2958
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
2959
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
2794
2960
  # }
2795
2961
  #
2796
2962
  # @!attribute [rw] app_id
2797
- # Unique Id for an Amplify App.
2963
+ # The unique ID for an Amplify app.
2798
2964
  # @return [String]
2799
2965
  #
2800
2966
  # @!attribute [rw] domain_name
2801
- # Name of the domain.
2967
+ # The name of the domain.
2802
2968
  # @return [String]
2803
2969
  #
2804
2970
  # @!attribute [rw] enable_auto_sub_domain
2805
- # Enables automated creation of Subdomains for branches. (Currently
2806
- # not supported)
2971
+ # Enables the automated creation of subdomains for branches.
2807
2972
  # @return [Boolean]
2808
2973
  #
2809
2974
  # @!attribute [rw] sub_domain_settings
2810
- # Setting structure for the Subdomain.
2975
+ # Describes the settings for the subdomain.
2811
2976
  # @return [Array<Types::SubDomainSetting>]
2812
2977
  #
2978
+ # @!attribute [rw] auto_sub_domain_creation_patterns
2979
+ # Sets the branch patterns for automatic subdomain creation.
2980
+ # @return [Array<String>]
2981
+ #
2982
+ # @!attribute [rw] auto_sub_domain_iam_role
2983
+ # The required AWS Identity and Access Management (IAM) service role
2984
+ # for the Amazon Resource Name (ARN) for automatically creating
2985
+ # subdomains.
2986
+ # @return [String]
2987
+ #
2813
2988
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociationRequest AWS API Documentation
2814
2989
  #
2815
2990
  class UpdateDomainAssociationRequest < Struct.new(
2816
2991
  :app_id,
2817
2992
  :domain_name,
2818
2993
  :enable_auto_sub_domain,
2819
- :sub_domain_settings)
2994
+ :sub_domain_settings,
2995
+ :auto_sub_domain_creation_patterns,
2996
+ :auto_sub_domain_iam_role)
2997
+ SENSITIVE = []
2820
2998
  include Aws::Structure
2821
2999
  end
2822
3000
 
2823
- # Result structure for the update Domain Association request.
3001
+ # The result structure for the update domain association request.
2824
3002
  #
2825
3003
  # @!attribute [rw] domain_association
2826
- # Domain Association structure.
3004
+ # Describes a domain association, which associates a custom domain
3005
+ # with an Amplify app.
2827
3006
  # @return [Types::DomainAssociation]
2828
3007
  #
2829
3008
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociationResult AWS API Documentation
2830
3009
  #
2831
3010
  class UpdateDomainAssociationResult < Struct.new(
2832
3011
  :domain_association)
3012
+ SENSITIVE = []
2833
3013
  include Aws::Structure
2834
3014
  end
2835
3015
 
2836
- # Request structure for update webhook request.
3016
+ # The request structure for the update webhook request.
2837
3017
  #
2838
3018
  # @note When making an API call, you may pass UpdateWebhookRequest
2839
3019
  # data as a hash:
@@ -2845,15 +3025,15 @@ module Aws::Amplify
2845
3025
  # }
2846
3026
  #
2847
3027
  # @!attribute [rw] webhook_id
2848
- # Unique Id for a webhook.
3028
+ # The unique ID for a webhook.
2849
3029
  # @return [String]
2850
3030
  #
2851
3031
  # @!attribute [rw] branch_name
2852
- # Name for a branch, part of an Amplify App.
3032
+ # The name for a branch that is part of an Amplify app.
2853
3033
  # @return [String]
2854
3034
  #
2855
3035
  # @!attribute [rw] description
2856
- # Description for a webhook.
3036
+ # The description for a webhook.
2857
3037
  # @return [String]
2858
3038
  #
2859
3039
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhookRequest AWS API Documentation
@@ -2862,50 +3042,53 @@ module Aws::Amplify
2862
3042
  :webhook_id,
2863
3043
  :branch_name,
2864
3044
  :description)
3045
+ SENSITIVE = []
2865
3046
  include Aws::Structure
2866
3047
  end
2867
3048
 
2868
- # Result structure for the update webhook request.
3049
+ # The result structure for the update webhook request.
2869
3050
  #
2870
3051
  # @!attribute [rw] webhook
2871
- # Webhook structure.
3052
+ # Describes a webhook that connects repository events to an Amplify
3053
+ # app.
2872
3054
  # @return [Types::Webhook]
2873
3055
  #
2874
3056
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhookResult AWS API Documentation
2875
3057
  #
2876
3058
  class UpdateWebhookResult < Struct.new(
2877
3059
  :webhook)
3060
+ SENSITIVE = []
2878
3061
  include Aws::Structure
2879
3062
  end
2880
3063
 
2881
- # Structure for webhook, which associates a webhook with an Amplify App.
3064
+ # Describes a webhook that connects repository events to an Amplify app.
2882
3065
  #
2883
3066
  # @!attribute [rw] webhook_arn
2884
- # ARN for the webhook.
3067
+ # The Amazon Resource Name (ARN) for the webhook.
2885
3068
  # @return [String]
2886
3069
  #
2887
3070
  # @!attribute [rw] webhook_id
2888
- # Id of the webhook.
3071
+ # The ID of the webhook.
2889
3072
  # @return [String]
2890
3073
  #
2891
3074
  # @!attribute [rw] webhook_url
2892
- # Url of the webhook.
3075
+ # The URL of the webhook.
2893
3076
  # @return [String]
2894
3077
  #
2895
3078
  # @!attribute [rw] branch_name
2896
- # Name for a branch, part of an Amplify App.
3079
+ # The name for a branch that is part of an Amplify app.
2897
3080
  # @return [String]
2898
3081
  #
2899
3082
  # @!attribute [rw] description
2900
- # Description for a webhook.
3083
+ # The description for a webhook.
2901
3084
  # @return [String]
2902
3085
  #
2903
3086
  # @!attribute [rw] create_time
2904
- # Create date / time for a webhook.
3087
+ # The create date and time for a webhook.
2905
3088
  # @return [Time]
2906
3089
  #
2907
3090
  # @!attribute [rw] update_time
2908
- # Update date / time for a webhook.
3091
+ # Updates the date and time for a webhook.
2909
3092
  # @return [Time]
2910
3093
  #
2911
3094
  # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Webhook AWS API Documentation
@@ -2918,6 +3101,7 @@ module Aws::Amplify
2918
3101
  :description,
2919
3102
  :create_time,
2920
3103
  :update_time)
3104
+ SENSITIVE = []
2921
3105
  include Aws::Structure
2922
3106
  end
2923
3107