@jjrawlins/cdk-ami-builder 0.0.173 → 0.0.175
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/.jsii +11 -11
- package/cdkamibuilder/jsii/jsii.go +2 -2
- package/cdkamibuilder/version +1 -1
- package/lib/ImagePipeline/ImagePipeline.js +1 -1
- package/lib/Lambdas/CheckStateMachineStatus/CheckStateMachineStatus-function.js +1 -1
- package/lib/Lambdas/StartStateMachine/StartStateMachine-function.js +1 -1
- package/node_modules/@aws/lambda-invoke-store/dist-cjs/invoke-store.js +2 -2
- package/node_modules/@aws/lambda-invoke-store/dist-es/invoke-store.js +2 -2
- package/node_modules/@aws/lambda-invoke-store/dist-types/invoke-store.d.ts +1 -1
- package/node_modules/@aws/lambda-invoke-store/package.json +1 -1
- package/node_modules/@aws-sdk/client-ec2/README.md +26 -46
- package/node_modules/@aws-sdk/client-ec2/package.json +36 -36
- package/node_modules/@aws-sdk/client-ecs/README.md +26 -46
- package/node_modules/@aws-sdk/client-ecs/package.json +34 -34
- package/node_modules/@aws-sdk/client-kms/README.md +26 -46
- package/node_modules/@aws-sdk/client-kms/package.json +33 -33
- package/node_modules/@aws-sdk/client-s3/README.md +26 -46
- package/node_modules/@aws-sdk/client-s3/dist-cjs/index.js +5 -0
- package/node_modules/@aws-sdk/client-s3/dist-cjs/schemas/schemas_0.js +6 -4
- package/node_modules/@aws-sdk/client-s3/dist-es/models/enums.js +4 -0
- package/node_modules/@aws-sdk/client-s3/dist-es/schemas/schemas_0.js +6 -4
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/CopyObjectCommand.d.ts +5 -4
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/CreateBucketCommand.d.ts +9 -0
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketTaggingCommand.d.ts +0 -1
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketTaggingCommand.d.ts +0 -1
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/HeadBucketCommand.d.ts +5 -4
- package/node_modules/@aws-sdk/client-s3/dist-types/commands/UploadPartCopyCommand.d.ts +5 -4
- package/node_modules/@aws-sdk/client-s3/dist-types/models/enums.d.ts +12 -0
- package/node_modules/@aws-sdk/client-s3/dist-types/models/models_0.d.ts +24 -2
- package/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/enums.d.ts +6 -0
- package/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/node_modules/@aws-sdk/client-s3/package.json +50 -50
- package/node_modules/@aws-sdk/client-secrets-manager/README.md +26 -46
- package/node_modules/@aws-sdk/client-secrets-manager/package.json +34 -34
- package/node_modules/@aws-sdk/client-sfn/README.md +26 -46
- package/node_modules/@aws-sdk/client-sfn/package.json +33 -33
- package/node_modules/@aws-sdk/client-sns/README.md +26 -46
- package/node_modules/@aws-sdk/client-sns/package.json +33 -33
- package/node_modules/@aws-sdk/client-sqs/README.md +65 -46
- package/node_modules/@aws-sdk/client-sqs/package.json +36 -36
- package/node_modules/@aws-sdk/client-ssm/README.md +26 -46
- package/node_modules/@aws-sdk/client-ssm/package.json +34 -34
- package/node_modules/@aws-sdk/core/package.json +11 -11
- package/node_modules/@aws-sdk/crc64-nvme/package.json +2 -2
- package/node_modules/@aws-sdk/credential-provider-env/package.json +5 -5
- package/node_modules/@aws-sdk/credential-provider-http/package.json +10 -10
- package/node_modules/@aws-sdk/credential-provider-ini/package.json +14 -14
- package/node_modules/@aws-sdk/credential-provider-login/package.json +8 -8
- package/node_modules/@aws-sdk/credential-provider-node/package.json +12 -12
- package/node_modules/@aws-sdk/credential-provider-process/package.json +6 -6
- package/node_modules/@aws-sdk/credential-provider-sso/package.json +8 -8
- package/node_modules/@aws-sdk/credential-provider-web-identity/package.json +7 -7
- package/node_modules/@aws-sdk/middleware-bucket-endpoint/package.json +5 -5
- package/node_modules/@aws-sdk/middleware-expect-continue/package.json +4 -4
- package/node_modules/@aws-sdk/middleware-flexible-checksums/package.json +10 -10
- package/node_modules/@aws-sdk/middleware-host-header/package.json +4 -4
- package/node_modules/@aws-sdk/middleware-location-constraint/package.json +3 -3
- package/node_modules/@aws-sdk/middleware-logger/package.json +3 -3
- package/node_modules/@aws-sdk/middleware-recursion-detection/package.json +4 -4
- package/node_modules/@aws-sdk/middleware-sdk-ec2/package.json +8 -8
- package/node_modules/@aws-sdk/middleware-sdk-s3/package.json +11 -11
- package/node_modules/@aws-sdk/middleware-sdk-sqs/package.json +4 -4
- package/node_modules/@aws-sdk/middleware-ssec/package.json +3 -3
- package/node_modules/@aws-sdk/middleware-user-agent/package.json +8 -8
- package/node_modules/@aws-sdk/nested-clients/package.json +32 -32
- package/node_modules/@aws-sdk/region-config-resolver/package.json +5 -5
- package/node_modules/@aws-sdk/signature-v4-multi-region/package.json +6 -6
- package/node_modules/@aws-sdk/token-providers/package.json +7 -7
- package/node_modules/@aws-sdk/types/package.json +2 -2
- package/node_modules/@aws-sdk/util-endpoints/package.json +5 -5
- package/node_modules/@aws-sdk/util-format-url/package.json +4 -4
- package/node_modules/@aws-sdk/util-user-agent-browser/package.json +3 -3
- package/node_modules/@aws-sdk/util-user-agent-node/dist-cjs/index.js +75 -19
- package/node_modules/@aws-sdk/util-user-agent-node/dist-es/getNodeModulesParentDirs.js +15 -0
- package/node_modules/@aws-sdk/util-user-agent-node/dist-es/getSanitizedDevTypeScriptVersion.js +14 -0
- package/node_modules/@aws-sdk/util-user-agent-node/dist-es/getTypeScriptUserAgentPair.js +53 -7
- package/node_modules/@aws-sdk/util-user-agent-node/dist-types/{getTypeScriptPackageJsonPaths.d.ts → getNodeModulesParentDirs.d.ts} +2 -2
- package/node_modules/@aws-sdk/util-user-agent-node/dist-types/getSanitizedDevTypeScriptVersion.d.ts +8 -0
- package/node_modules/@aws-sdk/util-user-agent-node/dist-types/ts3.4/getNodeModulesParentDirs.d.ts +1 -0
- package/node_modules/@aws-sdk/util-user-agent-node/dist-types/ts3.4/getSanitizedDevTypeScriptVersion.d.ts +3 -0
- package/node_modules/@aws-sdk/util-user-agent-node/package.json +6 -5
- package/node_modules/@aws-sdk/xml-builder/package.json +2 -2
- package/node_modules/@smithy/abort-controller/package.json +2 -2
- package/node_modules/@smithy/config-resolver/package.json +5 -5
- package/node_modules/@smithy/core/dist-cjs/index.js +1 -2
- package/node_modules/@smithy/core/dist-cjs/submodules/cbor/index.js +7 -1
- package/node_modules/@smithy/core/dist-cjs/submodules/endpoints/index.js +22 -0
- package/node_modules/@smithy/core/dist-cjs/submodules/protocols/index.js +11 -1
- package/node_modules/@smithy/core/dist-cjs/submodules/schema/index.js +41 -4
- package/node_modules/@smithy/core/dist-es/middleware-http-auth-scheme/getHttpAuthSchemePlugin.js +1 -2
- package/node_modules/@smithy/core/dist-es/submodules/cbor/parseCborBody.js +7 -1
- package/node_modules/@smithy/core/dist-es/submodules/endpoints/index.js +1 -0
- package/node_modules/@smithy/core/dist-es/submodules/endpoints/toEndpointV1.js +17 -0
- package/node_modules/@smithy/core/dist-es/submodules/protocols/HttpProtocol.js +10 -0
- package/node_modules/@smithy/core/dist-es/submodules/protocols/RpcProtocol.js +1 -1
- package/node_modules/@smithy/core/dist-es/submodules/schema/middleware/schemaSerializationMiddleware.js +3 -2
- package/node_modules/@smithy/core/dist-es/submodules/schema/schemas/NormalizedSchema.js +30 -1
- package/node_modules/@smithy/core/dist-es/submodules/schema/schemas/translateTraits.js +5 -1
- package/node_modules/@smithy/core/dist-types/submodules/endpoints/index.d.ts +1 -0
- package/node_modules/@smithy/core/dist-types/submodules/endpoints/toEndpointV1.d.ts +6 -0
- package/node_modules/@smithy/core/dist-types/submodules/schema/schemas/NormalizedSchema.d.ts +11 -0
- package/node_modules/@smithy/core/dist-types/submodules/schema/schemas/translateTraits.d.ts +6 -0
- package/node_modules/@smithy/core/dist-types/ts3.4/submodules/endpoints/index.d.ts +1 -0
- package/node_modules/@smithy/core/dist-types/ts3.4/submodules/endpoints/toEndpointV1.d.ts +6 -0
- package/node_modules/@smithy/core/dist-types/ts3.4/submodules/schema/schemas/NormalizedSchema.d.ts +11 -0
- package/node_modules/@smithy/core/dist-types/ts3.4/submodules/schema/schemas/translateTraits.d.ts +6 -0
- package/node_modules/@smithy/core/endpoints.d.ts +7 -0
- package/node_modules/@smithy/core/endpoints.js +6 -0
- package/node_modules/@smithy/core/package.json +16 -7
- package/node_modules/@smithy/credential-provider-imds/package.json +5 -5
- package/node_modules/@smithy/eventstream-codec/package.json +2 -2
- package/node_modules/@smithy/eventstream-serde-browser/package.json +3 -3
- package/node_modules/@smithy/eventstream-serde-config-resolver/package.json +2 -2
- package/node_modules/@smithy/eventstream-serde-node/package.json +3 -3
- package/node_modules/@smithy/eventstream-serde-universal/package.json +3 -3
- package/node_modules/@smithy/fetch-http-handler/dist-cjs/index.js +4 -1
- package/node_modules/@smithy/fetch-http-handler/dist-es/fetch-http-handler.js +4 -1
- package/node_modules/@smithy/fetch-http-handler/package.json +5 -5
- package/node_modules/@smithy/hash-blob-browser/package.json +2 -2
- package/node_modules/@smithy/hash-node/package.json +2 -2
- package/node_modules/@smithy/hash-stream-node/package.json +2 -2
- package/node_modules/@smithy/invalid-dependency/package.json +2 -2
- package/node_modules/@smithy/md5-js/package.json +2 -2
- package/node_modules/@smithy/middleware-content-length/package.json +3 -3
- package/node_modules/@smithy/middleware-endpoint/dist-cjs/index.js +17 -1
- package/node_modules/@smithy/middleware-endpoint/dist-es/adaptors/getEndpointFromInstructions.js +9 -0
- package/node_modules/@smithy/middleware-endpoint/dist-es/adaptors/toEndpointV1.js +8 -1
- package/node_modules/@smithy/middleware-endpoint/dist-types/adaptors/toEndpointV1.d.ts +1 -0
- package/node_modules/@smithy/middleware-endpoint/dist-types/ts3.4/adaptors/toEndpointV1.d.ts +1 -0
- package/node_modules/@smithy/middleware-endpoint/package.json +8 -8
- package/node_modules/@smithy/middleware-retry/dist-cjs/index.js +9 -12
- package/node_modules/@smithy/middleware-retry/dist-es/configurations.js +9 -12
- package/node_modules/@smithy/middleware-retry/package.json +8 -8
- package/node_modules/@smithy/middleware-serde/dist-cjs/index.js +3 -2
- package/node_modules/@smithy/middleware-serde/dist-es/serializerMiddleware.js +3 -2
- package/node_modules/@smithy/middleware-serde/package.json +4 -3
- package/node_modules/@smithy/middleware-stack/package.json +2 -2
- package/node_modules/@smithy/node-config-provider/package.json +4 -4
- package/node_modules/@smithy/node-http-handler/dist-cjs/index.js +4 -1
- package/node_modules/@smithy/node-http-handler/dist-es/build-abort-error.js +4 -1
- package/node_modules/@smithy/node-http-handler/dist-types/build-abort-error.d.ts +4 -3
- package/node_modules/@smithy/node-http-handler/dist-types/ts3.4/build-abort-error.d.ts +4 -3
- package/node_modules/@smithy/node-http-handler/package.json +5 -5
- package/node_modules/@smithy/property-provider/package.json +2 -2
- package/node_modules/@smithy/protocol-http/package.json +2 -2
- package/node_modules/@smithy/querystring-builder/package.json +2 -2
- package/node_modules/@smithy/querystring-parser/package.json +2 -2
- package/node_modules/@smithy/service-error-classification/package.json +2 -2
- package/node_modules/@smithy/shared-ini-file-loader/package.json +2 -2
- package/node_modules/@smithy/signature-v4/package.json +4 -4
- package/node_modules/@smithy/smithy-client/package.json +7 -7
- package/node_modules/@smithy/types/dist-types/http.d.ts +1 -0
- package/node_modules/@smithy/types/dist-types/ts3.4/http.d.ts +1 -0
- package/node_modules/@smithy/types/package.json +1 -1
- package/node_modules/@smithy/url-parser/package.json +3 -3
- package/node_modules/@smithy/util-defaults-mode-browser/package.json +4 -4
- package/node_modules/@smithy/util-defaults-mode-node/package.json +7 -7
- package/node_modules/@smithy/util-endpoints/package.json +3 -3
- package/node_modules/@smithy/util-middleware/package.json +2 -2
- package/node_modules/@smithy/util-retry/package.json +3 -3
- package/node_modules/@smithy/util-stream/package.json +4 -4
- package/node_modules/@smithy/util-waiter/package.json +3 -3
- package/node_modules/fast-xml-builder/CHANGELOG.md +2 -1
- package/node_modules/fast-xml-builder/lib/fxb.d.cts +3 -1
- package/node_modules/fast-xml-builder/package.json +1 -1
- package/node_modules/fast-xml-builder/src/fxb.d.ts +4 -1
- package/package.json +12 -12
- package/node_modules/@aws-sdk/util-user-agent-node/dist-es/getTypeScriptPackageJsonPaths.js +0 -17
- package/node_modules/@aws-sdk/util-user-agent-node/dist-types/ts3.4/getTypeScriptPackageJsonPaths.d.ts +0 -3
|
@@ -116,10 +116,11 @@ declare const UploadPartCopyCommand_base: {
|
|
|
116
116
|
* the <b>
|
|
117
117
|
* <code>s3express:CreateSession</code>
|
|
118
118
|
* </b> permission in
|
|
119
|
-
* the <code>Action</code> element of a policy to read the object.
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
119
|
+
* the <code>Action</code> element of a policy to read the object. If no session mode is specified,
|
|
120
|
+
* the session will be created with the maximum allowable privilege, attempting
|
|
121
|
+
* <code>ReadWrite</code> first, then <code>ReadOnly</code> if <code>ReadWrite</code> is not permitted.
|
|
122
|
+
* If you want to explicitly restrict the access to be read-only, you can set the <code>s3express:SessionMode</code>
|
|
123
|
+
* condition key to <code>ReadOnly</code> on the copy source bucket.</p>
|
|
123
124
|
* </li>
|
|
124
125
|
* <li>
|
|
125
126
|
* <p>If the copy destination is a directory bucket, you must have the <b>
|
|
@@ -226,6 +226,18 @@ export declare const BucketCannedACL: {
|
|
|
226
226
|
* @public
|
|
227
227
|
*/
|
|
228
228
|
export type BucketCannedACL = (typeof BucketCannedACL)[keyof typeof BucketCannedACL];
|
|
229
|
+
/**
|
|
230
|
+
* @public
|
|
231
|
+
* @enum
|
|
232
|
+
*/
|
|
233
|
+
export declare const BucketNamespace: {
|
|
234
|
+
readonly ACCOUNT_REGIONAL: "account-regional";
|
|
235
|
+
readonly GLOBAL: "global";
|
|
236
|
+
};
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
export type BucketNamespace = (typeof BucketNamespace)[keyof typeof BucketNamespace];
|
|
229
241
|
/**
|
|
230
242
|
* @public
|
|
231
243
|
* @enum
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { StreamingBlobTypes } from "@smithy/types";
|
|
2
|
-
import { AnalyticsS3ExportFileFormat, ArchiveStatus, BucketAbacStatus, BucketAccelerateStatus, BucketCannedACL, BucketLocationConstraint, BucketLogsPermission, BucketType, BucketVersioningStatus, ChecksumAlgorithm, ChecksumMode, ChecksumType, DataRedundancy, DeleteMarkerReplicationStatus, EncodingType, EncryptionType, Event, ExistingObjectReplicationStatus, ExpirationState, ExpirationStatus, FileHeaderInfo, FilterRuleName, IntelligentTieringAccessTier, IntelligentTieringStatus, InventoryConfigurationState, InventoryFormat, InventoryFrequency, InventoryIncludedObjectVersions, InventoryOptionalField, JSONType, LocationType, MetadataDirective, MetricsStatus, MFADelete, MFADeleteStatus, ObjectAttributes, ObjectCannedACL, ObjectLockEnabled, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetentionMode, ObjectOwnership, ObjectStorageClass, ObjectVersionStorageClass, OptionalObjectAttributes, OwnerOverride, PartitionDateSource, Payer, Permission, Protocol, ReplicaModificationsStatus, ReplicationRuleStatus, ReplicationStatus, ReplicationTimeStatus, RequestCharged, RequestPayer, S3TablesBucketType, ServerSideEncryption, SessionMode, SseKmsEncryptedObjectsStatus, StorageClass, StorageClassAnalysisSchemaVersion, TableSseAlgorithm, TaggingDirective, Tier, TransitionDefaultMinimumObjectSize, TransitionStorageClass, Type } from "./enums";
|
|
2
|
+
import { AnalyticsS3ExportFileFormat, ArchiveStatus, BucketAbacStatus, BucketAccelerateStatus, BucketCannedACL, BucketLocationConstraint, BucketLogsPermission, BucketNamespace, BucketType, BucketVersioningStatus, ChecksumAlgorithm, ChecksumMode, ChecksumType, DataRedundancy, DeleteMarkerReplicationStatus, EncodingType, EncryptionType, Event, ExistingObjectReplicationStatus, ExpirationState, ExpirationStatus, FileHeaderInfo, FilterRuleName, IntelligentTieringAccessTier, IntelligentTieringStatus, InventoryConfigurationState, InventoryFormat, InventoryFrequency, InventoryIncludedObjectVersions, InventoryOptionalField, JSONType, LocationType, MetadataDirective, MetricsStatus, MFADelete, MFADeleteStatus, ObjectAttributes, ObjectCannedACL, ObjectLockEnabled, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetentionMode, ObjectOwnership, ObjectStorageClass, ObjectVersionStorageClass, OptionalObjectAttributes, OwnerOverride, PartitionDateSource, Payer, Permission, Protocol, ReplicaModificationsStatus, ReplicationRuleStatus, ReplicationStatus, ReplicationTimeStatus, RequestCharged, RequestPayer, S3TablesBucketType, ServerSideEncryption, SessionMode, SseKmsEncryptedObjectsStatus, StorageClass, StorageClassAnalysisSchemaVersion, TableSseAlgorithm, TaggingDirective, Tier, TransitionDefaultMinimumObjectSize, TransitionStorageClass, Type } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* <p>The ABAC status of the general purpose bucket. When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html">Using tags with S3 general purpose buckets</a>. </p>
|
|
5
5
|
* @public
|
|
@@ -1718,6 +1718,25 @@ export interface CreateBucketRequest {
|
|
|
1718
1718
|
* @public
|
|
1719
1719
|
*/
|
|
1720
1720
|
ObjectOwnership?: ObjectOwnership | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* <p>Specifies the namespace where you want to create your general purpose bucket. When you create a
|
|
1723
|
+
* general purpose bucket, you can choose to create a bucket in the shared global namespace or you can choose to
|
|
1724
|
+
* create a bucket in your account regional namespace. Your account regional namespace is a subdivision of
|
|
1725
|
+
* the global namespace that only your account can create buckets in. For more information on bucket
|
|
1726
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/gpbucketnamespaces.html">Namespaces for general purpose buckets</a>.</p>
|
|
1727
|
+
* <p>General purpose buckets in your account regional namespace must follow a specific naming convention. These
|
|
1728
|
+
* buckets consist of a bucket name prefix that you create, and a suffix that contains your 12-digit Amazon Web Services
|
|
1729
|
+
* Account ID, the Amazon Web Services Region code, and ends with <code>-an</code>. Bucket names must follow the format
|
|
1730
|
+
* <code>bucket-name-prefix-accountId-region-an</code> (for example,
|
|
1731
|
+
* <code>amzn-s3-demo-bucket-111122223333-us-west-2-an</code>). For information about bucket naming
|
|
1732
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html#account-regional-naming-rules">Account regional namespace naming rules</a>
|
|
1733
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
1734
|
+
* <note>
|
|
1735
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1736
|
+
* </note>
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
BucketNamespace?: BucketNamespace | undefined;
|
|
1721
1740
|
}
|
|
1722
1741
|
/**
|
|
1723
1742
|
* <p>
|
|
@@ -2742,7 +2761,10 @@ export interface CreateSessionOutput {
|
|
|
2742
2761
|
export interface CreateSessionRequest {
|
|
2743
2762
|
/**
|
|
2744
2763
|
* <p>Specifies the mode of the session that will be created, either <code>ReadWrite</code> or
|
|
2745
|
-
* <code>ReadOnly</code>.
|
|
2764
|
+
* <code>ReadOnly</code>. If no session mode is specified, the default behavior attempts to create
|
|
2765
|
+
* a session with the maximum allowable privilege. It will first attempt to create a
|
|
2766
|
+
* <code>ReadWrite</code> session, and if that is not allowed by permissions, it will attempt to create a
|
|
2767
|
+
* <code>ReadOnly</code> session. If neither session type is allowed, the request will return an Access Denied error. A
|
|
2746
2768
|
* <code>ReadWrite</code> session is capable of executing all the Zonal endpoint API operations on a directory bucket. A
|
|
2747
2769
|
* <code>ReadOnly</code> session is constrained to execute the following Zonal endpoint API operations:
|
|
2748
2770
|
* <code>GetObject</code>, <code>HeadObject</code>, <code>ListObjectsV2</code>,
|
|
@@ -118,6 +118,12 @@ export declare const BucketCannedACL: {
|
|
|
118
118
|
};
|
|
119
119
|
export type BucketCannedACL =
|
|
120
120
|
(typeof BucketCannedACL)[keyof typeof BucketCannedACL];
|
|
121
|
+
export declare const BucketNamespace: {
|
|
122
|
+
readonly ACCOUNT_REGIONAL: "account-regional";
|
|
123
|
+
readonly GLOBAL: "global";
|
|
124
|
+
};
|
|
125
|
+
export type BucketNamespace =
|
|
126
|
+
(typeof BucketNamespace)[keyof typeof BucketNamespace];
|
|
121
127
|
export declare const DataRedundancy: {
|
|
122
128
|
readonly SingleAvailabilityZone: "SingleAvailabilityZone";
|
|
123
129
|
readonly SingleLocalZone: "SingleLocalZone";
|
|
@@ -7,6 +7,7 @@ import {
|
|
|
7
7
|
BucketCannedACL,
|
|
8
8
|
BucketLocationConstraint,
|
|
9
9
|
BucketLogsPermission,
|
|
10
|
+
BucketNamespace,
|
|
10
11
|
BucketType,
|
|
11
12
|
BucketVersioningStatus,
|
|
12
13
|
ChecksumAlgorithm,
|
|
@@ -262,6 +263,7 @@ export interface CreateBucketRequest {
|
|
|
262
263
|
GrantWriteACP?: string | undefined;
|
|
263
264
|
ObjectLockEnabledForBucket?: boolean | undefined;
|
|
264
265
|
ObjectOwnership?: ObjectOwnership | undefined;
|
|
266
|
+
BucketNamespace?: BucketNamespace | undefined;
|
|
265
267
|
}
|
|
266
268
|
export interface MetadataTableEncryptionConfiguration {
|
|
267
269
|
SseAlgorithm: TableSseAlgorithm | undefined;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-s3",
|
|
3
3
|
"description": "AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1009.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-s3",
|
|
@@ -30,62 +30,62 @@
|
|
|
30
30
|
"@aws-crypto/sha1-browser": "5.2.0",
|
|
31
31
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
32
32
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
33
|
-
"@aws-sdk/core": "^3.973.
|
|
34
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
35
|
-
"@aws-sdk/middleware-bucket-endpoint": "^3.972.
|
|
36
|
-
"@aws-sdk/middleware-expect-continue": "^3.972.
|
|
37
|
-
"@aws-sdk/middleware-flexible-checksums": "^3.973.
|
|
38
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
39
|
-
"@aws-sdk/middleware-location-constraint": "^3.972.
|
|
40
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
41
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
42
|
-
"@aws-sdk/middleware-sdk-s3": "^3.972.
|
|
43
|
-
"@aws-sdk/middleware-ssec": "^3.972.
|
|
44
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
45
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
46
|
-
"@aws-sdk/signature-v4-multi-region": "^3.996.
|
|
47
|
-
"@aws-sdk/types": "^3.973.
|
|
48
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
49
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
50
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
51
|
-
"@smithy/config-resolver": "^4.4.
|
|
52
|
-
"@smithy/core": "^3.23.
|
|
53
|
-
"@smithy/eventstream-serde-browser": "^4.2.
|
|
54
|
-
"@smithy/eventstream-serde-config-resolver": "^4.3.
|
|
55
|
-
"@smithy/eventstream-serde-node": "^4.2.
|
|
56
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
57
|
-
"@smithy/hash-blob-browser": "^4.2.
|
|
58
|
-
"@smithy/hash-node": "^4.2.
|
|
59
|
-
"@smithy/hash-stream-node": "^4.2.
|
|
60
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
61
|
-
"@smithy/md5-js": "^4.2.
|
|
62
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
63
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
64
|
-
"@smithy/middleware-retry": "^4.4.
|
|
65
|
-
"@smithy/middleware-serde": "^4.2.
|
|
66
|
-
"@smithy/middleware-stack": "^4.2.
|
|
67
|
-
"@smithy/node-config-provider": "^4.3.
|
|
68
|
-
"@smithy/node-http-handler": "^4.4.
|
|
69
|
-
"@smithy/protocol-http": "^5.3.
|
|
70
|
-
"@smithy/smithy-client": "^4.12.
|
|
71
|
-
"@smithy/types": "^4.13.
|
|
72
|
-
"@smithy/url-parser": "^4.2.
|
|
33
|
+
"@aws-sdk/core": "^3.973.20",
|
|
34
|
+
"@aws-sdk/credential-provider-node": "^3.972.21",
|
|
35
|
+
"@aws-sdk/middleware-bucket-endpoint": "^3.972.8",
|
|
36
|
+
"@aws-sdk/middleware-expect-continue": "^3.972.8",
|
|
37
|
+
"@aws-sdk/middleware-flexible-checksums": "^3.973.6",
|
|
38
|
+
"@aws-sdk/middleware-host-header": "^3.972.8",
|
|
39
|
+
"@aws-sdk/middleware-location-constraint": "^3.972.8",
|
|
40
|
+
"@aws-sdk/middleware-logger": "^3.972.8",
|
|
41
|
+
"@aws-sdk/middleware-recursion-detection": "^3.972.8",
|
|
42
|
+
"@aws-sdk/middleware-sdk-s3": "^3.972.20",
|
|
43
|
+
"@aws-sdk/middleware-ssec": "^3.972.8",
|
|
44
|
+
"@aws-sdk/middleware-user-agent": "^3.972.21",
|
|
45
|
+
"@aws-sdk/region-config-resolver": "^3.972.8",
|
|
46
|
+
"@aws-sdk/signature-v4-multi-region": "^3.996.8",
|
|
47
|
+
"@aws-sdk/types": "^3.973.6",
|
|
48
|
+
"@aws-sdk/util-endpoints": "^3.996.5",
|
|
49
|
+
"@aws-sdk/util-user-agent-browser": "^3.972.8",
|
|
50
|
+
"@aws-sdk/util-user-agent-node": "^3.973.7",
|
|
51
|
+
"@smithy/config-resolver": "^4.4.11",
|
|
52
|
+
"@smithy/core": "^3.23.11",
|
|
53
|
+
"@smithy/eventstream-serde-browser": "^4.2.12",
|
|
54
|
+
"@smithy/eventstream-serde-config-resolver": "^4.3.12",
|
|
55
|
+
"@smithy/eventstream-serde-node": "^4.2.12",
|
|
56
|
+
"@smithy/fetch-http-handler": "^5.3.15",
|
|
57
|
+
"@smithy/hash-blob-browser": "^4.2.13",
|
|
58
|
+
"@smithy/hash-node": "^4.2.12",
|
|
59
|
+
"@smithy/hash-stream-node": "^4.2.12",
|
|
60
|
+
"@smithy/invalid-dependency": "^4.2.12",
|
|
61
|
+
"@smithy/md5-js": "^4.2.12",
|
|
62
|
+
"@smithy/middleware-content-length": "^4.2.12",
|
|
63
|
+
"@smithy/middleware-endpoint": "^4.4.25",
|
|
64
|
+
"@smithy/middleware-retry": "^4.4.42",
|
|
65
|
+
"@smithy/middleware-serde": "^4.2.14",
|
|
66
|
+
"@smithy/middleware-stack": "^4.2.12",
|
|
67
|
+
"@smithy/node-config-provider": "^4.3.12",
|
|
68
|
+
"@smithy/node-http-handler": "^4.4.16",
|
|
69
|
+
"@smithy/protocol-http": "^5.3.12",
|
|
70
|
+
"@smithy/smithy-client": "^4.12.5",
|
|
71
|
+
"@smithy/types": "^4.13.1",
|
|
72
|
+
"@smithy/url-parser": "^4.2.12",
|
|
73
73
|
"@smithy/util-base64": "^4.3.2",
|
|
74
74
|
"@smithy/util-body-length-browser": "^4.2.2",
|
|
75
75
|
"@smithy/util-body-length-node": "^4.2.3",
|
|
76
|
-
"@smithy/util-defaults-mode-browser": "^4.3.
|
|
77
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
78
|
-
"@smithy/util-endpoints": "^3.3.
|
|
79
|
-
"@smithy/util-middleware": "^4.2.
|
|
80
|
-
"@smithy/util-retry": "^4.2.
|
|
81
|
-
"@smithy/util-stream": "^4.5.
|
|
76
|
+
"@smithy/util-defaults-mode-browser": "^4.3.41",
|
|
77
|
+
"@smithy/util-defaults-mode-node": "^4.2.44",
|
|
78
|
+
"@smithy/util-endpoints": "^3.3.3",
|
|
79
|
+
"@smithy/util-middleware": "^4.2.12",
|
|
80
|
+
"@smithy/util-retry": "^4.2.12",
|
|
81
|
+
"@smithy/util-stream": "^4.5.19",
|
|
82
82
|
"@smithy/util-utf8": "^4.2.2",
|
|
83
|
-
"@smithy/util-waiter": "^4.2.
|
|
83
|
+
"@smithy/util-waiter": "^4.2.13",
|
|
84
84
|
"tslib": "^2.6.2"
|
|
85
85
|
},
|
|
86
86
|
"devDependencies": {
|
|
87
|
-
"@aws-sdk/signature-v4-crt": "3.
|
|
88
|
-
"@smithy/snapshot-testing": "^2.0.
|
|
87
|
+
"@aws-sdk/signature-v4-crt": "3.1009.0",
|
|
88
|
+
"@smithy/snapshot-testing": "^2.0.2",
|
|
89
89
|
"@tsconfig/node20": "20.1.8",
|
|
90
90
|
"@types/node": "^20.14.8",
|
|
91
91
|
"concurrently": "7.0.0",
|
|
@@ -34,8 +34,9 @@ Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</
|
|
|
34
34
|
To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
|
|
35
35
|
|
|
36
36
|
## Installing
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
|
|
38
|
+
To install this package, use the CLI of your favorite package manager:
|
|
39
|
+
|
|
39
40
|
- `npm install @aws-sdk/client-secrets-manager`
|
|
40
41
|
- `yarn add @aws-sdk/client-secrets-manager`
|
|
41
42
|
- `pnpm add @aws-sdk/client-secrets-manager`
|
|
@@ -60,15 +61,15 @@ import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secret
|
|
|
60
61
|
|
|
61
62
|
### Usage
|
|
62
63
|
|
|
63
|
-
To send a request
|
|
64
|
+
To send a request:
|
|
64
65
|
|
|
65
|
-
-
|
|
66
|
-
-
|
|
67
|
-
-
|
|
68
|
-
-
|
|
66
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
67
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
68
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
69
|
+
- Instantiate a command with input parameters.
|
|
70
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
69
71
|
|
|
70
72
|
```js
|
|
71
|
-
// a client can be shared by different commands.
|
|
72
73
|
const client = new SecretsManagerClient({ region: "REGION" });
|
|
73
74
|
|
|
74
75
|
const params = { /** input parameters */ };
|
|
@@ -77,7 +78,7 @@ const command = new ListSecretsCommand(params);
|
|
|
77
78
|
|
|
78
79
|
#### Async/await
|
|
79
80
|
|
|
80
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
81
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
81
82
|
operator to wait for the promise returned by send operation as follows:
|
|
82
83
|
|
|
83
84
|
```js
|
|
@@ -92,26 +93,9 @@ try {
|
|
|
92
93
|
}
|
|
93
94
|
```
|
|
94
95
|
|
|
95
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
96
|
-
as compared to using Promise chains or callbacks.
|
|
97
|
-
|
|
98
96
|
#### Promises
|
|
99
97
|
|
|
100
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
101
|
-
to execute send operation.
|
|
102
|
-
|
|
103
|
-
```js
|
|
104
|
-
client.send(command).then(
|
|
105
|
-
(data) => {
|
|
106
|
-
// process data.
|
|
107
|
-
},
|
|
108
|
-
(error) => {
|
|
109
|
-
// error handling.
|
|
110
|
-
}
|
|
111
|
-
);
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
98
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
115
99
|
|
|
116
100
|
```js
|
|
117
101
|
client
|
|
@@ -127,27 +111,21 @@ client
|
|
|
127
111
|
});
|
|
128
112
|
```
|
|
129
113
|
|
|
130
|
-
####
|
|
131
|
-
|
|
132
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
133
|
-
but they are supported by the send operation.
|
|
114
|
+
#### Aggregated client
|
|
134
115
|
|
|
135
|
-
|
|
136
|
-
// callbacks.
|
|
137
|
-
client.send(command, (err, data) => {
|
|
138
|
-
// process err and data.
|
|
139
|
-
});
|
|
140
|
-
```
|
|
116
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
141
117
|
|
|
142
|
-
|
|
118
|
+
`SecretsManager` extends `SecretsManagerClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
119
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
143
120
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
121
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SecretsManagerClient`).
|
|
122
|
+
More details are in the blog post on
|
|
123
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
147
124
|
|
|
148
125
|
```ts
|
|
149
|
-
import
|
|
150
|
-
|
|
126
|
+
import { SecretsManager } from "@aws-sdk/client-secrets-manager";
|
|
127
|
+
|
|
128
|
+
const client = new SecretsManager({ region: "REGION" });
|
|
151
129
|
|
|
152
130
|
// async/await.
|
|
153
131
|
try {
|
|
@@ -167,7 +145,7 @@ client
|
|
|
167
145
|
// error handling.
|
|
168
146
|
});
|
|
169
147
|
|
|
170
|
-
// callbacks.
|
|
148
|
+
// callbacks (not recommended).
|
|
171
149
|
client.listSecrets(params, (err, data) => {
|
|
172
150
|
// process err and data.
|
|
173
151
|
});
|
|
@@ -195,12 +173,14 @@ try {
|
|
|
195
173
|
}
|
|
196
174
|
```
|
|
197
175
|
|
|
176
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
177
|
+
|
|
198
178
|
## Getting Help
|
|
199
179
|
|
|
200
180
|
Please use these community resources for getting help.
|
|
201
|
-
We use
|
|
181
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
202
182
|
|
|
203
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
183
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
204
184
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
205
185
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
206
186
|
on AWS Developer Blog.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-secrets-manager",
|
|
3
3
|
"description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1009.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-secrets-manager",
|
|
@@ -25,46 +25,46 @@
|
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
27
27
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
28
|
-
"@aws-sdk/core": "^3.973.
|
|
29
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
30
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
31
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
32
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
33
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
34
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
35
|
-
"@aws-sdk/types": "^3.973.
|
|
36
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
37
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
38
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
39
|
-
"@smithy/config-resolver": "^4.4.
|
|
40
|
-
"@smithy/core": "^3.23.
|
|
41
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
42
|
-
"@smithy/hash-node": "^4.2.
|
|
43
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
44
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
45
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
46
|
-
"@smithy/middleware-retry": "^4.4.
|
|
47
|
-
"@smithy/middleware-serde": "^4.2.
|
|
48
|
-
"@smithy/middleware-stack": "^4.2.
|
|
49
|
-
"@smithy/node-config-provider": "^4.3.
|
|
50
|
-
"@smithy/node-http-handler": "^4.4.
|
|
51
|
-
"@smithy/protocol-http": "^5.3.
|
|
52
|
-
"@smithy/smithy-client": "^4.12.
|
|
53
|
-
"@smithy/types": "^4.13.
|
|
54
|
-
"@smithy/url-parser": "^4.2.
|
|
28
|
+
"@aws-sdk/core": "^3.973.20",
|
|
29
|
+
"@aws-sdk/credential-provider-node": "^3.972.21",
|
|
30
|
+
"@aws-sdk/middleware-host-header": "^3.972.8",
|
|
31
|
+
"@aws-sdk/middleware-logger": "^3.972.8",
|
|
32
|
+
"@aws-sdk/middleware-recursion-detection": "^3.972.8",
|
|
33
|
+
"@aws-sdk/middleware-user-agent": "^3.972.21",
|
|
34
|
+
"@aws-sdk/region-config-resolver": "^3.972.8",
|
|
35
|
+
"@aws-sdk/types": "^3.973.6",
|
|
36
|
+
"@aws-sdk/util-endpoints": "^3.996.5",
|
|
37
|
+
"@aws-sdk/util-user-agent-browser": "^3.972.8",
|
|
38
|
+
"@aws-sdk/util-user-agent-node": "^3.973.7",
|
|
39
|
+
"@smithy/config-resolver": "^4.4.11",
|
|
40
|
+
"@smithy/core": "^3.23.11",
|
|
41
|
+
"@smithy/fetch-http-handler": "^5.3.15",
|
|
42
|
+
"@smithy/hash-node": "^4.2.12",
|
|
43
|
+
"@smithy/invalid-dependency": "^4.2.12",
|
|
44
|
+
"@smithy/middleware-content-length": "^4.2.12",
|
|
45
|
+
"@smithy/middleware-endpoint": "^4.4.25",
|
|
46
|
+
"@smithy/middleware-retry": "^4.4.42",
|
|
47
|
+
"@smithy/middleware-serde": "^4.2.14",
|
|
48
|
+
"@smithy/middleware-stack": "^4.2.12",
|
|
49
|
+
"@smithy/node-config-provider": "^4.3.12",
|
|
50
|
+
"@smithy/node-http-handler": "^4.4.16",
|
|
51
|
+
"@smithy/protocol-http": "^5.3.12",
|
|
52
|
+
"@smithy/smithy-client": "^4.12.5",
|
|
53
|
+
"@smithy/types": "^4.13.1",
|
|
54
|
+
"@smithy/url-parser": "^4.2.12",
|
|
55
55
|
"@smithy/util-base64": "^4.3.2",
|
|
56
56
|
"@smithy/util-body-length-browser": "^4.2.2",
|
|
57
57
|
"@smithy/util-body-length-node": "^4.2.3",
|
|
58
|
-
"@smithy/util-defaults-mode-browser": "^4.3.
|
|
59
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
60
|
-
"@smithy/util-endpoints": "^3.3.
|
|
61
|
-
"@smithy/util-middleware": "^4.2.
|
|
62
|
-
"@smithy/util-retry": "^4.2.
|
|
58
|
+
"@smithy/util-defaults-mode-browser": "^4.3.41",
|
|
59
|
+
"@smithy/util-defaults-mode-node": "^4.2.44",
|
|
60
|
+
"@smithy/util-endpoints": "^3.3.3",
|
|
61
|
+
"@smithy/util-middleware": "^4.2.12",
|
|
62
|
+
"@smithy/util-retry": "^4.2.12",
|
|
63
63
|
"@smithy/util-utf8": "^4.2.2",
|
|
64
64
|
"tslib": "^2.6.2"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
|
-
"@smithy/snapshot-testing": "^2.0.
|
|
67
|
+
"@smithy/snapshot-testing": "^2.0.2",
|
|
68
68
|
"@tsconfig/node20": "20.1.8",
|
|
69
69
|
"@types/node": "^20.14.8",
|
|
70
70
|
"concurrently": "7.0.0",
|
|
@@ -18,8 +18,9 @@ AWS SDK for JavaScript SFN Client for Node.js, Browser and React Native.
|
|
|
18
18
|
</important>
|
|
19
19
|
|
|
20
20
|
## Installing
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
|
|
22
|
+
To install this package, use the CLI of your favorite package manager:
|
|
23
|
+
|
|
23
24
|
- `npm install @aws-sdk/client-sfn`
|
|
24
25
|
- `yarn add @aws-sdk/client-sfn`
|
|
25
26
|
- `pnpm add @aws-sdk/client-sfn`
|
|
@@ -44,15 +45,15 @@ import { SFNClient, ListActivitiesCommand } from "@aws-sdk/client-sfn";
|
|
|
44
45
|
|
|
45
46
|
### Usage
|
|
46
47
|
|
|
47
|
-
To send a request
|
|
48
|
+
To send a request:
|
|
48
49
|
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
50
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
51
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
52
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
53
|
+
- Instantiate a command with input parameters.
|
|
54
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
53
55
|
|
|
54
56
|
```js
|
|
55
|
-
// a client can be shared by different commands.
|
|
56
57
|
const client = new SFNClient({ region: "REGION" });
|
|
57
58
|
|
|
58
59
|
const params = { /** input parameters */ };
|
|
@@ -61,7 +62,7 @@ const command = new ListActivitiesCommand(params);
|
|
|
61
62
|
|
|
62
63
|
#### Async/await
|
|
63
64
|
|
|
64
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
65
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
65
66
|
operator to wait for the promise returned by send operation as follows:
|
|
66
67
|
|
|
67
68
|
```js
|
|
@@ -76,26 +77,9 @@ try {
|
|
|
76
77
|
}
|
|
77
78
|
```
|
|
78
79
|
|
|
79
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
80
|
-
as compared to using Promise chains or callbacks.
|
|
81
|
-
|
|
82
80
|
#### Promises
|
|
83
81
|
|
|
84
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
85
|
-
to execute send operation.
|
|
86
|
-
|
|
87
|
-
```js
|
|
88
|
-
client.send(command).then(
|
|
89
|
-
(data) => {
|
|
90
|
-
// process data.
|
|
91
|
-
},
|
|
92
|
-
(error) => {
|
|
93
|
-
// error handling.
|
|
94
|
-
}
|
|
95
|
-
);
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
82
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
99
83
|
|
|
100
84
|
```js
|
|
101
85
|
client
|
|
@@ -111,27 +95,21 @@ client
|
|
|
111
95
|
});
|
|
112
96
|
```
|
|
113
97
|
|
|
114
|
-
####
|
|
115
|
-
|
|
116
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
117
|
-
but they are supported by the send operation.
|
|
98
|
+
#### Aggregated client
|
|
118
99
|
|
|
119
|
-
|
|
120
|
-
// callbacks.
|
|
121
|
-
client.send(command, (err, data) => {
|
|
122
|
-
// process err and data.
|
|
123
|
-
});
|
|
124
|
-
```
|
|
100
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
125
101
|
|
|
126
|
-
|
|
102
|
+
`SFN` extends `SFNClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
103
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
127
104
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
105
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SFNClient`).
|
|
106
|
+
More details are in the blog post on
|
|
107
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
131
108
|
|
|
132
109
|
```ts
|
|
133
|
-
import
|
|
134
|
-
|
|
110
|
+
import { SFN } from "@aws-sdk/client-sfn";
|
|
111
|
+
|
|
112
|
+
const client = new SFN({ region: "REGION" });
|
|
135
113
|
|
|
136
114
|
// async/await.
|
|
137
115
|
try {
|
|
@@ -151,7 +129,7 @@ client
|
|
|
151
129
|
// error handling.
|
|
152
130
|
});
|
|
153
131
|
|
|
154
|
-
// callbacks.
|
|
132
|
+
// callbacks (not recommended).
|
|
155
133
|
client.listActivities(params, (err, data) => {
|
|
156
134
|
// process err and data.
|
|
157
135
|
});
|
|
@@ -179,12 +157,14 @@ try {
|
|
|
179
157
|
}
|
|
180
158
|
```
|
|
181
159
|
|
|
160
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
161
|
+
|
|
182
162
|
## Getting Help
|
|
183
163
|
|
|
184
164
|
Please use these community resources for getting help.
|
|
185
|
-
We use
|
|
165
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
186
166
|
|
|
187
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
167
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
188
168
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
189
169
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
190
170
|
on AWS Developer Blog.
|