Skip to content
Navigation Menu
{{ message }}
This repository was archived by the owner on Mar 23, 2026. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1082 lines (1082 loc) · 30.1 KB
/
Copy pathopenapi.yaml
File metadata and controls
1082 lines (1082 loc) · 30.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
contact:
email: info@localstack.cloud
name: LocalStack Support
url: https://www.localstack.cloud/contact
summary: The LocalStack REST API exposes functionality related to diagnostics, health
checks, plugins, initialisation hooks, service introspection, and more.
termsOfService: https://www.localstack.cloud/legal/tos
title: LocalStack REST API for Community
version: latest
externalDocs:
description: LocalStack Documentation
url: https://docs.localstack.cloud
servers:
- url: http://{host}:{port}
variables:
port:
default: '4566'
host:
default: 'localhost.localstack.cloud'
components:
parameters:
SesIdFilter:
description: Filter for the `id` field in SES message
in: query
name: id
required: false
schema:
type: string
SesEmailFilter:
description: Filter for the `source` field in SES message
in: query
name: email
required: false
schema:
type: string
SnsAccountId:
description: '`accountId` field of the resource'
in: query
name: accountId
required: false
schema:
default: '000000000000'
type: string
SnsEndpointArn:
description: '`endpointArn` field of the resource'
in: query
name: endpointArn
required: false
schema:
type: string
SnsPhoneNumber:
description: '`phoneNumber` field of the resource'
in: query
name: phoneNumber
required: false
schema:
type: string
SnsRegion:
description: '`region` field of the resource'
in: query
name: region
required: false
schema:
default: us-east-1
type: string
schemas:
InitScripts:
additionalProperties: false
properties:
completed:
additionalProperties: false
properties:
BOOT:
type: boolean
READY:
type: boolean
SHUTDOWN:
type: boolean
START:
type: boolean
required:
- BOOT
- START
- READY
- SHUTDOWN
type: object
scripts:
items:
additionalProperties: false
properties:
name:
type: string
stage:
type: string
state:
type: string
required:
- stage
- name
- state
type: object
type: array
required:
- completed
- scripts
type: object
InitScriptsStage:
additionalProperties: false
properties:
completed:
type: boolean
scripts:
items:
additionalProperties: false
properties:
name:
type: string
stage:
type: string
state:
type: string
required:
- stage
- name
- state
type: object
type: array
required:
- completed
- scripts
type: object
SESDestination:
type: object
description: Possible destination of a SES message
properties:
ToAddresses:
type: array
items:
type: string
format: email
CcAddresses:
type: array
items:
type: string
format: email
BccAddresses:
type: array
items:
type: string
format: email
additionalProperties: false
SesSentEmail:
additionalProperties: false
properties:
Body:
additionalProperties: false
properties:
html_part:
type: string
text_part:
type: string
required:
- text_part
type: object
Destination:
$ref: '#/components/schemas/SESDestination'
Id:
type: string
RawData:
type: string
Region:
type: string
Source:
type: string
Subject:
type: string
Template:
type: string
TemplateData:
type: string
Timestamp:
type: string
required:
- Id
- Region
- Timestamp
- Source
type: object
SessionInfo:
additionalProperties: false
properties:
edition:
type: string
is_docker:
type: boolean
is_license_activated:
type: boolean
machine_id:
type: string
server_time_utc:
type: string
session_id:
type: string
system:
type: string
uptime:
type: integer
version:
type: string
required:
- version
- edition
- is_license_activated
- session_id
- machine_id
- system
- is_docker
- server_time_utc
- uptime
type: object
SnsSubscriptionTokenError:
additionalProperties: false
properties:
error:
type: string
subscription_arn:
type: string
required:
- error
- subscription_arn
type: object
SNSPlatformEndpointMessage:
type: object
description: Message sent to a platform endpoint via SNS
additionalProperties: false
properties:
TargetArn:
type: string
TopicArn:
type: string
Message:
type: string
MessageAttributes:
type: object
MessageStructure:
type: string
Subject:
type: [string, 'null']
MessageId:
type: string
SNSMessage:
type: object
description: Message sent via SNS
properties:
PhoneNumber:
type: string
TopicArn:
type: [string, 'null']
SubscriptionArn:
type: [string, 'null']
MessageId:
type: string
Message:
type: string
MessageAttributes:
type: object
MessageStructure:
type: [string, 'null']
Subject:
type: [string, 'null']
SNSPlatformEndpointMessages:
type: object
description: |
Messages sent to the platform endpoint retrieved via the retrospective endpoint.
The endpoint ARN is the key with a list of messages as value.
additionalProperties:
type: array
items:
$ref: '#/components/schemas/SNSPlatformEndpointMessage'
SMSMessages:
type: object
description: |
SMS messages retrieved via the retrospective endpoint.
The phone number is the key with a list of messages as value.
additionalProperties:
type: array
items:
$ref: '#/components/schemas/SNSMessage'
SNSPlatformEndpointResponse:
type: object
additionalProperties: false
description: Response payload for the /_aws/sns/platform-endpoint-messages endpoint
properties:
region:
type: string
description: "The AWS region, e.g., us-east-1"
platform_endpoint_messages:
$ref: '#/components/schemas/SNSPlatformEndpointMessages'
required:
- region
- platform_endpoint_messages
SNSSMSMessagesResponse:
type: object
additionalProperties: false
description: Response payload for the /_aws/sns/sms-messages endpoint
properties:
region:
type: string
description: "The AWS region, e.g., us-east-1"
sms_messages:
$ref: '#/components/schemas/SMSMessages'
required:
- region
- sms_messages
ReceiveMessageRequest:
type: object
description: https://github.com/boto/botocore/blob/develop/botocore/data/sqs/2012-11-05/service-2.json
required:
- QueueUrl
properties:
QueueUrl:
type: string
format: uri
AttributeNames:
type: array
items:
type: string
MessageSystemAttributeNames:
type: array
items:
type: string
MessageAttributeNames:
type: array
items:
type: string
MaxNumberOfMessages:
type: integer
VisibilityTimeout:
type: integer
WaitTimeSeconds:
type: integer
ReceiveRequestAttemptId:
type: string
ReceiveMessageResult:
type: object
description: https://github.com/boto/botocore/blob/develop/botocore/data/sqs/2012-11-05/service-2.json
properties:
Messages:
type: array
items:
$ref: '#/components/schemas/Message'
Message:
type: object
properties:
MessageId:
type: [string, 'null']
ReceiptHandle:
type: [string, 'null']
MD5OfBody:
type: [string, 'null']
Body:
type: [string, 'null']
Attributes:
type: object
MessageAttributes:
type: object
CloudWatchMetrics:
additionalProperties: false
properties:
metrics:
items:
additionalProperties: false
properties:
account:
description: Account ID
type: string
d:
description: Dimensions
items:
additionalProperties: false
properties:
n:
description: Dimension name
type: string
v:
description: Dimension value
oneOf:
- type: string
- type: integer
required:
- n
- v
type: object
type: array
n:
description: Metric name
type: string
ns:
description: Namespace
type: string
region:
description: Region name
type: string
t:
description: Timestamp
oneOf:
- type: string
format: date-time
- type: number
v:
description: Metric value
oneOf:
- type: string
- type: integer
required:
- ns
- n
- v
- t
- d
- account
- region
type: object
type: array
required:
- metrics
type: object
paths:
/_aws/cloudwatch/metrics/raw:
get:
description: Retrieve CloudWatch metrics
operationId: get_cloudwatch_metrics
tags: [aws]
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CloudWatchMetrics'
description: CloudWatch metrics
/_aws/dynamodb/expired:
delete:
description: Delete expired items from TTL-enabled DynamoDB tables
operationId: delete_ddb_expired_items
tags: [aws]
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
ExpiredItems:
description: Number of expired items that were deleted
type: integer
required:
- ExpiredItems
type: object
description: Operation was successful
/_aws/events/rules/{rule_arn}/trigger:
get:
description: Trigger a scheduled EventBridge rule
operationId: trigger_event_bridge_rule
tags: [aws]
parameters:
- description: EventBridge rule ARN
in: path
name: rule_arn
required: true
schema:
type: string
responses:
'200':
description: EventBridge rule was triggered
'404':
description: Not found
/_aws/lambda/init:
get:
description: Retrieve Lambda runtime init binary
operationId: get_lambda_init
tags: [aws]
responses:
'200':
content:
application/octet-stream: {}
description: Lambda runtime init binary
/_aws/lambda/runtimes:
get:
description: List available Lambda runtimes
operationId: get_lambda_runtimes
tags: [aws]
parameters:
- in: query
name: filter
required: false
schema:
default: supported
enum:
- all
- deprecated
- supported
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
Runtimes:
items:
type: string
type: array
required:
- Runtimes
type: object
description: Available Lambda runtimes
/_aws/ses:
delete:
description: Discard sent SES messages
operationId: discard_ses_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SesIdFilter'
responses:
'204':
description: Message was successfully discarded
get:
description: Retrieve sent SES messages
operationId: get_ses_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SesIdFilter'
- $ref: '#/components/parameters/SesEmailFilter'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
messages:
items:
$ref: '#/components/schemas/SesSentEmail'
type: array
required:
- messages
type: object
description: List of sent messages
/_aws/sns/platform-endpoint-messages:
delete:
description: Discard the messages published to a platform endpoint via SNS
operationId: discard_sns_endpoint_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SnsAccountId'
- $ref: '#/components/parameters/SnsRegion'
- $ref: '#/components/parameters/SnsEndpointArn'
responses:
'204':
description: Platform endpoint message was discarded
get:
description: Retrieve the messages sent to a platform endpoint via SNS
operationId: get_sns_endpoint_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SnsAccountId'
- $ref: '#/components/parameters/SnsRegion'
- $ref: '#/components/parameters/SnsEndpointArn'
responses:
'200':
content:
application/json:
schema:
$ref: "#/components/schemas/SNSPlatformEndpointResponse"
description: SNS messages via retrospective access
/_aws/sns/sms-messages:
delete:
description: Discard SNS SMS messages
operationId: discard_sns_sms_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SnsAccountId'
- $ref: '#/components/parameters/SnsRegion'
- $ref: '#/components/parameters/SnsPhoneNumber'
responses:
'204':
description: SMS message was discarded
get:
description: Retrieve SNS SMS messages
operationId: get_sns_sms_messages
tags: [aws]
parameters:
- $ref: '#/components/parameters/SnsAccountId'
- $ref: '#/components/parameters/SnsRegion'
- $ref: '#/components/parameters/SnsPhoneNumber'
responses:
'200':
content:
application/json:
schema:
$ref: "#/components/schemas/SNSSMSMessagesResponse"
description: SNS messages via retrospective access
/_aws/sns/subscription-tokens/{subscription_arn}:
get:
description: Retrieve SNS subscription token for confirmation
operationId: get_sns_subscription_token
tags: [aws]
parameters:
- description: '`subscriptionArn` resource of subscription token'
in: path
name: subscription_arn
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
subscription_arn:
type: string
subscription_token:
type: string
required:
- subscription_token
- subscription_arn
type: object
description: Subscription token
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/SnsSubscriptionTokenError'
description: Bad request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/SnsSubscriptionTokenError'
description: Not found
/_aws/sqs/messages:
get:
description: List SQS queue messages without side effects
operationId: list_all_sqs_messages
tags: [aws]
parameters:
- description: SQS queue URL
in: query
name: QueueUrl
required: false
schema:
type: string
responses:
'200':
content:
text/xml:
schema:
$ref: '#/components/schemas/ReceiveMessageResult'
application/json:
schema:
$ref: '#/components/schemas/ReceiveMessageResult'
description: SQS queue messages
'400':
content:
text/xml: {}
application/json: {}
description: Bad request
'404':
content:
text/xml: {}
application/json: {}
description: Not found
post:
summary: Retrieves one or more messages from the specified queue.
description: |
This API receives messages from an SQS queue.
https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html#API_ReceiveMessage_ResponseSyntax
operationId: receive_message
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ReceiveMessageRequest'
application/json:
schema:
$ref: '#/components/schemas/ReceiveMessageRequest'
responses:
'200':
content:
text/xml: {}
application/json:
schema:
$ref: '#/components/schemas/ReceiveMessageResult'
description: SQS queue messages
'400':
content:
text/xml: {}
application/json: {}
description: Bad request
'404':
content:
text/xml: {}
application/json: {}
description: Not found
/_aws/sqs/messages/{region}/{account_id}/{queue_name}:
get:
description: List SQS messages without side effects
operationId: list_sqs_messages
tags: [aws]
parameters:
- description: SQS queue region
in: path
name: region
required: true
schema:
type: string
- description: SQS queue account ID
in: path
name: account_id
required: true
schema:
type: string
- description: SQS queue name
in: path
name: queue_name
required: true
schema:
type: string
responses:
'200':
content:
text/xml: {}
application/json:
schema:
$ref: '#/components/schemas/ReceiveMessageResult'
description: SQS queue messages
'400':
content:
text/xml: {}
application/json: {}
description: Bad request
'404':
content:
text/xml: {}
application/json: {}
description: Not found
/_localstack/config:
get:
description: Get current LocalStack configuration
operationId: get_config
tags: [localstack]
responses:
'200':
content:
application/json:
schema:
type: object
description: Current LocalStack configuration
'404':
description: Not found
post:
description: Configuration option to update with new value
operationId: update_config_option
tags: [localstack]
requestBody:
content:
application/json:
schema:
additionalProperties: false
properties:
value:
type:
- number
- string
variable:
pattern: ^[_a-zA-Z0-9]+$
type: string
required:
- variable
- value
type: object
required: true
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
value:
type:
- number
- string
variable:
type: string
required:
- variable
- value
type: object
description: Configuration option is updated
'400':
content:
application/json: {}
description: Bad request
'404':
description: Not found
/_localstack/diagnose:
get:
description: Get diagnostics report
operationId: get_diagnostics
tags: [localstack]
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
config:
type: object
docker-dependent-image-hashes:
type: object
docker-dependent-image-hosts:
type: object
docker-inspect:
type: object
file-tree:
type: object
important-endpoints:
type: object
info:
$ref: '#/components/schemas/SessionInfo'
logs:
additionalProperties: false
properties:
docker:
type: string
required:
- docker
type: object
services:
type: object
usage:
type: object
version:
additionalProperties: false
properties:
host:
additionalProperties: false
properties:
kernel:
type: string
required:
- kernel
type: object
image-version:
additionalProperties: false
properties:
created:
type: string
id:
type: string
sha256:
type: string
tag:
type: string
required:
- id
- sha256
- tag
- created
type: object
localstack-version:
additionalProperties: false
properties:
build-date:
type:
- string
- 'null'
build-git-hash:
type:
- string
- 'null'
build-version:
type:
- string
- 'null'
required:
- build-date
- build-git-hash
- build-version
type: object
required:
- image-version
- localstack-version
- host
type: object
required:
- version
- info
- services
- config
- docker-inspect
- docker-dependent-image-hosts
- file-tree
- important-endpoints
- logs
- usage
type: object
description: Diagnostics report
/_localstack/health:
get:
description: Get available LocalStack features and AWS services
operationId: get_features_and_services
tags: [localstack]
parameters:
- allowEmptyValue: true
in: query
name: reload
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
edition:
enum:
- community
- pro
- enterprise
- unknown
type: string
features:
type: object
services:
type: object
version:
type: string
required:
- edition
- services
- version
type: object
description: Available LocalStack features and AWS services
head:
tags: [localstack]
operationId: health
responses:
'200':
content:
text/plain: {}
description: ''
post:
description: Restart or terminate LocalStack session
operationId: manage_session
tags: [localstack]
requestBody:
content:
application/json:
schema:
additionalProperties: false
properties:
action:
enum:
- restart
- kill
type: string
required:
- action
type: object
description: Action to perform
required: true
responses:
'200':
content:
text/plain: {}
description: Action was successful
'400':
content:
text/plain: {}
description: Bad request
put:
description: Store arbitrary data to in-memory state
operationId: store_data
tags: [localstack]
requestBody:
content:
application/json:
schema:
type: object
You can’t perform that action at this time.