aws-sdk-amplify 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-amplify.rb +1 -1
- data/lib/aws-sdk-amplify/client.rb +536 -27
- data/lib/aws-sdk-amplify/client_api.rb +303 -12
- data/lib/aws-sdk-amplify/errors.rb +21 -0
- data/lib/aws-sdk-amplify/types.rb +675 -21
- metadata +2 -2
@@ -90,6 +90,27 @@ module Aws::Amplify
|
|
90
90
|
|
91
91
|
end
|
92
92
|
|
93
|
+
class ResourceNotFoundException < ServiceError
|
94
|
+
|
95
|
+
# @param [Seahorse::Client::RequestContext] context
|
96
|
+
# @param [String] message
|
97
|
+
# @param [Aws::Amplify::Types::ResourceNotFoundException] data
|
98
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
99
|
+
super(context, message, data)
|
100
|
+
end
|
101
|
+
|
102
|
+
# @return [String]
|
103
|
+
def code
|
104
|
+
@code || @data[:code]
|
105
|
+
end
|
106
|
+
|
107
|
+
# @return [String]
|
108
|
+
def message
|
109
|
+
@message || @data[:message]
|
110
|
+
end
|
111
|
+
|
112
|
+
end
|
113
|
+
|
93
114
|
class UnauthorizedException < ServiceError
|
94
115
|
|
95
116
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -83,6 +83,18 @@ module Aws::Amplify
|
|
83
83
|
# BuildSpec content for Amplify App.
|
84
84
|
# @return [String]
|
85
85
|
#
|
86
|
+
# @!attribute [rw] enable_auto_branch_creation
|
87
|
+
# Enables automated branch creation for the Amplify App.
|
88
|
+
# @return [Boolean]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] auto_branch_creation_patterns
|
91
|
+
# Automated branch creation glob patterns for the Amplify App.
|
92
|
+
# @return [Array<String>]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] auto_branch_creation_config
|
95
|
+
# Automated branch creation config for the Amplify App.
|
96
|
+
# @return [Types::AutoBranchCreationConfig]
|
97
|
+
#
|
86
98
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/App AWS API Documentation
|
87
99
|
#
|
88
100
|
class App < Struct.new(
|
@@ -103,6 +115,67 @@ module Aws::Amplify
|
|
103
115
|
:basic_auth_credentials,
|
104
116
|
:custom_rules,
|
105
117
|
:production_branch,
|
118
|
+
:build_spec,
|
119
|
+
:enable_auto_branch_creation,
|
120
|
+
:auto_branch_creation_patterns,
|
121
|
+
:auto_branch_creation_config)
|
122
|
+
include Aws::Structure
|
123
|
+
end
|
124
|
+
|
125
|
+
# Structure with auto branch creation config.
|
126
|
+
#
|
127
|
+
# @note When making an API call, you may pass AutoBranchCreationConfig
|
128
|
+
# data as a hash:
|
129
|
+
#
|
130
|
+
# {
|
131
|
+
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
|
132
|
+
# framework: "Framework",
|
133
|
+
# enable_auto_build: false,
|
134
|
+
# environment_variables: {
|
135
|
+
# "EnvKey" => "EnvValue",
|
136
|
+
# },
|
137
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
138
|
+
# enable_basic_auth: false,
|
139
|
+
# build_spec: "BuildSpec",
|
140
|
+
# }
|
141
|
+
#
|
142
|
+
# @!attribute [rw] stage
|
143
|
+
# Stage for the auto created branch.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] framework
|
147
|
+
# Framework for the auto created branch.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] enable_auto_build
|
151
|
+
# Enables auto building for the auto created branch.
|
152
|
+
# @return [Boolean]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] environment_variables
|
155
|
+
# Environment Variables for the auto created branch.
|
156
|
+
# @return [Hash<String,String>]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] basic_auth_credentials
|
159
|
+
# Basic Authorization credentials for the auto created branch.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @!attribute [rw] enable_basic_auth
|
163
|
+
# Enables Basic Auth for the auto created branch.
|
164
|
+
# @return [Boolean]
|
165
|
+
#
|
166
|
+
# @!attribute [rw] build_spec
|
167
|
+
# BuildSpec for the auto created branch.
|
168
|
+
# @return [String]
|
169
|
+
#
|
170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/AutoBranchCreationConfig AWS API Documentation
|
171
|
+
#
|
172
|
+
class AutoBranchCreationConfig < Struct.new(
|
173
|
+
:stage,
|
174
|
+
:framework,
|
175
|
+
:enable_auto_build,
|
176
|
+
:environment_variables,
|
177
|
+
:basic_auth_credentials,
|
178
|
+
:enable_basic_auth,
|
106
179
|
:build_spec)
|
107
180
|
include Aws::Structure
|
108
181
|
end
|
@@ -143,7 +216,7 @@ module Aws::Amplify
|
|
143
216
|
# @return [String]
|
144
217
|
#
|
145
218
|
# @!attribute [rw] display_name
|
146
|
-
# Display name for a branch,
|
219
|
+
# Display name for a branch, will use as the default domain prefix.
|
147
220
|
# @return [String]
|
148
221
|
#
|
149
222
|
# @!attribute [rw] enable_notification
|
@@ -187,7 +260,7 @@ module Aws::Amplify
|
|
187
260
|
# @return [Boolean]
|
188
261
|
#
|
189
262
|
# @!attribute [rw] thumbnail_url
|
190
|
-
# Thumbnail
|
263
|
+
# Thumbnail URL for the branch.
|
191
264
|
# @return [String]
|
192
265
|
#
|
193
266
|
# @!attribute [rw] basic_auth_credentials
|
@@ -203,6 +276,10 @@ module Aws::Amplify
|
|
203
276
|
# The content TTL for the website in seconds.
|
204
277
|
# @return [String]
|
205
278
|
#
|
279
|
+
# @!attribute [rw] associated_resources
|
280
|
+
# List of custom resources that are linked to this branch.
|
281
|
+
# @return [Array<String>]
|
282
|
+
#
|
206
283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Branch AWS API Documentation
|
207
284
|
#
|
208
285
|
class Branch < Struct.new(
|
@@ -225,7 +302,8 @@ module Aws::Amplify
|
|
225
302
|
:thumbnail_url,
|
226
303
|
:basic_auth_credentials,
|
227
304
|
:build_spec,
|
228
|
-
:ttl
|
305
|
+
:ttl,
|
306
|
+
:associated_resources)
|
229
307
|
include Aws::Structure
|
230
308
|
end
|
231
309
|
|
@@ -237,10 +315,11 @@ module Aws::Amplify
|
|
237
315
|
# {
|
238
316
|
# name: "Name", # required
|
239
317
|
# description: "Description",
|
240
|
-
# repository: "Repository",
|
241
|
-
# platform: "
|
318
|
+
# repository: "Repository",
|
319
|
+
# platform: "WEB", # accepts WEB
|
242
320
|
# iam_service_role_arn: "ServiceRoleArn",
|
243
|
-
# oauth_token: "OauthToken",
|
321
|
+
# oauth_token: "OauthToken",
|
322
|
+
# access_token: "AccessToken",
|
244
323
|
# environment_variables: {
|
245
324
|
# "EnvKey" => "EnvValue",
|
246
325
|
# },
|
@@ -259,6 +338,19 @@ module Aws::Amplify
|
|
259
338
|
# "TagKey" => "TagValue",
|
260
339
|
# },
|
261
340
|
# build_spec: "BuildSpec",
|
341
|
+
# enable_auto_branch_creation: false,
|
342
|
+
# auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
|
343
|
+
# auto_branch_creation_config: {
|
344
|
+
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
|
345
|
+
# framework: "Framework",
|
346
|
+
# enable_auto_build: false,
|
347
|
+
# environment_variables: {
|
348
|
+
# "EnvKey" => "EnvValue",
|
349
|
+
# },
|
350
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
351
|
+
# enable_basic_auth: false,
|
352
|
+
# build_spec: "BuildSpec",
|
353
|
+
# },
|
262
354
|
# }
|
263
355
|
#
|
264
356
|
# @!attribute [rw] name
|
@@ -287,6 +379,12 @@ module Aws::Amplify
|
|
287
379
|
# stored.
|
288
380
|
# @return [String]
|
289
381
|
#
|
382
|
+
# @!attribute [rw] access_token
|
383
|
+
# Personal Access token for 3rd party source control system for an
|
384
|
+
# Amplify App, used to create webhook and read-only deploy key. Token
|
385
|
+
# is not stored.
|
386
|
+
# @return [String]
|
387
|
+
#
|
290
388
|
# @!attribute [rw] environment_variables
|
291
389
|
# Environment variables map for an Amplify App.
|
292
390
|
# @return [Hash<String,String>]
|
@@ -316,6 +414,18 @@ module Aws::Amplify
|
|
316
414
|
# BuildSpec for an Amplify App
|
317
415
|
# @return [String]
|
318
416
|
#
|
417
|
+
# @!attribute [rw] enable_auto_branch_creation
|
418
|
+
# Enables automated branch creation for the Amplify App.
|
419
|
+
# @return [Boolean]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] auto_branch_creation_patterns
|
422
|
+
# Automated branch creation glob patterns for the Amplify App.
|
423
|
+
# @return [Array<String>]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] auto_branch_creation_config
|
426
|
+
# Automated branch creation config for the Amplify App.
|
427
|
+
# @return [Types::AutoBranchCreationConfig]
|
428
|
+
#
|
319
429
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateAppRequest AWS API Documentation
|
320
430
|
#
|
321
431
|
class CreateAppRequest < Struct.new(
|
@@ -325,13 +435,17 @@ module Aws::Amplify
|
|
325
435
|
:platform,
|
326
436
|
:iam_service_role_arn,
|
327
437
|
:oauth_token,
|
438
|
+
:access_token,
|
328
439
|
:environment_variables,
|
329
440
|
:enable_branch_auto_build,
|
330
441
|
:enable_basic_auth,
|
331
442
|
:basic_auth_credentials,
|
332
443
|
:custom_rules,
|
333
444
|
:tags,
|
334
|
-
:build_spec
|
445
|
+
:build_spec,
|
446
|
+
:enable_auto_branch_creation,
|
447
|
+
:auto_branch_creation_patterns,
|
448
|
+
:auto_branch_creation_config)
|
335
449
|
include Aws::Structure
|
336
450
|
end
|
337
451
|
|
@@ -370,6 +484,7 @@ module Aws::Amplify
|
|
370
484
|
# },
|
371
485
|
# build_spec: "BuildSpec",
|
372
486
|
# ttl: "TTL",
|
487
|
+
# display_name: "DisplayName",
|
373
488
|
# }
|
374
489
|
#
|
375
490
|
# @!attribute [rw] app_id
|
@@ -424,6 +539,10 @@ module Aws::Amplify
|
|
424
539
|
# The content TTL for the website in seconds.
|
425
540
|
# @return [String]
|
426
541
|
#
|
542
|
+
# @!attribute [rw] display_name
|
543
|
+
# Display name for a branch, will use as the default domain prefix.
|
544
|
+
# @return [String]
|
545
|
+
#
|
427
546
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchRequest AWS API Documentation
|
428
547
|
#
|
429
548
|
class CreateBranchRequest < Struct.new(
|
@@ -439,7 +558,8 @@ module Aws::Amplify
|
|
439
558
|
:enable_basic_auth,
|
440
559
|
:tags,
|
441
560
|
:build_spec,
|
442
|
-
:ttl
|
561
|
+
:ttl,
|
562
|
+
:display_name)
|
443
563
|
include Aws::Structure
|
444
564
|
end
|
445
565
|
|
@@ -456,6 +576,68 @@ module Aws::Amplify
|
|
456
576
|
include Aws::Structure
|
457
577
|
end
|
458
578
|
|
579
|
+
# Request structure for create a new deployment.
|
580
|
+
#
|
581
|
+
# @note When making an API call, you may pass CreateDeploymentRequest
|
582
|
+
# data as a hash:
|
583
|
+
#
|
584
|
+
# {
|
585
|
+
# app_id: "AppId", # required
|
586
|
+
# branch_name: "BranchName", # required
|
587
|
+
# file_map: {
|
588
|
+
# "FileName" => "MD5Hash",
|
589
|
+
# },
|
590
|
+
# }
|
591
|
+
#
|
592
|
+
# @!attribute [rw] app_id
|
593
|
+
# Unique Id for an Amplify App.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] branch_name
|
597
|
+
# Name for the branch, for the Job.
|
598
|
+
# @return [String]
|
599
|
+
#
|
600
|
+
# @!attribute [rw] file_map
|
601
|
+
# Optional file map that contains file name as the key and file
|
602
|
+
# content md5 hash as the value. If this argument is provided, the
|
603
|
+
# service will generate different upload url per file. Otherwise, the
|
604
|
+
# service will only generate a single upload url for the zipped files.
|
605
|
+
# @return [Hash<String,String>]
|
606
|
+
#
|
607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeploymentRequest AWS API Documentation
|
608
|
+
#
|
609
|
+
class CreateDeploymentRequest < Struct.new(
|
610
|
+
:app_id,
|
611
|
+
:branch_name,
|
612
|
+
:file_map)
|
613
|
+
include Aws::Structure
|
614
|
+
end
|
615
|
+
|
616
|
+
# Result structure for create a new deployment.
|
617
|
+
#
|
618
|
+
# @!attribute [rw] job_id
|
619
|
+
# The jobId for this deployment, will supply to start deployment api.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] file_upload_urls
|
623
|
+
# When the fileMap argument is provided in the request, the
|
624
|
+
# fileUploadUrls will contain a map of file names to upload url.
|
625
|
+
# @return [Hash<String,String>]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] zip_upload_url
|
628
|
+
# When the fileMap argument is NOT provided. This zipUploadUrl will be
|
629
|
+
# returned.
|
630
|
+
# @return [String]
|
631
|
+
#
|
632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDeploymentResult AWS API Documentation
|
633
|
+
#
|
634
|
+
class CreateDeploymentResult < Struct.new(
|
635
|
+
:job_id,
|
636
|
+
:file_upload_urls,
|
637
|
+
:zip_upload_url)
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
459
641
|
# Request structure for create Domain Association request.
|
460
642
|
#
|
461
643
|
# @note When making an API call, you may pass CreateDomainAssociationRequest
|
@@ -512,6 +694,51 @@ module Aws::Amplify
|
|
512
694
|
include Aws::Structure
|
513
695
|
end
|
514
696
|
|
697
|
+
# Request structure for create webhook request.
|
698
|
+
#
|
699
|
+
# @note When making an API call, you may pass CreateWebhookRequest
|
700
|
+
# data as a hash:
|
701
|
+
#
|
702
|
+
# {
|
703
|
+
# app_id: "AppId", # required
|
704
|
+
# branch_name: "BranchName", # required
|
705
|
+
# description: "Description",
|
706
|
+
# }
|
707
|
+
#
|
708
|
+
# @!attribute [rw] app_id
|
709
|
+
# Unique Id for an Amplify App.
|
710
|
+
# @return [String]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] branch_name
|
713
|
+
# Name for a branch, part of an Amplify App.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] description
|
717
|
+
# Description for a webhook.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhookRequest AWS API Documentation
|
721
|
+
#
|
722
|
+
class CreateWebhookRequest < Struct.new(
|
723
|
+
:app_id,
|
724
|
+
:branch_name,
|
725
|
+
:description)
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
729
|
+
# Result structure for the create webhook request.
|
730
|
+
#
|
731
|
+
# @!attribute [rw] webhook
|
732
|
+
# Webhook structure.
|
733
|
+
# @return [Types::Webhook]
|
734
|
+
#
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhookResult AWS API Documentation
|
736
|
+
#
|
737
|
+
class CreateWebhookResult < Struct.new(
|
738
|
+
:webhook)
|
739
|
+
include Aws::Structure
|
740
|
+
end
|
741
|
+
|
515
742
|
# Custom rewrite / redirect rule.
|
516
743
|
#
|
517
744
|
# @note When making an API call, you may pass CustomRule
|
@@ -706,6 +933,39 @@ module Aws::Amplify
|
|
706
933
|
include Aws::Structure
|
707
934
|
end
|
708
935
|
|
936
|
+
# Request structure for the delete webhook request.
|
937
|
+
#
|
938
|
+
# @note When making an API call, you may pass DeleteWebhookRequest
|
939
|
+
# data as a hash:
|
940
|
+
#
|
941
|
+
# {
|
942
|
+
# webhook_id: "WebhookId", # required
|
943
|
+
# }
|
944
|
+
#
|
945
|
+
# @!attribute [rw] webhook_id
|
946
|
+
# Unique Id for a webhook.
|
947
|
+
# @return [String]
|
948
|
+
#
|
949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhookRequest AWS API Documentation
|
950
|
+
#
|
951
|
+
class DeleteWebhookRequest < Struct.new(
|
952
|
+
:webhook_id)
|
953
|
+
include Aws::Structure
|
954
|
+
end
|
955
|
+
|
956
|
+
# Result structure for the delete webhook request.
|
957
|
+
#
|
958
|
+
# @!attribute [rw] webhook
|
959
|
+
# Webhook structure.
|
960
|
+
# @return [Types::Webhook]
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteWebhookResult AWS API Documentation
|
963
|
+
#
|
964
|
+
class DeleteWebhookResult < Struct.new(
|
965
|
+
:webhook)
|
966
|
+
include Aws::Structure
|
967
|
+
end
|
968
|
+
|
709
969
|
# Exception thrown when an operation fails due to a dependent service
|
710
970
|
# throwing an exception.
|
711
971
|
#
|
@@ -915,6 +1175,39 @@ module Aws::Amplify
|
|
915
1175
|
include Aws::Structure
|
916
1176
|
end
|
917
1177
|
|
1178
|
+
# Request structure for the get webhook request.
|
1179
|
+
#
|
1180
|
+
# @note When making an API call, you may pass GetWebhookRequest
|
1181
|
+
# data as a hash:
|
1182
|
+
#
|
1183
|
+
# {
|
1184
|
+
# webhook_id: "WebhookId", # required
|
1185
|
+
# }
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] webhook_id
|
1188
|
+
# Unique Id for a webhook.
|
1189
|
+
# @return [String]
|
1190
|
+
#
|
1191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhookRequest AWS API Documentation
|
1192
|
+
#
|
1193
|
+
class GetWebhookRequest < Struct.new(
|
1194
|
+
:webhook_id)
|
1195
|
+
include Aws::Structure
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# Result structure for the get webhook request.
|
1199
|
+
#
|
1200
|
+
# @!attribute [rw] webhook
|
1201
|
+
# Webhook structure.
|
1202
|
+
# @return [Types::Webhook]
|
1203
|
+
#
|
1204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetWebhookResult AWS API Documentation
|
1205
|
+
#
|
1206
|
+
class GetWebhookResult < Struct.new(
|
1207
|
+
:webhook)
|
1208
|
+
include Aws::Structure
|
1209
|
+
end
|
1210
|
+
|
918
1211
|
# Exception thrown when the service fails to perform an operation due to
|
919
1212
|
# an internal issue.
|
920
1213
|
#
|
@@ -981,7 +1274,9 @@ module Aws::Amplify
|
|
981
1274
|
# @return [Time]
|
982
1275
|
#
|
983
1276
|
# @!attribute [rw] job_type
|
984
|
-
# Type for the Job.
|
1277
|
+
# Type for the Job. \\n "RELEASE": Manually released from source by
|
1278
|
+
# using StartJob API. "RETRY": Manually retried by using StartJob
|
1279
|
+
# API. "WEB\_HOOK": Automatically triggered by WebHooks.
|
985
1280
|
# @return [String]
|
986
1281
|
#
|
987
1282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/JobSummary AWS API Documentation
|
@@ -1228,6 +1523,93 @@ module Aws::Amplify
|
|
1228
1523
|
include Aws::Structure
|
1229
1524
|
end
|
1230
1525
|
|
1526
|
+
# Request structure used to list tags for resource.
|
1527
|
+
#
|
1528
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1529
|
+
# data as a hash:
|
1530
|
+
#
|
1531
|
+
# {
|
1532
|
+
# resource_arn: "ResourceArn", # required
|
1533
|
+
# }
|
1534
|
+
#
|
1535
|
+
# @!attribute [rw] resource_arn
|
1536
|
+
# Resource arn used to list tags.
|
1537
|
+
# @return [String]
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResourceRequest AWS API Documentation
|
1540
|
+
#
|
1541
|
+
class ListTagsForResourceRequest < Struct.new(
|
1542
|
+
:resource_arn)
|
1543
|
+
include Aws::Structure
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# Response for list tags.
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] tags
|
1549
|
+
# Tags result for response.
|
1550
|
+
# @return [Hash<String,String>]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListTagsForResourceResponse AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class ListTagsForResourceResponse < Struct.new(
|
1555
|
+
:tags)
|
1556
|
+
include Aws::Structure
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
# Request structure for the list webhooks request.
|
1560
|
+
#
|
1561
|
+
# @note When making an API call, you may pass ListWebhooksRequest
|
1562
|
+
# data as a hash:
|
1563
|
+
#
|
1564
|
+
# {
|
1565
|
+
# app_id: "AppId", # required
|
1566
|
+
# next_token: "NextToken",
|
1567
|
+
# max_results: 1,
|
1568
|
+
# }
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] app_id
|
1571
|
+
# Unique Id for an Amplify App.
|
1572
|
+
# @return [String]
|
1573
|
+
#
|
1574
|
+
# @!attribute [rw] next_token
|
1575
|
+
# Pagination token. Set to null to start listing webhooks from start.
|
1576
|
+
# If non-null pagination token is returned in a result, then pass its
|
1577
|
+
# value in here to list more webhooks.
|
1578
|
+
# @return [String]
|
1579
|
+
#
|
1580
|
+
# @!attribute [rw] max_results
|
1581
|
+
# Maximum number of records to list in a single response.
|
1582
|
+
# @return [Integer]
|
1583
|
+
#
|
1584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooksRequest AWS API Documentation
|
1585
|
+
#
|
1586
|
+
class ListWebhooksRequest < Struct.new(
|
1587
|
+
:app_id,
|
1588
|
+
:next_token,
|
1589
|
+
:max_results)
|
1590
|
+
include Aws::Structure
|
1591
|
+
end
|
1592
|
+
|
1593
|
+
# Result structure for the list webhooks request.
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] webhooks
|
1596
|
+
# List of webhooks.
|
1597
|
+
# @return [Array<Types::Webhook>]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] next_token
|
1600
|
+
# Pagination token. If non-null pagination token is returned in a
|
1601
|
+
# result, then pass its value in another request to fetch more
|
1602
|
+
# entries.
|
1603
|
+
# @return [String]
|
1604
|
+
#
|
1605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListWebhooksResult AWS API Documentation
|
1606
|
+
#
|
1607
|
+
class ListWebhooksResult < Struct.new(
|
1608
|
+
:webhooks,
|
1609
|
+
:next_token)
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1612
|
+
|
1231
1613
|
# Exception thrown when an entity has not been found during an
|
1232
1614
|
# operation.
|
1233
1615
|
#
|
@@ -1252,7 +1634,7 @@ module Aws::Amplify
|
|
1252
1634
|
# @return [String]
|
1253
1635
|
#
|
1254
1636
|
# @!attribute [rw] thumbnail_url
|
1255
|
-
# Thumbnail
|
1637
|
+
# Thumbnail URL for Production Branch.
|
1256
1638
|
# @return [String]
|
1257
1639
|
#
|
1258
1640
|
# @!attribute [rw] branch_name
|
@@ -1269,6 +1651,76 @@ module Aws::Amplify
|
|
1269
1651
|
include Aws::Structure
|
1270
1652
|
end
|
1271
1653
|
|
1654
|
+
# Exception thrown when an operation fails due to non-existent resource.
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] code
|
1657
|
+
# @return [String]
|
1658
|
+
#
|
1659
|
+
# @!attribute [rw] message
|
1660
|
+
# @return [String]
|
1661
|
+
#
|
1662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ResourceNotFoundException AWS API Documentation
|
1663
|
+
#
|
1664
|
+
class ResourceNotFoundException < Struct.new(
|
1665
|
+
:code,
|
1666
|
+
:message)
|
1667
|
+
include Aws::Structure
|
1668
|
+
end
|
1669
|
+
|
1670
|
+
# Request structure for start a deployment.
|
1671
|
+
#
|
1672
|
+
# @note When making an API call, you may pass StartDeploymentRequest
|
1673
|
+
# data as a hash:
|
1674
|
+
#
|
1675
|
+
# {
|
1676
|
+
# app_id: "AppId", # required
|
1677
|
+
# branch_name: "BranchName", # required
|
1678
|
+
# job_id: "JobId",
|
1679
|
+
# source_url: "SourceUrl",
|
1680
|
+
# }
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] app_id
|
1683
|
+
# Unique Id for an Amplify App.
|
1684
|
+
# @return [String]
|
1685
|
+
#
|
1686
|
+
# @!attribute [rw] branch_name
|
1687
|
+
# Name for the branch, for the Job.
|
1688
|
+
# @return [String]
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] job_id
|
1691
|
+
# The job id for this deployment, generated by create deployment
|
1692
|
+
# request.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] source_url
|
1696
|
+
# The sourceUrl for this deployment, used when calling start
|
1697
|
+
# deployment without create deployment. SourceUrl can be any HTTP GET
|
1698
|
+
# url that is public accessible and downloads a single zip.
|
1699
|
+
# @return [String]
|
1700
|
+
#
|
1701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeploymentRequest AWS API Documentation
|
1702
|
+
#
|
1703
|
+
class StartDeploymentRequest < Struct.new(
|
1704
|
+
:app_id,
|
1705
|
+
:branch_name,
|
1706
|
+
:job_id,
|
1707
|
+
:source_url)
|
1708
|
+
include Aws::Structure
|
1709
|
+
end
|
1710
|
+
|
1711
|
+
# Result structure for start a deployment.
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] job_summary
|
1714
|
+
# Summary for the Job.
|
1715
|
+
# @return [Types::JobSummary]
|
1716
|
+
#
|
1717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeploymentResult AWS API Documentation
|
1718
|
+
#
|
1719
|
+
class StartDeploymentResult < Struct.new(
|
1720
|
+
:job_summary)
|
1721
|
+
include Aws::Structure
|
1722
|
+
end
|
1723
|
+
|
1272
1724
|
# Request structure for Start job request.
|
1273
1725
|
#
|
1274
1726
|
# @note When making an API call, you may pass StartJobRequest
|
@@ -1278,7 +1730,7 @@ module Aws::Amplify
|
|
1278
1730
|
# app_id: "AppId", # required
|
1279
1731
|
# branch_name: "BranchName", # required
|
1280
1732
|
# job_id: "JobId",
|
1281
|
-
# job_type: "RELEASE", # required, accepts RELEASE, RETRY, WEB_HOOK
|
1733
|
+
# job_type: "RELEASE", # required, accepts RELEASE, RETRY, MANUAL, WEB_HOOK
|
1282
1734
|
# job_reason: "JobReason",
|
1283
1735
|
# commit_id: "CommitId",
|
1284
1736
|
# commit_message: "CommitMessage",
|
@@ -1294,15 +1746,18 @@ module Aws::Amplify
|
|
1294
1746
|
# @return [String]
|
1295
1747
|
#
|
1296
1748
|
# @!attribute [rw] job_id
|
1297
|
-
# Unique Id for
|
1749
|
+
# Unique Id for an existing job. Required for "RETRY" JobType.
|
1298
1750
|
# @return [String]
|
1299
1751
|
#
|
1300
1752
|
# @!attribute [rw] job_type
|
1301
|
-
# Type for the Job.
|
1753
|
+
# Type for the Job. Available JobTypes are: \\n "RELEASE": Start a
|
1754
|
+
# new job with the latest change from the specified branch. Only
|
1755
|
+
# available for apps that have connected to a repository. "RETRY":
|
1756
|
+
# Retry an existing job. JobId is required for this type of job.
|
1302
1757
|
# @return [String]
|
1303
1758
|
#
|
1304
1759
|
# @!attribute [rw] job_reason
|
1305
|
-
#
|
1760
|
+
# Descriptive reason for starting this job.
|
1306
1761
|
# @return [String]
|
1307
1762
|
#
|
1308
1763
|
# @!attribute [rw] commit_id
|
@@ -1364,17 +1819,26 @@ module Aws::Amplify
|
|
1364
1819
|
# @return [Time]
|
1365
1820
|
#
|
1366
1821
|
# @!attribute [rw] log_url
|
1367
|
-
#
|
1822
|
+
# URL to the logs for the execution step.
|
1368
1823
|
# @return [String]
|
1369
1824
|
#
|
1370
1825
|
# @!attribute [rw] artifacts_url
|
1371
|
-
#
|
1826
|
+
# URL to the artifact for the execution step.
|
1372
1827
|
# @return [String]
|
1373
1828
|
#
|
1374
1829
|
# @!attribute [rw] screenshots
|
1375
|
-
# List of screenshot
|
1830
|
+
# List of screenshot URLs for the execution step, if relevant.
|
1376
1831
|
# @return [Hash<String,String>]
|
1377
1832
|
#
|
1833
|
+
# @!attribute [rw] status_reason
|
1834
|
+
# The reason for current step status.
|
1835
|
+
# @return [String]
|
1836
|
+
#
|
1837
|
+
# @!attribute [rw] context
|
1838
|
+
# The context for current step, will include build image if step is
|
1839
|
+
# build.
|
1840
|
+
# @return [String]
|
1841
|
+
#
|
1378
1842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Step AWS API Documentation
|
1379
1843
|
#
|
1380
1844
|
class Step < Struct.new(
|
@@ -1384,7 +1848,9 @@ module Aws::Amplify
|
|
1384
1848
|
:end_time,
|
1385
1849
|
:log_url,
|
1386
1850
|
:artifacts_url,
|
1387
|
-
:screenshots
|
1851
|
+
:screenshots,
|
1852
|
+
:status_reason,
|
1853
|
+
:context)
|
1388
1854
|
include Aws::Structure
|
1389
1855
|
end
|
1390
1856
|
|
@@ -1482,6 +1948,40 @@ module Aws::Amplify
|
|
1482
1948
|
include Aws::Structure
|
1483
1949
|
end
|
1484
1950
|
|
1951
|
+
# Request structure used to tag resource.
|
1952
|
+
#
|
1953
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1954
|
+
# data as a hash:
|
1955
|
+
#
|
1956
|
+
# {
|
1957
|
+
# resource_arn: "ResourceArn", # required
|
1958
|
+
# tags: { # required
|
1959
|
+
# "TagKey" => "TagValue",
|
1960
|
+
# },
|
1961
|
+
# }
|
1962
|
+
#
|
1963
|
+
# @!attribute [rw] resource_arn
|
1964
|
+
# Resource arn used to tag resource.
|
1965
|
+
# @return [String]
|
1966
|
+
#
|
1967
|
+
# @!attribute [rw] tags
|
1968
|
+
# Tags used to tag resource.
|
1969
|
+
# @return [Hash<String,String>]
|
1970
|
+
#
|
1971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResourceRequest AWS API Documentation
|
1972
|
+
#
|
1973
|
+
class TagResourceRequest < Struct.new(
|
1974
|
+
:resource_arn,
|
1975
|
+
:tags)
|
1976
|
+
include Aws::Structure
|
1977
|
+
end
|
1978
|
+
|
1979
|
+
# Response for tag resource.
|
1980
|
+
#
|
1981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/TagResourceResponse AWS API Documentation
|
1982
|
+
#
|
1983
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1984
|
+
|
1485
1985
|
# Exception thrown when an operation fails due to a lack of access.
|
1486
1986
|
#
|
1487
1987
|
# @!attribute [rw] message
|
@@ -1494,6 +1994,38 @@ module Aws::Amplify
|
|
1494
1994
|
include Aws::Structure
|
1495
1995
|
end
|
1496
1996
|
|
1997
|
+
# Request structure used to untag resource.
|
1998
|
+
#
|
1999
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
2000
|
+
# data as a hash:
|
2001
|
+
#
|
2002
|
+
# {
|
2003
|
+
# resource_arn: "ResourceArn", # required
|
2004
|
+
# tag_keys: ["TagKey"], # required
|
2005
|
+
# }
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] resource_arn
|
2008
|
+
# Resource arn used to untag resource.
|
2009
|
+
# @return [String]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] tag_keys
|
2012
|
+
# Tag keys used to untag resource.
|
2013
|
+
# @return [Array<String>]
|
2014
|
+
#
|
2015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResourceRequest AWS API Documentation
|
2016
|
+
#
|
2017
|
+
class UntagResourceRequest < Struct.new(
|
2018
|
+
:resource_arn,
|
2019
|
+
:tag_keys)
|
2020
|
+
include Aws::Structure
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# Response for untag resource.
|
2024
|
+
#
|
2025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UntagResourceResponse AWS API Documentation
|
2026
|
+
#
|
2027
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2028
|
+
|
1497
2029
|
# Request structure for update App request.
|
1498
2030
|
#
|
1499
2031
|
# @note When making an API call, you may pass UpdateAppRequest
|
@@ -1503,7 +2035,7 @@ module Aws::Amplify
|
|
1503
2035
|
# app_id: "AppId", # required
|
1504
2036
|
# name: "Name",
|
1505
2037
|
# description: "Description",
|
1506
|
-
# platform: "
|
2038
|
+
# platform: "WEB", # accepts WEB
|
1507
2039
|
# iam_service_role_arn: "ServiceRoleArn",
|
1508
2040
|
# environment_variables: {
|
1509
2041
|
# "EnvKey" => "EnvValue",
|
@@ -1520,6 +2052,19 @@ module Aws::Amplify
|
|
1520
2052
|
# },
|
1521
2053
|
# ],
|
1522
2054
|
# build_spec: "BuildSpec",
|
2055
|
+
# enable_auto_branch_creation: false,
|
2056
|
+
# auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
|
2057
|
+
# auto_branch_creation_config: {
|
2058
|
+
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
|
2059
|
+
# framework: "Framework",
|
2060
|
+
# enable_auto_build: false,
|
2061
|
+
# environment_variables: {
|
2062
|
+
# "EnvKey" => "EnvValue",
|
2063
|
+
# },
|
2064
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
2065
|
+
# enable_basic_auth: false,
|
2066
|
+
# build_spec: "BuildSpec",
|
2067
|
+
# },
|
1523
2068
|
# }
|
1524
2069
|
#
|
1525
2070
|
# @!attribute [rw] app_id
|
@@ -1566,6 +2111,18 @@ module Aws::Amplify
|
|
1566
2111
|
# BuildSpec for an Amplify App.
|
1567
2112
|
# @return [String]
|
1568
2113
|
#
|
2114
|
+
# @!attribute [rw] enable_auto_branch_creation
|
2115
|
+
# Enables automated branch creation for the Amplify App.
|
2116
|
+
# @return [Boolean]
|
2117
|
+
#
|
2118
|
+
# @!attribute [rw] auto_branch_creation_patterns
|
2119
|
+
# Automated branch creation glob patterns for the Amplify App.
|
2120
|
+
# @return [Array<String>]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] auto_branch_creation_config
|
2123
|
+
# Automated branch creation config for the Amplify App.
|
2124
|
+
# @return [Types::AutoBranchCreationConfig]
|
2125
|
+
#
|
1569
2126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppRequest AWS API Documentation
|
1570
2127
|
#
|
1571
2128
|
class UpdateAppRequest < Struct.new(
|
@@ -1579,7 +2136,10 @@ module Aws::Amplify
|
|
1579
2136
|
:enable_basic_auth,
|
1580
2137
|
:basic_auth_credentials,
|
1581
2138
|
:custom_rules,
|
1582
|
-
:build_spec
|
2139
|
+
:build_spec,
|
2140
|
+
:enable_auto_branch_creation,
|
2141
|
+
:auto_branch_creation_patterns,
|
2142
|
+
:auto_branch_creation_config)
|
1583
2143
|
include Aws::Structure
|
1584
2144
|
end
|
1585
2145
|
|
@@ -1616,6 +2176,7 @@ module Aws::Amplify
|
|
1616
2176
|
# enable_basic_auth: false,
|
1617
2177
|
# build_spec: "BuildSpec",
|
1618
2178
|
# ttl: "TTL",
|
2179
|
+
# display_name: "DisplayName",
|
1619
2180
|
# }
|
1620
2181
|
#
|
1621
2182
|
# @!attribute [rw] app_id
|
@@ -1666,6 +2227,10 @@ module Aws::Amplify
|
|
1666
2227
|
# The content TTL for the website in seconds.
|
1667
2228
|
# @return [String]
|
1668
2229
|
#
|
2230
|
+
# @!attribute [rw] display_name
|
2231
|
+
# Display name for a branch, will use as the default domain prefix.
|
2232
|
+
# @return [String]
|
2233
|
+
#
|
1669
2234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest AWS API Documentation
|
1670
2235
|
#
|
1671
2236
|
class UpdateBranchRequest < Struct.new(
|
@@ -1680,7 +2245,8 @@ module Aws::Amplify
|
|
1680
2245
|
:basic_auth_credentials,
|
1681
2246
|
:enable_basic_auth,
|
1682
2247
|
:build_spec,
|
1683
|
-
:ttl
|
2248
|
+
:ttl,
|
2249
|
+
:display_name)
|
1684
2250
|
include Aws::Structure
|
1685
2251
|
end
|
1686
2252
|
|
@@ -1753,5 +2319,93 @@ module Aws::Amplify
|
|
1753
2319
|
include Aws::Structure
|
1754
2320
|
end
|
1755
2321
|
|
2322
|
+
# Request structure for update webhook request.
|
2323
|
+
#
|
2324
|
+
# @note When making an API call, you may pass UpdateWebhookRequest
|
2325
|
+
# data as a hash:
|
2326
|
+
#
|
2327
|
+
# {
|
2328
|
+
# webhook_id: "WebhookId", # required
|
2329
|
+
# branch_name: "BranchName",
|
2330
|
+
# description: "Description",
|
2331
|
+
# }
|
2332
|
+
#
|
2333
|
+
# @!attribute [rw] webhook_id
|
2334
|
+
# Unique Id for a webhook.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] branch_name
|
2338
|
+
# Name for a branch, part of an Amplify App.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] description
|
2342
|
+
# Description for a webhook.
|
2343
|
+
# @return [String]
|
2344
|
+
#
|
2345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhookRequest AWS API Documentation
|
2346
|
+
#
|
2347
|
+
class UpdateWebhookRequest < Struct.new(
|
2348
|
+
:webhook_id,
|
2349
|
+
:branch_name,
|
2350
|
+
:description)
|
2351
|
+
include Aws::Structure
|
2352
|
+
end
|
2353
|
+
|
2354
|
+
# Result structure for the update webhook request.
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] webhook
|
2357
|
+
# Webhook structure.
|
2358
|
+
# @return [Types::Webhook]
|
2359
|
+
#
|
2360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateWebhookResult AWS API Documentation
|
2361
|
+
#
|
2362
|
+
class UpdateWebhookResult < Struct.new(
|
2363
|
+
:webhook)
|
2364
|
+
include Aws::Structure
|
2365
|
+
end
|
2366
|
+
|
2367
|
+
# Structure for webhook, which associates a webhook with an Amplify App.
|
2368
|
+
#
|
2369
|
+
# @!attribute [rw] webhook_arn
|
2370
|
+
# ARN for the webhook.
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] webhook_id
|
2374
|
+
# Id of the webhook.
|
2375
|
+
# @return [String]
|
2376
|
+
#
|
2377
|
+
# @!attribute [rw] webhook_url
|
2378
|
+
# Url of the webhook.
|
2379
|
+
# @return [String]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] branch_name
|
2382
|
+
# Name for a branch, part of an Amplify App.
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2385
|
+
# @!attribute [rw] description
|
2386
|
+
# Description for a webhook.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @!attribute [rw] create_time
|
2390
|
+
# Create date / time for a webhook.
|
2391
|
+
# @return [Time]
|
2392
|
+
#
|
2393
|
+
# @!attribute [rw] update_time
|
2394
|
+
# Update date / time for a webhook.
|
2395
|
+
# @return [Time]
|
2396
|
+
#
|
2397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Webhook AWS API Documentation
|
2398
|
+
#
|
2399
|
+
class Webhook < Struct.new(
|
2400
|
+
:webhook_arn,
|
2401
|
+
:webhook_id,
|
2402
|
+
:webhook_url,
|
2403
|
+
:branch_name,
|
2404
|
+
:description,
|
2405
|
+
:create_time,
|
2406
|
+
:update_time)
|
2407
|
+
include Aws::Structure
|
2408
|
+
end
|
2409
|
+
|
1756
2410
|
end
|
1757
2411
|
end
|