aws-sdk 2.977.0 → 2.981.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.
- package/CHANGELOG.md +20 -1
- package/README.md +1 -1
- package/apis/cloudformation-2010-05-15.min.json +27 -1
- package/apis/ec2-2016-11-15.min.json +736 -728
- package/apis/elasticmapreduce-2009-03-31.min.json +84 -21
- package/apis/firehose-2015-08-04.min.json +104 -79
- package/apis/iot-2015-05-28.min.json +481 -232
- package/apis/iot-2015-05-28.paginators.json +12 -0
- package/apis/kms-2014-11-01.examples.json +100 -94
- package/apis/kms-2014-11-01.min.json +54 -34
- package/apis/mediatailor-2018-04-23.min.json +144 -116
- package/apis/s3-2006-03-01.examples.json +162 -162
- package/apis/servicecatalog-appregistry-2020-06-24.min.json +68 -0
- package/clients/cloudformation.d.ts +116 -80
- package/clients/cloudtrail.d.ts +72 -72
- package/clients/codebuild.d.ts +3 -3
- package/clients/computeoptimizer.d.ts +1 -1
- package/clients/configservice.d.ts +323 -323
- package/clients/ec2.d.ts +30 -13
- package/clients/emr.d.ts +78 -15
- package/clients/firehose.d.ts +39 -10
- package/clients/iot.d.ts +829 -506
- package/clients/kms.d.ts +293 -280
- package/clients/mediatailor.d.ts +45 -8
- package/clients/memorydb.d.ts +2 -2
- package/clients/polly.d.ts +2 -2
- package/clients/s3.d.ts +6 -6
- package/clients/servicecatalogappregistry.d.ts +81 -3
- package/clients/sqs.d.ts +4 -4
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +14 -16
- package/dist/aws-sdk.js +1501 -1098
- package/dist/aws-sdk.min.js +85 -85
- package/dist/xml2js.js +2 -3
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/mediatailor.d.ts
CHANGED
|
@@ -373,6 +373,10 @@ declare namespace MediaTailor {
|
|
|
373
373
|
* The timestamp of when the channel was created.
|
|
374
374
|
*/
|
|
375
375
|
CreationTime?: __timestampUnix;
|
|
376
|
+
/**
|
|
377
|
+
* Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.
|
|
378
|
+
*/
|
|
379
|
+
FillerSlate?: SlateSource;
|
|
376
380
|
/**
|
|
377
381
|
* The timestamp of when the channel was last modified.
|
|
378
382
|
*/
|
|
@@ -382,7 +386,7 @@ declare namespace MediaTailor {
|
|
|
382
386
|
*/
|
|
383
387
|
Outputs: ResponseOutputs;
|
|
384
388
|
/**
|
|
385
|
-
* The type of playback mode for this channel.
|
|
389
|
+
* The type of playback mode for this channel. LINEAR - Programs play back-to-back only once. LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
|
|
386
390
|
*/
|
|
387
391
|
PlaybackMode: __string;
|
|
388
392
|
/**
|
|
@@ -398,12 +402,16 @@ declare namespace MediaTailor {
|
|
|
398
402
|
* The identifier for the channel you are working on.
|
|
399
403
|
*/
|
|
400
404
|
ChannelName: __string;
|
|
405
|
+
/**
|
|
406
|
+
* The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses an LINEAR PlaybackMode.
|
|
407
|
+
*/
|
|
408
|
+
FillerSlate?: SlateSource;
|
|
401
409
|
/**
|
|
402
410
|
* The channel's output properties.
|
|
403
411
|
*/
|
|
404
412
|
Outputs: RequestOutputs;
|
|
405
413
|
/**
|
|
406
|
-
* The type of playback mode for this channel. The
|
|
414
|
+
* The type of playback mode to use for this channel. LINEAR - The programs in the schedule play once back-to-back in the schedule. LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
|
|
407
415
|
*/
|
|
408
416
|
PlaybackMode: PlaybackMode;
|
|
409
417
|
/**
|
|
@@ -428,6 +436,10 @@ declare namespace MediaTailor {
|
|
|
428
436
|
* The timestamp of when the channel was created.
|
|
429
437
|
*/
|
|
430
438
|
CreationTime?: __timestampUnix;
|
|
439
|
+
/**
|
|
440
|
+
* Contains information about the slate used to fill gaps between programs in the schedule.
|
|
441
|
+
*/
|
|
442
|
+
FillerSlate?: SlateSource;
|
|
431
443
|
/**
|
|
432
444
|
* The timestamp of when the channel was last modified.
|
|
433
445
|
*/
|
|
@@ -437,7 +449,7 @@ declare namespace MediaTailor {
|
|
|
437
449
|
*/
|
|
438
450
|
Outputs?: ResponseOutputs;
|
|
439
451
|
/**
|
|
440
|
-
* The
|
|
452
|
+
* The channel's playback mode.
|
|
441
453
|
*/
|
|
442
454
|
PlaybackMode?: __string;
|
|
443
455
|
/**
|
|
@@ -492,6 +504,10 @@ declare namespace MediaTailor {
|
|
|
492
504
|
* The name of the program.
|
|
493
505
|
*/
|
|
494
506
|
ProgramName?: __string;
|
|
507
|
+
/**
|
|
508
|
+
* The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
|
|
509
|
+
*/
|
|
510
|
+
ScheduledStartTime?: __timestampUnix;
|
|
495
511
|
/**
|
|
496
512
|
* The source location name.
|
|
497
513
|
*/
|
|
@@ -732,6 +748,10 @@ declare namespace MediaTailor {
|
|
|
732
748
|
* The timestamp of when the channel was created.
|
|
733
749
|
*/
|
|
734
750
|
CreationTime?: __timestampUnix;
|
|
751
|
+
/**
|
|
752
|
+
* Contains information about the slate used to fill gaps between programs in the schedule.
|
|
753
|
+
*/
|
|
754
|
+
FillerSlate?: SlateSource;
|
|
735
755
|
/**
|
|
736
756
|
* The timestamp of when the channel was last modified.
|
|
737
757
|
*/
|
|
@@ -741,7 +761,7 @@ declare namespace MediaTailor {
|
|
|
741
761
|
*/
|
|
742
762
|
Outputs?: ResponseOutputs;
|
|
743
763
|
/**
|
|
744
|
-
* The
|
|
764
|
+
* The channel's playback mode.
|
|
745
765
|
*/
|
|
746
766
|
PlaybackMode?: __string;
|
|
747
767
|
/**
|
|
@@ -780,6 +800,10 @@ declare namespace MediaTailor {
|
|
|
780
800
|
* The name of the program.
|
|
781
801
|
*/
|
|
782
802
|
ProgramName?: __string;
|
|
803
|
+
/**
|
|
804
|
+
* The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
|
|
805
|
+
*/
|
|
806
|
+
ScheduledStartTime?: __timestampUnix;
|
|
783
807
|
/**
|
|
784
808
|
* The source location name.
|
|
785
809
|
*/
|
|
@@ -1236,7 +1260,7 @@ declare namespace MediaTailor {
|
|
|
1236
1260
|
*/
|
|
1237
1261
|
VideoContentSourceUrl?: __string;
|
|
1238
1262
|
}
|
|
1239
|
-
export type PlaybackMode = "LOOP"|string;
|
|
1263
|
+
export type PlaybackMode = "LOOP"|"LINEAR"|string;
|
|
1240
1264
|
export interface PutChannelPolicyRequest {
|
|
1241
1265
|
/**
|
|
1242
1266
|
* The identifier for the channel you are working on.
|
|
@@ -1473,6 +1497,10 @@ declare namespace MediaTailor {
|
|
|
1473
1497
|
* The schedule's ad break properties.
|
|
1474
1498
|
*/
|
|
1475
1499
|
ScheduleAdBreaks?: __listOfScheduleAdBreak;
|
|
1500
|
+
/**
|
|
1501
|
+
* The type of schedule entry. Valid values: PROGRAM or FILLER_SLATE.
|
|
1502
|
+
*/
|
|
1503
|
+
ScheduleEntryType?: ScheduleEntryType;
|
|
1476
1504
|
/**
|
|
1477
1505
|
* The name of the source location.
|
|
1478
1506
|
*/
|
|
@@ -1482,6 +1510,7 @@ declare namespace MediaTailor {
|
|
|
1482
1510
|
*/
|
|
1483
1511
|
VodSourceName: __string;
|
|
1484
1512
|
}
|
|
1513
|
+
export type ScheduleEntryType = "PROGRAM"|"FILLER_SLATE"|string;
|
|
1485
1514
|
export interface SecretsManagerAccessTokenConfiguration {
|
|
1486
1515
|
/**
|
|
1487
1516
|
* The name of the HTTP header used to supply the access token in requests to the source location.
|
|
@@ -1586,7 +1615,7 @@ declare namespace MediaTailor {
|
|
|
1586
1615
|
}
|
|
1587
1616
|
export interface Transition {
|
|
1588
1617
|
/**
|
|
1589
|
-
* The position where this program will be inserted relative to the
|
|
1618
|
+
* The position where this program will be inserted relative to the RelativePosition.
|
|
1590
1619
|
*/
|
|
1591
1620
|
RelativePosition: RelativePosition;
|
|
1592
1621
|
/**
|
|
@@ -1594,7 +1623,11 @@ declare namespace MediaTailor {
|
|
|
1594
1623
|
*/
|
|
1595
1624
|
RelativeProgram?: __string;
|
|
1596
1625
|
/**
|
|
1597
|
-
*
|
|
1626
|
+
* The date and time that the program is scheduled to start, in epoch milliseconds.
|
|
1627
|
+
*/
|
|
1628
|
+
ScheduledStartTimeMillis?: __long;
|
|
1629
|
+
/**
|
|
1630
|
+
* Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE. ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode. Note the following considerations when using ABSOLUTE transitions: If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary. If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel. RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
|
|
1598
1631
|
*/
|
|
1599
1632
|
Type: __string;
|
|
1600
1633
|
}
|
|
@@ -1636,6 +1669,10 @@ declare namespace MediaTailor {
|
|
|
1636
1669
|
* The timestamp of when the channel was created.
|
|
1637
1670
|
*/
|
|
1638
1671
|
CreationTime?: __timestampUnix;
|
|
1672
|
+
/**
|
|
1673
|
+
* Contains information about the slate used to fill gaps between programs in the schedule.
|
|
1674
|
+
*/
|
|
1675
|
+
FillerSlate?: SlateSource;
|
|
1639
1676
|
/**
|
|
1640
1677
|
* The timestamp of when the channel was last modified.
|
|
1641
1678
|
*/
|
|
@@ -1645,7 +1682,7 @@ declare namespace MediaTailor {
|
|
|
1645
1682
|
*/
|
|
1646
1683
|
Outputs?: ResponseOutputs;
|
|
1647
1684
|
/**
|
|
1648
|
-
* The
|
|
1685
|
+
* The channel's playback mode.
|
|
1649
1686
|
*/
|
|
1650
1687
|
PlaybackMode?: __string;
|
|
1651
1688
|
/**
|
package/clients/memorydb.d.ts
CHANGED
|
@@ -636,11 +636,11 @@ declare namespace MemoryDB {
|
|
|
636
636
|
*/
|
|
637
637
|
Description?: String;
|
|
638
638
|
/**
|
|
639
|
-
* The number of shards the cluster will contain.
|
|
639
|
+
* The number of shards the cluster will contain. The default value is 1.
|
|
640
640
|
*/
|
|
641
641
|
NumShards?: IntegerOptional;
|
|
642
642
|
/**
|
|
643
|
-
* The number of replicas to apply to each shard. The
|
|
643
|
+
* The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
|
|
644
644
|
*/
|
|
645
645
|
NumReplicasPerShard?: IntegerOptional;
|
|
646
646
|
/**
|
package/clients/polly.d.ts
CHANGED
|
@@ -162,7 +162,7 @@ declare namespace Polly {
|
|
|
162
162
|
SynthesisTask?: SynthesisTask;
|
|
163
163
|
}
|
|
164
164
|
export type IncludeAdditionalLanguageCodes = boolean;
|
|
165
|
-
export type LanguageCode = "arb"|"cmn-CN"|"cy-GB"|"da-DK"|"de-DE"|"en-AU"|"en-GB"|"en-GB-WLS"|"en-IN"|"en-US"|"es-ES"|"es-MX"|"es-US"|"fr-CA"|"fr-FR"|"is-IS"|"it-IT"|"ja-JP"|"hi-IN"|"ko-KR"|"nb-NO"|"nl-NL"|"pl-PL"|"pt-BR"|"pt-PT"|"ro-RO"|"ru-RU"|"sv-SE"|"tr-TR"|"en-NZ"|string;
|
|
165
|
+
export type LanguageCode = "arb"|"cmn-CN"|"cy-GB"|"da-DK"|"de-DE"|"en-AU"|"en-GB"|"en-GB-WLS"|"en-IN"|"en-US"|"es-ES"|"es-MX"|"es-US"|"fr-CA"|"fr-FR"|"is-IS"|"it-IT"|"ja-JP"|"hi-IN"|"ko-KR"|"nb-NO"|"nl-NL"|"pl-PL"|"pt-BR"|"pt-PT"|"ro-RO"|"ru-RU"|"sv-SE"|"tr-TR"|"en-NZ"|"en-ZA"|string;
|
|
166
166
|
export type LanguageCodeList = LanguageCode[];
|
|
167
167
|
export type LanguageName = string;
|
|
168
168
|
export type LastModified = Date;
|
|
@@ -488,7 +488,7 @@ declare namespace Polly {
|
|
|
488
488
|
*/
|
|
489
489
|
SupportedEngines?: EngineList;
|
|
490
490
|
}
|
|
491
|
-
export type VoiceId = "Aditi"|"Amy"|"Astrid"|"Bianca"|"Brian"|"Camila"|"Carla"|"Carmen"|"Celine"|"Chantal"|"Conchita"|"Cristiano"|"Dora"|"Emma"|"Enrique"|"Ewa"|"Filiz"|"Gabrielle"|"Geraint"|"Giorgio"|"Gwyneth"|"Hans"|"Ines"|"Ivy"|"Jacek"|"Jan"|"Joanna"|"Joey"|"Justin"|"Karl"|"Kendra"|"Kevin"|"Kimberly"|"Lea"|"Liv"|"Lotte"|"Lucia"|"Lupe"|"Mads"|"Maja"|"Marlene"|"Mathieu"|"Matthew"|"Maxim"|"Mia"|"Miguel"|"Mizuki"|"Naja"|"Nicole"|"Olivia"|"Penelope"|"Raveena"|"Ricardo"|"Ruben"|"Russell"|"Salli"|"Seoyeon"|"Takumi"|"Tatyana"|"Vicki"|"Vitoria"|"Zeina"|"Zhiyu"|"Aria"|string;
|
|
491
|
+
export type VoiceId = "Aditi"|"Amy"|"Astrid"|"Bianca"|"Brian"|"Camila"|"Carla"|"Carmen"|"Celine"|"Chantal"|"Conchita"|"Cristiano"|"Dora"|"Emma"|"Enrique"|"Ewa"|"Filiz"|"Gabrielle"|"Geraint"|"Giorgio"|"Gwyneth"|"Hans"|"Ines"|"Ivy"|"Jacek"|"Jan"|"Joanna"|"Joey"|"Justin"|"Karl"|"Kendra"|"Kevin"|"Kimberly"|"Lea"|"Liv"|"Lotte"|"Lucia"|"Lupe"|"Mads"|"Maja"|"Marlene"|"Mathieu"|"Matthew"|"Maxim"|"Mia"|"Miguel"|"Mizuki"|"Naja"|"Nicole"|"Olivia"|"Penelope"|"Raveena"|"Ricardo"|"Ruben"|"Russell"|"Salli"|"Seoyeon"|"Takumi"|"Tatyana"|"Vicki"|"Vitoria"|"Zeina"|"Zhiyu"|"Aria"|"Ayanda"|string;
|
|
492
492
|
export type VoiceList = Voice[];
|
|
493
493
|
export type VoiceName = string;
|
|
494
494
|
/**
|
package/clients/s3.d.ts
CHANGED
|
@@ -370,11 +370,11 @@ declare class S3 extends S3Customizations {
|
|
|
370
370
|
*/
|
|
371
371
|
getBucketWebsite(callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
|
|
372
372
|
/**
|
|
373
|
-
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have permission to read object tags
|
|
373
|
+
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. You need the s3:GetObjectVersion permission to access a specific version of an object. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
|
|
374
374
|
*/
|
|
375
375
|
getObject(params: S3.Types.GetObjectRequest, callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
|
|
376
376
|
/**
|
|
377
|
-
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have permission to read object tags
|
|
377
|
+
* Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource. You need the s3:GetObjectVersion permission to access a specific version of an object. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
|
|
378
378
|
*/
|
|
379
379
|
getObject(callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
|
|
380
380
|
/**
|
|
@@ -442,11 +442,11 @@ declare class S3 extends S3Customizations {
|
|
|
442
442
|
*/
|
|
443
443
|
headBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
444
444
|
/**
|
|
445
|
-
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the
|
|
445
|
+
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following action is related to HeadObject: GetObject
|
|
446
446
|
*/
|
|
447
447
|
headObject(params: S3.Types.HeadObjectRequest, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
|
|
448
448
|
/**
|
|
449
|
-
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the
|
|
449
|
+
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. The last modified property in this case is the creation date of the object. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following action is related to HeadObject: GetObject
|
|
450
450
|
*/
|
|
451
451
|
headObject(callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
|
|
452
452
|
/**
|
|
@@ -1867,7 +1867,7 @@ declare namespace S3 {
|
|
|
1867
1867
|
VersionId?: ObjectVersionId;
|
|
1868
1868
|
RequestPayer?: RequestPayer;
|
|
1869
1869
|
/**
|
|
1870
|
-
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
|
|
1870
|
+
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.
|
|
1871
1871
|
*/
|
|
1872
1872
|
BypassGovernanceRetention?: BypassGovernanceRetention;
|
|
1873
1873
|
/**
|
|
@@ -1925,7 +1925,7 @@ declare namespace S3 {
|
|
|
1925
1925
|
MFA?: MFA;
|
|
1926
1926
|
RequestPayer?: RequestPayer;
|
|
1927
1927
|
/**
|
|
1928
|
-
* Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
|
|
1928
|
+
* Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.
|
|
1929
1929
|
*/
|
|
1930
1930
|
BypassGovernanceRetention?: BypassGovernanceRetention;
|
|
1931
1931
|
/**
|
|
@@ -83,6 +83,14 @@ declare class ServiceCatalogAppRegistry extends Service {
|
|
|
83
83
|
* Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.
|
|
84
84
|
*/
|
|
85
85
|
getApplication(callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.GetApplicationResponse) => void): Request<ServiceCatalogAppRegistry.Types.GetApplicationResponse, AWSError>;
|
|
86
|
+
/**
|
|
87
|
+
* Gets the resource associated with the application.
|
|
88
|
+
*/
|
|
89
|
+
getAssociatedResource(params: ServiceCatalogAppRegistry.Types.GetAssociatedResourceRequest, callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.GetAssociatedResourceResponse) => void): Request<ServiceCatalogAppRegistry.Types.GetAssociatedResourceResponse, AWSError>;
|
|
90
|
+
/**
|
|
91
|
+
* Gets the resource associated with the application.
|
|
92
|
+
*/
|
|
93
|
+
getAssociatedResource(callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.GetAssociatedResourceResponse) => void): Request<ServiceCatalogAppRegistry.Types.GetAssociatedResourceResponse, AWSError>;
|
|
86
94
|
/**
|
|
87
95
|
* Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.
|
|
88
96
|
*/
|
|
@@ -132,11 +140,11 @@ declare class ServiceCatalogAppRegistry extends Service {
|
|
|
132
140
|
*/
|
|
133
141
|
listTagsForResource(callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.ListTagsForResourceResponse) => void): Request<ServiceCatalogAppRegistry.Types.ListTagsForResourceResponse, AWSError>;
|
|
134
142
|
/**
|
|
135
|
-
* Syncs the resource with
|
|
143
|
+
* Syncs the resource with current AppRegistry records. Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
|
|
136
144
|
*/
|
|
137
145
|
syncResource(params: ServiceCatalogAppRegistry.Types.SyncResourceRequest, callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.SyncResourceResponse) => void): Request<ServiceCatalogAppRegistry.Types.SyncResourceResponse, AWSError>;
|
|
138
146
|
/**
|
|
139
|
-
* Syncs the resource with
|
|
147
|
+
* Syncs the resource with current AppRegistry records. Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
|
|
140
148
|
*/
|
|
141
149
|
syncResource(callback?: (err: AWSError, data: ServiceCatalogAppRegistry.Types.SyncResourceResponse) => void): Request<ServiceCatalogAppRegistry.Types.SyncResourceResponse, AWSError>;
|
|
142
150
|
/**
|
|
@@ -502,6 +510,30 @@ declare namespace ServiceCatalogAppRegistry {
|
|
|
502
510
|
* Key-value pairs associated with the application.
|
|
503
511
|
*/
|
|
504
512
|
tags?: Tags;
|
|
513
|
+
/**
|
|
514
|
+
* The information about the integration of the application with other services, such as Resource Groups.
|
|
515
|
+
*/
|
|
516
|
+
integrations?: Integrations;
|
|
517
|
+
}
|
|
518
|
+
export interface GetAssociatedResourceRequest {
|
|
519
|
+
/**
|
|
520
|
+
* The name or ID of the application.
|
|
521
|
+
*/
|
|
522
|
+
application: ApplicationSpecifier;
|
|
523
|
+
/**
|
|
524
|
+
* The type of resource associated with the application.
|
|
525
|
+
*/
|
|
526
|
+
resourceType: ResourceType;
|
|
527
|
+
/**
|
|
528
|
+
* The name or ID of the resource associated with the application.
|
|
529
|
+
*/
|
|
530
|
+
resource: ResourceSpecifier;
|
|
531
|
+
}
|
|
532
|
+
export interface GetAssociatedResourceResponse {
|
|
533
|
+
/**
|
|
534
|
+
* The resource associated with the application.
|
|
535
|
+
*/
|
|
536
|
+
resource?: Resource;
|
|
505
537
|
}
|
|
506
538
|
export interface GetAttributeGroupRequest {
|
|
507
539
|
/**
|
|
@@ -543,6 +575,12 @@ declare namespace ServiceCatalogAppRegistry {
|
|
|
543
575
|
*/
|
|
544
576
|
tags?: Tags;
|
|
545
577
|
}
|
|
578
|
+
export interface Integrations {
|
|
579
|
+
/**
|
|
580
|
+
* The information about the resource group integration.
|
|
581
|
+
*/
|
|
582
|
+
resourceGroup?: ResourceGroup;
|
|
583
|
+
}
|
|
546
584
|
export interface ListApplicationsRequest {
|
|
547
585
|
/**
|
|
548
586
|
* The token to use to get the next page of results after a previous API call.
|
|
@@ -646,6 +684,39 @@ declare namespace ServiceCatalogAppRegistry {
|
|
|
646
684
|
export type MaxResults = number;
|
|
647
685
|
export type Name = string;
|
|
648
686
|
export type NextToken = string;
|
|
687
|
+
export interface Resource {
|
|
688
|
+
/**
|
|
689
|
+
* The name of the resource.
|
|
690
|
+
*/
|
|
691
|
+
name?: ResourceSpecifier;
|
|
692
|
+
/**
|
|
693
|
+
* The Amazon resource name (ARN) of the resource.
|
|
694
|
+
*/
|
|
695
|
+
arn?: StackArn;
|
|
696
|
+
/**
|
|
697
|
+
* The time the resource was associated with the application.
|
|
698
|
+
*/
|
|
699
|
+
associationTime?: Timestamp;
|
|
700
|
+
/**
|
|
701
|
+
* The service integration information about the resource.
|
|
702
|
+
*/
|
|
703
|
+
integrations?: ResourceIntegrations;
|
|
704
|
+
}
|
|
705
|
+
export interface ResourceGroup {
|
|
706
|
+
/**
|
|
707
|
+
* The state of the propagation process for the resource group. The states includes: CREATING if the resource group is in the process of being created. CREATE_COMPLETE if the resource group was created successfully. CREATE_FAILED if the resource group failed to be created. UPDATING if the resource group is in the process of being updated. UPDATE_COMPLETE if the resource group updated successfully. UPDATE_FAILED if the resource group could not update successfully.
|
|
708
|
+
*/
|
|
709
|
+
state?: ResourceGroupState;
|
|
710
|
+
/**
|
|
711
|
+
* The Amazon resource name (ARN) of the resource group.
|
|
712
|
+
*/
|
|
713
|
+
arn?: Arn;
|
|
714
|
+
/**
|
|
715
|
+
* The error message that generates when the propagation process for the resource group fails.
|
|
716
|
+
*/
|
|
717
|
+
errorMessage?: String;
|
|
718
|
+
}
|
|
719
|
+
export type ResourceGroupState = "CREATING"|"CREATE_COMPLETE"|"CREATE_FAILED"|"UPDATING"|"UPDATE_COMPLETE"|"UPDATE_FAILED"|string;
|
|
649
720
|
export interface ResourceInfo {
|
|
650
721
|
/**
|
|
651
722
|
* The name of the resource.
|
|
@@ -656,10 +727,17 @@ declare namespace ServiceCatalogAppRegistry {
|
|
|
656
727
|
*/
|
|
657
728
|
arn?: StackArn;
|
|
658
729
|
}
|
|
730
|
+
export interface ResourceIntegrations {
|
|
731
|
+
/**
|
|
732
|
+
* The information about the integration of Resource Groups.
|
|
733
|
+
*/
|
|
734
|
+
resourceGroup?: ResourceGroup;
|
|
735
|
+
}
|
|
659
736
|
export type ResourceSpecifier = string;
|
|
660
737
|
export type ResourceType = "CFN_STACK"|string;
|
|
661
738
|
export type Resources = ResourceInfo[];
|
|
662
739
|
export type StackArn = string;
|
|
740
|
+
export type String = string;
|
|
663
741
|
export type SyncAction = "START_SYNC"|"NO_ACTION"|string;
|
|
664
742
|
export interface SyncResourceRequest {
|
|
665
743
|
/**
|
|
@@ -667,7 +745,7 @@ declare namespace ServiceCatalogAppRegistry {
|
|
|
667
745
|
*/
|
|
668
746
|
resourceType: ResourceType;
|
|
669
747
|
/**
|
|
670
|
-
* An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an
|
|
748
|
+
* An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.
|
|
671
749
|
*/
|
|
672
750
|
resource: ResourceSpecifier;
|
|
673
751
|
}
|
package/clients/sqs.d.ts
CHANGED
|
@@ -279,7 +279,7 @@ declare namespace SQS {
|
|
|
279
279
|
*/
|
|
280
280
|
QueueName: String;
|
|
281
281
|
/**
|
|
282
|
-
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
|
282
|
+
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. The following attributes apply only to dead-letter queues: RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. denyAll – No source queues can specify this queue as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue. sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly. For more information, see FIFO queue logic in the Amazon SQS Developer Guide. ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following: Every message must have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
|
|
283
283
|
*/
|
|
284
284
|
Attributes?: QueueAttributeMap;
|
|
285
285
|
/**
|
|
@@ -353,7 +353,7 @@ declare namespace SQS {
|
|
|
353
353
|
*/
|
|
354
354
|
QueueUrl: String;
|
|
355
355
|
/**
|
|
356
|
-
* A list of attributes for which to retrieve information. The AttributeName.N parameter is optional, but if you don't specify values for this parameter, the request returns empty results. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. All – Returns all values. ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue. ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time). DelaySeconds – Returns the default delay on the queue in seconds. LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time). MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message. Policy – Returns the policy of the queue. QueueArn – Returns the Amazon resource name (ARN) of the queue. ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
|
|
356
|
+
* A list of attributes for which to retrieve information. The AttributeName.N parameter is optional, but if you don't specify values for this parameter, the request returns empty results. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. All – Returns all values. ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue. ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time). DelaySeconds – Returns the default delay on the queue in seconds. LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time). MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message. Policy – Returns the policy of the queue. QueueArn – Returns the Amazon resource name (ARN) of the queue. ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive. VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. The following attributes apply only to dead-letter queues: RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. denyAll – No source queues can specify this queue as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue. sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
|
|
357
357
|
*/
|
|
358
358
|
AttributeNames?: AttributeNameList;
|
|
359
359
|
}
|
|
@@ -529,7 +529,7 @@ declare namespace SQS {
|
|
|
529
529
|
QueueUrl: String;
|
|
530
530
|
}
|
|
531
531
|
export type QueueAttributeMap = {[key: string]: String};
|
|
532
|
-
export type QueueAttributeName = "All"|"Policy"|"VisibilityTimeout"|"MaximumMessageSize"|"MessageRetentionPeriod"|"ApproximateNumberOfMessages"|"ApproximateNumberOfMessagesNotVisible"|"CreatedTimestamp"|"LastModifiedTimestamp"|"QueueArn"|"ApproximateNumberOfMessagesDelayed"|"DelaySeconds"|"ReceiveMessageWaitTimeSeconds"|"RedrivePolicy"|"FifoQueue"|"ContentBasedDeduplication"|"KmsMasterKeyId"|"KmsDataKeyReusePeriodSeconds"|"DeduplicationScope"|"FifoThroughputLimit"|string;
|
|
532
|
+
export type QueueAttributeName = "All"|"Policy"|"VisibilityTimeout"|"MaximumMessageSize"|"MessageRetentionPeriod"|"ApproximateNumberOfMessages"|"ApproximateNumberOfMessagesNotVisible"|"CreatedTimestamp"|"LastModifiedTimestamp"|"QueueArn"|"ApproximateNumberOfMessagesDelayed"|"DelaySeconds"|"ReceiveMessageWaitTimeSeconds"|"RedrivePolicy"|"FifoQueue"|"ContentBasedDeduplication"|"KmsMasterKeyId"|"KmsDataKeyReusePeriodSeconds"|"DeduplicationScope"|"FifoThroughputLimit"|"RedriveAllowPolicy"|string;
|
|
533
533
|
export type QueueUrlList = String[];
|
|
534
534
|
export interface ReceiveMessageRequest {
|
|
535
535
|
/**
|
|
@@ -713,7 +713,7 @@ declare namespace SQS {
|
|
|
713
713
|
*/
|
|
714
714
|
QueueUrl: String;
|
|
715
715
|
/**
|
|
716
|
-
* A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
|
716
|
+
* A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide. The following attributes apply only to dead-letter queues: RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: redrivePermission – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. denyAll – No source queues can specify this queue as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue. sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attribute applies only to FIFO (first-in-first-out) queues: ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following: Every message must have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.
|
|
717
717
|
*/
|
|
718
718
|
Attributes: QueueAttributeMap;
|
|
719
719
|
}
|