aws-sdk-amplify 1.19.0 → 1.24.0

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