From 53224b23828d46db8e16d94059c24eb399cad440 Mon Sep 17 00:00:00 2001 From: George Fu Date: Mon, 17 Apr 2023 16:48:56 +0000 Subject: [PATCH] feat(smithy-client): factory for aggregated clients --- clients/client-s3/src/S3.ts | 7401 ++--------------- packages/smithy-client/src/index.ts | 1 + private/aws-echo-service/src/EchoService.ts | 71 +- .../aws-protocoltests-ec2/src/EC2Protocol.ts | 670 +- .../src/JSONRPC10.ts | 255 +- .../src/JsonProtocol.ts | 378 +- .../src/QueryProtocol.ts | 880 +- .../src/RestJsonProtocol.ts | 2382 ++---- .../src/RestXmlProtocol.ts | 1514 +--- scripts/byte-count/get-cjs-byte-count.js | 19 +- 10 files changed, 1737 insertions(+), 11834 deletions(-) diff --git a/clients/client-s3/src/S3.ts b/clients/client-s3/src/S3.ts index 52af7133d17c..8126e793b9a4 100644 --- a/clients/client-s3/src/S3.ts +++ b/clients/client-s3/src/S3.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -430,8000 +431,1558 @@ import { WriteGetObjectResponseCommandInput, WriteGetObjectResponseCommandOutput, } from "./commands/WriteGetObjectResponseCommand"; -import { S3Client } from "./S3Client"; +import { S3Client, S3ClientConfig } from "./S3Client"; -/** - * @public - *

- */ -export class S3 extends S3Client { +const commands = { + AbortMultipartUploadCommand, + CompleteMultipartUploadCommand, + CopyObjectCommand, + CreateBucketCommand, + CreateMultipartUploadCommand, + DeleteBucketCommand, + DeleteBucketAnalyticsConfigurationCommand, + DeleteBucketCorsCommand, + DeleteBucketEncryptionCommand, + DeleteBucketIntelligentTieringConfigurationCommand, + DeleteBucketInventoryConfigurationCommand, + DeleteBucketLifecycleCommand, + DeleteBucketMetricsConfigurationCommand, + DeleteBucketOwnershipControlsCommand, + DeleteBucketPolicyCommand, + DeleteBucketReplicationCommand, + DeleteBucketTaggingCommand, + DeleteBucketWebsiteCommand, + DeleteObjectCommand, + DeleteObjectsCommand, + DeleteObjectTaggingCommand, + DeletePublicAccessBlockCommand, + GetBucketAccelerateConfigurationCommand, + GetBucketAclCommand, + GetBucketAnalyticsConfigurationCommand, + GetBucketCorsCommand, + GetBucketEncryptionCommand, + GetBucketIntelligentTieringConfigurationCommand, + GetBucketInventoryConfigurationCommand, + GetBucketLifecycleConfigurationCommand, + GetBucketLocationCommand, + GetBucketLoggingCommand, + GetBucketMetricsConfigurationCommand, + GetBucketNotificationConfigurationCommand, + GetBucketOwnershipControlsCommand, + GetBucketPolicyCommand, + GetBucketPolicyStatusCommand, + GetBucketReplicationCommand, + GetBucketRequestPaymentCommand, + GetBucketTaggingCommand, + GetBucketVersioningCommand, + GetBucketWebsiteCommand, + GetObjectCommand, + GetObjectAclCommand, + GetObjectAttributesCommand, + GetObjectLegalHoldCommand, + GetObjectLockConfigurationCommand, + GetObjectRetentionCommand, + GetObjectTaggingCommand, + GetObjectTorrentCommand, + GetPublicAccessBlockCommand, + HeadBucketCommand, + HeadObjectCommand, + ListBucketAnalyticsConfigurationsCommand, + ListBucketIntelligentTieringConfigurationsCommand, + ListBucketInventoryConfigurationsCommand, + ListBucketMetricsConfigurationsCommand, + ListBucketsCommand, + ListMultipartUploadsCommand, + ListObjectsCommand, + ListObjectsV2Command, + ListObjectVersionsCommand, + ListPartsCommand, + PutBucketAccelerateConfigurationCommand, + PutBucketAclCommand, + PutBucketAnalyticsConfigurationCommand, + PutBucketCorsCommand, + PutBucketEncryptionCommand, + PutBucketIntelligentTieringConfigurationCommand, + PutBucketInventoryConfigurationCommand, + PutBucketLifecycleConfigurationCommand, + PutBucketLoggingCommand, + PutBucketMetricsConfigurationCommand, + PutBucketNotificationConfigurationCommand, + PutBucketOwnershipControlsCommand, + PutBucketPolicyCommand, + PutBucketReplicationCommand, + PutBucketRequestPaymentCommand, + PutBucketTaggingCommand, + PutBucketVersioningCommand, + PutBucketWebsiteCommand, + PutObjectCommand, + PutObjectAclCommand, + PutObjectLegalHoldCommand, + PutObjectLockConfigurationCommand, + PutObjectRetentionCommand, + PutObjectTaggingCommand, + PutPublicAccessBlockCommand, + RestoreObjectCommand, + SelectObjectContentCommand, + UploadPartCommand, + UploadPartCopyCommand, + WriteGetObjectResponseCommand, +}; +export interface S3 { /** - * @public - *

This action aborts a multipart upload. After a multipart upload is aborted, no - * additional parts can be uploaded using that upload ID. The storage consumed by any - * previously uploaded parts will be freed. However, if any part uploads are currently in - * progress, those part uploads might or might not succeed. As a result, it might be necessary - * to abort a given multipart upload multiple times in order to completely free all storage - * consumed by all parts.

- *

To verify that all parts have been removed, so you don't get charged for the part - * storage, you should call the ListParts action and ensure that - * the parts list is empty.

- *

For information about permissions required to use the multipart upload, see Multipart Upload - * and Permissions.

- *

The following operations are related to AbortMultipartUpload:

- * + * @see {@link AbortMultipartUploadCommand} */ - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( - args: AbortMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: AbortMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new AbortMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Completes a multipart upload by assembling previously uploaded parts.

- *

You first initiate the multipart upload and then upload all parts using the UploadPart - * operation. After successfully uploading all relevant parts of an upload, you call this - * action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the - * parts in ascending order by part number to create a new object. In the Complete Multipart - * Upload request, you must provide the parts list. You must ensure that the parts list is - * complete. This action concatenates the parts that you provide in the list. For each part in - * the list, you must provide the part number and the ETag value, returned after - * that part was uploaded.

- *

Processing of a Complete Multipart Upload request could take several minutes to - * complete. After Amazon S3 begins processing the request, it sends an HTTP response header that - * specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white - * space characters to keep the connection from timing out. A request could fail after the - * initial 200 OK response has been sent. This means that a 200 OK response can - * contain either a success or an error. If you call the S3 API directly, make sure to design - * your application to parse the contents of the response and handle it appropriately. If you - * use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply - * error handling per your configuration settings (including automatically retrying the - * request as appropriate). If the condition persists, the SDKs throws an exception (or, for - * the SDKs that don't use exceptions, they return the error).

- *

Note that if CompleteMultipartUpload fails, applications should be prepared - * to retry the failed requests. For more information, see Amazon S3 Error Best - * Practices.

- * - *

You cannot use Content-Type: application/x-www-form-urlencoded with - * Complete Multipart Upload requests. Also, if you do not provide a - * Content-Type header, CompleteMultipartUpload returns a 200 - * OK response.

- * - *

For more information about multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information about permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

- * CompleteMultipartUpload has the following special errors:

- *
    - *
  • - *

    Error code: EntityTooSmall - *

    - *
      - *
    • - *

      Description: Your proposed upload is smaller than the minimum allowed object - * size. Each part must be at least 5 MB in size, except the last part.

      - *
      • - *
    • - *

      400 Bad Request

      - *
      • - *
    - *
    • - *
  • - *

    Error code: InvalidPart - *

    - *
      - *
    • - *

      Description: One or more of the specified parts could not be found. The part - * might not have been uploaded, or the specified entity tag might not have - * matched the part's entity tag.

      - *
      • - *
    • - *

      400 Bad Request

      - *
      • - *
    - *
    • - *
  • - *

    Error code: InvalidPartOrder - *

    - *
      - *
    • - *

      Description: The list of parts was not in ascending order. The parts list - * must be specified in order by part number.

      - *
      • - *
    • - *

      400 Bad Request

      - *
      • - *
    - *
    • - *
  • - *

    Error code: NoSuchUpload - *

    - *
      - *
    • - *

      Description: The specified multipart upload does not exist. The upload ID - * might be invalid, or the multipart upload might have been aborted or - * completed.

      - *
      • - *
    • - *

      404 Not Found

      - *
      • - *
    - *
    • - *
- *

The following operations are related to CompleteMultipartUpload:

- * + * @see {@link CompleteMultipartUploadCommand} */ - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( - args: CompleteMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a copy of an object that is already stored in Amazon S3.

- * - *

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your - * object up to 5 GB in size in a single atomic action using this API. However, to copy an - * object greater than 5 GB, you must use the multipart upload Upload Part - Copy - * (UploadPartCopy) API. For more information, see Copy Object Using the - * REST Multipart Upload API.

- * - *

All copy requests must be authenticated. Additionally, you must have - * read access to the source object and write - * access to the destination bucket. For more information, see REST Authentication. Both the - * Region that you want to copy the object from and the Region that you want to copy the - * object to must be enabled for your account.

- *

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 - * is copying the files. If the error occurs before the copy action starts, you receive a - * standard Amazon S3 error. If the error occurs during the copy operation, the error response is - * embedded in the 200 OK response. This means that a 200 OK - * response can contain either a success or an error. If you call the S3 API directly, make - * sure to design your application to parse the contents of the response and handle it - * appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the - * embedded error and apply error handling per your configuration settings (including - * automatically retrying the request as appropriate). If the condition persists, the SDKs - * throws an exception (or, for the SDKs that don't use exceptions, they return the - * error).

- *

If the copy is successful, you receive a response with information about the copied - * object.

- * - *

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - * it would not contain the content-length, and you would need to read the entire - * body.

- * - *

The copy request charge is based on the storage class and Region that you specify for - * the destination object. For pricing information, see Amazon S3 pricing.

- * - *

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a - * cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - * Request error. For more information, see Transfer - * Acceleration.

- * - *

- * Metadata - *

- *

When copying an object, you can preserve all metadata (default) or specify new metadata. - * However, the ACL is not preserved and is set to private for the user making the request. To - * override the default ACL setting, specify a new ACL when generating a copy request. For - * more information, see Using ACLs.

- *

To specify whether you want the object metadata copied from the source object or - * replaced with metadata provided in the request, you can optionally add the - * x-amz-metadata-directive header. When you grant permissions, you can use - * the s3:x-amz-metadata-directive condition key to enforce certain metadata - * behavior when objects are uploaded. For more information, see Specifying Conditions in a - * Policy in the Amazon S3 User Guide. For a complete list of - * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for - * Amazon S3.

- * - *

- * x-amz-website-redirect-location is unique to each object and must be - * specified in the request headers to copy the value.

- * - *

- * x-amz-copy-source-if Headers - *

- *

To only copy an object under certain conditions, such as whether the Etag - * matches or whether the object was modified before or after a specified date, use the - * following request parameters:

- *
    - *
  • - *

    - * x-amz-copy-source-if-match - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-none-match - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-unmodified-since - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-modified-since - *

    - *
    • - *
- *

If both the x-amz-copy-source-if-match and - * x-amz-copy-source-if-unmodified-since headers are present in the request - * and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

- *
    - *
  • - *

    - * x-amz-copy-source-if-match condition evaluates to true

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-unmodified-since condition evaluates to - * false

    - *
    • - *
- *

If both the x-amz-copy-source-if-none-match and - * x-amz-copy-source-if-modified-since headers are present in the request and - * evaluate as follows, Amazon S3 returns the 412 Precondition Failed response - * code:

- *
    - *
  • - *

    - * x-amz-copy-source-if-none-match condition evaluates to false

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-modified-since condition evaluates to - * true

    - *
    • - *
- * - *

All headers with the x-amz- prefix, including - * x-amz-copy-source, must be signed.

- * - *

- * Server-side encryption - *

- *

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When - * copying an object, if you don't specify encryption information in your copy request, the - * encryption setting of the target object is set to the default encryption configuration of - * the destination bucket. By default, all buckets have a base level of encryption - * configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the - * destination bucket has a default encryption configuration that uses server-side encryption - * with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), - * Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target - * object copy. When you perform a CopyObject operation, if you want to use a different type - * of encryption setting for the target object, you can use other appropriate - * encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed - * key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts the data when you access it. If the - * encryption setting in your request is different from the default encryption configuration - * of the destination bucket, the encryption setting in your request takes precedence. If the - * source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary - * encryption information in your request so that Amazon S3 can decrypt the object for copying. For - * more information about server-side encryption, see Using Server-Side - * Encryption.

- *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - * more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

When copying an object, you can optionally use headers to grant ACL-based permissions. - * By default, all objects are private. Only the owner has full access control. When adding a - * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups - * defined by Amazon S3. These permissions are then added to the ACL on the object. For more - * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST - * API.

- *

If the bucket that you're copying objects to uses the bucket owner enforced setting for - * S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use - * this setting only accept PUT requests that don't specify an ACL or PUT requests that - * specify bucket owner full control ACLs, such as the bucket-owner-full-control - * canned ACL or an equivalent form of this ACL expressed in the XML format.

- *

For more information, see Controlling ownership of - * objects and disabling ACLs in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for Object Ownership, all - * objects written to the bucket by any account will be owned by the bucket owner.

- * - *

- * Checksums - *

- *

When copying an object, if it has a checksum, that checksum will be copied to the new - * object by default. When you copy the object over, you may optionally specify a different - * checksum algorithm to use with the x-amz-checksum-algorithm header.

- *

- * Storage Class Options - *

- *

You can use the CopyObject action to change the storage class of an object - * that is already stored in Amazon S3 using the StorageClass parameter. For more - * information, see Storage Classes in the - * Amazon S3 User Guide.

- *

- * Versioning - *

- *

By default, x-amz-copy-source identifies the current version of an object - * to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was - * deleted. To copy a different version, use the versionId subresource.

- *

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for - * the object being copied. This version ID is different from the version ID of the source - * object. Amazon S3 returns the version ID of the copied object in the - * x-amz-version-id response header in the response.

- *

If you do not enable versioning or suspend it on the target bucket, the version ID that - * Amazon S3 generates is always null.

- *

If the source object's storage class is GLACIER, you must restore a copy of this object - * before you can use it as a source object for the copy operation. For more information, see - * RestoreObject.

- *

The following operations are related to CopyObject:

- * - *

For more information, see Copying Objects.

+ * @see {@link CopyObjectCommand} */ - public copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void; - public copyObject( + copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise; + copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void; + copyObject( args: CopyObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyObjectCommandOutput) => void ): void; - public copyObject( - args: CopyObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyObjectCommandOutput) => void), - cb?: (err: any, data?: CopyObjectCommandOutput) => void - ): Promise | void { - const command = new CopyObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a - * valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to - * create buckets. By creating the bucket, you become the bucket owner.

- *

Not every string is an acceptable bucket name. For information about bucket naming - * restrictions, see Bucket naming - * rules.

- *

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

- *

By default, the bucket is created in the US East (N. Virginia) Region. You can - * optionally specify a Region in the request body. You might choose a Region to optimize - * latency, minimize costs, or address regulatory requirements. For example, if you reside in - * Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - * Region. For more information, see Accessing a - * bucket.

- * - *

If you send your create bucket request to the s3.amazonaws.com endpoint, - * the request goes to the us-east-1 Region. Accordingly, the signature calculations in - * Signature Version 4 must use us-east-1 as the Region, even if the location constraint in - * the request specifies another Region where the bucket is to be created. If you create a - * bucket in a Region other than US East (N. Virginia), your application must be able to - * handle 307 redirect. For more information, see Virtual hosting of - * buckets.

- * - *

- * Access control lists (ACLs) - *

- *

When creating a bucket using this operation, you can optionally configure the bucket ACL - * to specify the accounts or groups that should be granted specific permissions on the - * bucket.

- * - *

If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and - * specifies a bucket ACL that provides access to an external Amazon Web Services account, your request - * fails with a 400 error and returns the - * InvalidBucketAclWithObjectOwnership error code. For more information, - * see Controlling object - * ownership in the Amazon S3 User Guide.

- * - *

There are two ways to grant the appropriate permissions using the request - * headers.

- *
    - *
  • - *

    Specify a canned ACL using the x-amz-acl request header. Amazon S3 - * supports a set of predefined ACLs, known as canned ACLs. Each - * canned ACL has a predefined set of grantees and permissions. For more information, - * see Canned ACL.

    - *
    • - *
  • - *

    Specify access permissions explicitly using the x-amz-grant-read, - * x-amz-grant-write, x-amz-grant-read-acp, - * x-amz-grant-write-acp, and x-amz-grant-full-control - * headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For - * more information, see Access control list (ACL) - * overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
      • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
      • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       - *
      • - *
    - *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    - *

    - * x-amz-grant-read: id="11112222333", id="444455556666" - *

    - *
    • - *
- * - *

You can use either a canned ACL or specify access permissions explicitly. You cannot - * do both.

- * - *

- * Permissions - *

- *

In addition to s3:CreateBucket, the following permissions are required when - * your CreateBucket includes specific headers:

- *
    - *
  • - *

    - * ACLs - If your CreateBucket request - * specifies ACL permissions and the ACL is public-read, public-read-write, - * authenticated-read, or if you specify access permissions explicitly through any other - * ACL, both s3:CreateBucket and s3:PutBucketAcl permissions - * are needed. If the ACL the CreateBucket request is private or doesn't - * specify any ACLs, only s3:CreateBucket permission is needed.

    - *
    • - *
  • - *

    - * Object Lock - If - * ObjectLockEnabledForBucket is set to true in your - * CreateBucket request, - * s3:PutBucketObjectLockConfiguration and - * s3:PutBucketVersioning permissions are required.

    - *
    • - *
  • - *

    - * S3 Object Ownership - If your CreateBucket - * request includes the the x-amz-object-ownership header, - * s3:PutBucketOwnershipControls permission is required.

    - *
    • - *
- *

The following operations are related to CreateBucket:

- * + * @see {@link CreateBucketCommand} */ - public createBucket( - args: CreateBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; - public createBucket( + createBucket(args: CreateBucketCommandInput, options?: __HttpHandlerOptions): Promise; + createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; + createBucket( args: CreateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketCommandOutput) => void ): void; - public createBucket( - args: CreateBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBucketCommandOutput) => void), - cb?: (err: any, data?: CreateBucketCommandOutput) => void - ): Promise | void { - const command = new CreateBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action initiates a multipart upload and returns an upload ID. This upload ID is - * used to associate all of the parts in the specific multipart upload. You specify this - * upload ID in each of your subsequent upload part requests (see UploadPart). You also include this - * upload ID in the final request to either complete or abort the multipart upload - * request.

- *

For more information about multipart uploads, see Multipart Upload Overview.

- *

If you have configured a lifecycle rule to abort incomplete multipart uploads, the - * upload must complete within the number of days specified in the bucket lifecycle - * configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort - * action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

- *

For information about the permissions required to use the multipart upload API, see - * Multipart - * Upload and Permissions.

- *

For request signing, multipart upload is just a series of regular requests. You initiate - * a multipart upload, send one or more requests to upload parts, and then complete the - * multipart upload process. You sign each request individually. There is nothing special - * about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

- * - *

After you initiate a multipart upload and upload one or more parts, to stop being - * charged for storing the uploaded parts, you must either complete or abort the multipart - * upload. Amazon S3 frees up the space used to store the parts and stop charging you for - * storing them only after you either complete or abort a multipart upload.

- * - *

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts it when you access it. Amazon S3 - * automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a - * multipart upload, if you don't specify encryption information in your request, the - * encryption setting of the uploaded parts is set to the default encryption configuration of - * the destination bucket. By default, all buckets have a base level of encryption - * configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the - * destination bucket has a default encryption configuration that uses server-side encryption - * with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), - * Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded - * parts. When you perform a CreateMultipartUpload operation, if you want to use a different - * type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the - * object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption - * setting in your request is different from the default encryption configuration of the - * destination bucket, the encryption setting in your request takes precedence. If you choose - * to provide your own encryption key, the request headers you provide in UploadPart - * and UploadPartCopy requests must - * match the headers you used in the request to initiate the upload by using - * CreateMultipartUpload. you can request that Amazon S3 - * save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key - * (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key - * (SSE-C).

- *

To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester - * must have permission to the kms:Decrypt and kms:GenerateDataKey* - * actions on the key. These permissions are required because Amazon S3 must decrypt and read data - * from the encrypted file parts before it completes the multipart upload. For more - * information, see Multipart upload API - * and permissions and Protecting data using - * server-side encryption with Amazon Web Services KMS in the - * Amazon S3 User Guide.

- *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, - * then you must have these permissions on the key policy. If your IAM user or role belongs - * to a different account than the key, then you must have the permissions on both the key - * policy and your IAM user or role.

- *

For more information, see Protecting Data Using Server-Side - * Encryption.

- *
- *
Access Permissions
- *
- *

When copying an object, you can optionally specify the accounts or groups that - * should be granted specific permissions on the new object. There are two ways to - * grant the permissions using the request headers:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. For - * more information, see Canned - * ACL.

    - *
    • - *
  • - *

    Specify access permissions explicitly with the - * x-amz-grant-read, x-amz-grant-read-acp, - * x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. These parameters map to - * the set of permissions that Amazon S3 supports in an ACL. For more information, - * see Access Control List (ACL) Overview.

    - *
    • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You - * cannot do both.

- *
- *
Server-Side- Encryption-Specific Request Headers
- *
- *

Amazon S3 encrypts data - * by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts - * your data as it writes it to disks in its data centers and decrypts it when you - * access it. You can request that Amazon S3 encrypts - * data at rest by using server-side encryption with other key options. The option you use depends on - * whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys - * (SSE-C).

- *
    - *
  • - *

    Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key - * (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you - * want Amazon Web Services to manage the keys used to encrypt data, specify the following - * headers in the request.

    - *
      - *
    • - *

      - * x-amz-server-side-encryption - *

      - *
      • - *
    • - *

      - * x-amz-server-side-encryption-aws-kms-key-id - *

      - *
      • - *
    • - *

      - * x-amz-server-side-encryption-context - *

      - *
      • - *
    - * - *

    If you specify x-amz-server-side-encryption:aws:kms, but - * don't provide x-amz-server-side-encryption-aws-kms-key-id, - * Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to - * protect the data.

    - *     - * - *

    All GET and PUT requests for an object protected - * by KMS fail if you don't make them by using Secure Sockets Layer (SSL), - * Transport Layer Security (TLS), or Signature Version 4.

    - *     - *

    For more information about server-side encryption with KMS keys - * (SSE-KMS), see Protecting Data - * Using Server-Side Encryption with KMS keys.

    - *
    • - *
  • - *

    Use customer-provided encryption keys (SSE-C) – If you want to manage - * your own encryption keys, provide all the following headers in the - * request.

    - *
      - *
    • - *

      - * 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 server-side encryption with customer-provided - * encryption keys (SSE-C), see - * Protecting data using server-side encryption with customer-provided - * encryption keys (SSE-C).

    - *
    • - *
- *
- *
Access-Control-List (ACL)-Specific Request Headers
- *
- *

You also can use the following access control–related headers with this - * operation. By default, all objects are private. Only the owner has full access - * control. When adding a new object, you can grant permissions to individual - * Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then - * added to the access control list (ACL) on the object. For more information, see - * Using ACLs. With this operation, you can grant access permissions - * using one of the following two methods:

- *
    - *
  • - *

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of - * predefined ACLs, known as canned ACLs. Each canned ACL - * has a predefined set of grantees and permissions. For more information, see - * Canned - * ACL.

    - *
    • - *
  • - *

    Specify access permissions explicitly — To explicitly grant access - * permissions to specific Amazon Web Services accounts or groups, use the following headers. - * Each header maps to specific permissions that Amazon S3 supports in an ACL. For - * more information, see Access Control List (ACL) - * Overview. In the header, you specify a list of grantees who get - * the specific permission. To grant permissions explicitly, use:

    - *
      - *
    • - *

      - * x-amz-grant-read - *

      - *
      • - *
    • - *

      - * x-amz-grant-write - *

      - *
      • - *
    • - *

      - * x-amz-grant-read-acp - *

      - *
      • - *
    • - *

      - * x-amz-grant-write-acp - *

      - *
      • - *
    • - *

      - * x-amz-grant-full-control - *

      - *
      • - *
    - *

    You specify each grantee as a type=value pair, where the type is one of - * the following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID - * of an Amazon Web Services account

      - *
      • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
      • - *
    • - *

      - * emailAddress – if the value specified is the email - * address of an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       - *
      • - *
    - *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    - *

    - * x-amz-grant-read: id="11112222333", id="444455556666" - *

    - *
    • - *
- *
- *
- *

The following operations are related to CreateMultipartUpload:

- * + * @see {@link CreateMultipartUploadCommand} */ - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, cb: (err: any, data?: CreateMultipartUploadCommandOutput) => void ): void; - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultipartUploadCommandOutput) => void ): void; - public createMultipartUpload( - args: CreateMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: CreateMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new CreateMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the S3 bucket. All objects (including all object versions and delete markers) in - * the bucket must be deleted before the bucket itself can be deleted.

- *

- * Related Resources - *

- * + * @see {@link DeleteBucketCommand} */ - public deleteBucket( - args: DeleteBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; - public deleteBucket( + deleteBucket(args: DeleteBucketCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; + deleteBucket( args: DeleteBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCommandOutput) => void ): void; - public deleteBucket( - args: DeleteBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an analytics configuration for the bucket (specified by the analytics - * configuration ID).

- *

To use this operation, you must have permissions to perform the - * s3:PutAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis.

- *

The following operations are related to - * DeleteBucketAnalyticsConfiguration:

- * + * @see {@link DeleteBucketAnalyticsConfigurationCommand} */ - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void ): void; - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void ): void; - public deleteBucketAnalyticsConfiguration( - args: DeleteBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the cors configuration information set for the bucket.

- *

To use this operation, you must have permission to perform the - * s3:PutBucketCORS action. The bucket owner has this permission by default - * and can grant this permission to others.

- *

For information about cors, see Enabling Cross-Origin Resource Sharing in - * the Amazon S3 User Guide.

- *

- * Related Resources: - *

- * + * @see {@link DeleteBucketCorsCommand} */ - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, cb: (err: any, data?: DeleteBucketCorsCommandOutput) => void ): void; - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCorsCommandOutput) => void ): void; - public deleteBucketCors( - args: DeleteBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCorsCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCorsCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the DELETE action resets the default encryption for the - * bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the - * bucket default encryption feature, see Amazon S3 Bucket Default Encryption - * in the Amazon S3 User Guide.

- *

To use this operation, you must have permissions to perform the - * s3:PutEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link DeleteBucketEncryptionCommand} */ - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, cb: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void ): void; - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void ): void; - public deleteBucketEncryption( - args: DeleteBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to DeleteBucketIntelligentTieringConfiguration include:

- * + * @see {@link DeleteBucketIntelligentTieringConfigurationCommand} */ - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public deleteBucketIntelligentTieringConfiguration( - args: DeleteBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an inventory configuration (identified by the inventory ID) from the - * bucket.

- *

To use this operation, you must have permissions to perform the - * s3:PutInventoryConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

- *

Operations related to DeleteBucketInventoryConfiguration include:

- * + * @see {@link DeleteBucketInventoryConfigurationCommand} */ - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, cb: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void ): void; - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void ): void; - public deleteBucketInventoryConfiguration( - args: DeleteBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the - * lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your - * objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of - * rules contained in the deleted lifecycle configuration.

- *

To use this operation, you must have permission to perform the - * s3:PutLifecycleConfiguration action. By default, the bucket owner has this - * permission and the bucket owner can grant this permission to others.

- *

There is usually some time lag before lifecycle configuration deletion is fully - * propagated to all the Amazon S3 systems.

- *

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

- *

Related actions include:

- * + * @see {@link DeleteBucketLifecycleCommand} */ - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, cb: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void ): void; - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void ): void; - public deleteBucketLifecycle( - args: DeleteBucketLifecycleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketLifecycleCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketLifecycleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the - * metrics configuration ID) from the bucket. Note that this doesn't include the daily storage - * metrics.

- *

To use this operation, you must have permissions to perform the - * s3:PutMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with - * Amazon CloudWatch.

- *

The following operations are related to - * DeleteBucketMetricsConfiguration:

- * + * @see {@link DeleteBucketMetricsConfigurationCommand} */ - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, cb: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void ): void; - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void ): void; - public deleteBucketMetricsConfiguration( - args: DeleteBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:PutBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to - * DeleteBucketOwnershipControls:

- * + * @see {@link DeleteBucketOwnershipControlsCommand} */ - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, cb: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void ): void; - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void ): void; - public deleteBucketOwnershipControls( - args: DeleteBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the DELETE action uses the policy subresource to delete the - * policy of a specified bucket. If you are using an identity other than the root user of the - * Amazon Web Services account that owns the bucket, the calling identity must have the - * DeleteBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account to use this operation.

- *

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- * - *

For more information about bucket policies, see Using Bucket Policies and - * UserPolicies.

- *

The following operations are related to DeleteBucketPolicy - *

- * + * @see {@link DeleteBucketPolicyCommand} */ - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( - args: DeleteBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the replication configuration from the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:PutReplicationConfiguration action. The bucket owner has these - * permissions by default and can grant it to others. For more information about permissions, - * see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- * - *

It can take a while for the deletion of a replication configuration to fully - * propagate.

- * - *

For information about replication configuration, see Replication in the - * Amazon S3 User Guide.

- *

The following operations are related to DeleteBucketReplication:

- * + * @see {@link DeleteBucketReplicationCommand} */ - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( - args: DeleteBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the tags from the bucket.

- *

To use this operation, you must have permission to perform the - * s3:PutBucketTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

The following operations are related to DeleteBucketTagging:

- * + * @see {@link DeleteBucketTaggingCommand} */ - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( - args: DeleteBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action removes the website configuration for a bucket. Amazon S3 returns a 200 - * OK response upon successfully deleting a website configuration on the specified - * bucket. You will get a 200 OK response if the website configuration you are - * trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if - * the bucket specified in the request does not exist.

- *

This DELETE action requires the S3:DeleteBucketWebsite permission. By - * default, only the bucket owner can delete the website configuration attached to a bucket. - * However, bucket owners can grant other users permission to delete the website configuration - * by writing a bucket policy granting them the S3:DeleteBucketWebsite - * permission.

- *

For more information about hosting websites, see Hosting Websites on Amazon S3.

- *

The following operations are related to DeleteBucketWebsite:

- * + * @see {@link DeleteBucketWebsiteCommand} */ - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, cb: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void ): void; - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void ): void; - public deleteBucketWebsite( - args: DeleteBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the null version (if there is one) of an object and inserts a delete marker, - * which becomes the latest version of the object. If there isn't a null version, Amazon S3 does - * not remove any objects but will still respond that the command was successful.

- *

To remove a specific version, you must use the version Id subresource. Using this - * subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 - * sets the response header, x-amz-delete-marker, to true.

- *

If the object you want to delete is in a bucket where the bucket versioning - * configuration is MFA Delete enabled, you must include the x-amz-mfa request - * header in the DELETE versionId request. Requests that include - * x-amz-mfa must use HTTPS.

- *

For more information about MFA Delete, see Using MFA Delete. To see sample - * requests that use versioning, see Sample - * Request.

- *

You can delete objects by explicitly calling DELETE Object or configure its lifecycle - * (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block - * users or accounts from removing or deleting objects from your bucket, you must deny them - * the s3:DeleteObject, s3:DeleteObjectVersion, and - * s3:PutLifeCycleConfiguration actions.

- *

The following action is related to DeleteObject:

- * + * @see {@link DeleteObjectCommand} */ - public deleteObject( - args: DeleteObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; - public deleteObject( + deleteObject(args: DeleteObjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; + deleteObject( args: DeleteObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectCommandOutput) => void ): void; - public deleteObject( - args: DeleteObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action enables you to delete multiple objects from a bucket using a single HTTP - * request. If you know the object keys that you want to delete, then this action provides a - * suitable alternative to sending individual delete requests, reducing per-request - * overhead.

- *

The request contains a list of up to 1000 keys that you want to delete. In the XML, you - * provide the object key names, and optionally, version IDs if you want to delete a specific - * version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a - * delete action and returns the result of that delete, success, or failure, in the response. - * Note that if the object specified in the request is not found, Amazon S3 returns the result as - * deleted.

- *

The action supports two modes for the response: verbose and quiet. By default, the - * action uses verbose mode in which the response includes the result of deletion of each key - * in your request. In quiet mode the response includes only keys where the delete action - * encountered an error. For a successful deletion, the action does not return any information - * about the delete in the response body.

- *

When performing this action on an MFA Delete enabled bucket, that attempts to delete any - * versioned objects, you must include an MFA token. If you do not provide one, the entire - * request will fail, even if there are non-versioned objects you are trying to delete. If you - * provide an invalid token, whether there are versioned keys in the request or not, the - * entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA - * Delete.

- *

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in - * transit.

- *

The following operations are related to DeleteObjects:

- * + * @see {@link DeleteObjectsCommand} */ - public deleteObjects( - args: DeleteObjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObjects( - args: DeleteObjectsCommandInput, - cb: (err: any, data?: DeleteObjectsCommandOutput) => void - ): void; - public deleteObjects( + deleteObjects(args: DeleteObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObjects(args: DeleteObjectsCommandInput, cb: (err: any, data?: DeleteObjectsCommandOutput) => void): void; + deleteObjects( args: DeleteObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectsCommandOutput) => void ): void; - public deleteObjects( - args: DeleteObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectsCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectsCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the entire tag set from the specified object. For more information about - * managing object tags, see Object Tagging.

- *

To use this operation, you must have permission to perform the - * s3:DeleteObjectTagging action.

- *

To delete tags of a specific object version, add the versionId query - * parameter in the request. You will need permission for the - * s3:DeleteObjectVersionTagging action.

- *

The following operations are related to DeleteObjectTagging:

- * + * @see {@link DeleteObjectTaggingCommand} */ - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, cb: (err: any, data?: DeleteObjectTaggingCommandOutput) => void ): void; - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectTaggingCommandOutput) => void ): void; - public deleteObjectTagging( - args: DeleteObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketPublicAccessBlock permission. For - * more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The following operations are related to DeletePublicAccessBlock:

- * + * @see {@link DeletePublicAccessBlockCommand} */ - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( - args: DeletePublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new DeletePublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action uses the accelerate subresource to - * return the Transfer Acceleration state of a bucket, which is either Enabled or - * Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that - * enables you to perform faster data transfers to and from Amazon S3.

- *

To use this operation, you must have permission to perform the - * s3:GetAccelerateConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

You set the Transfer Acceleration state of an existing bucket to Enabled or - * Suspended by using the PutBucketAccelerateConfiguration operation.

- *

A GET accelerate request does not return a state value for a bucket that - * has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state - * has never been set on the bucket.

- *

For more information about transfer acceleration, see Transfer Acceleration in - * the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link GetBucketAccelerateConfigurationCommand} */ - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, cb: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void ): void; - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void ): void; - public getBucketAccelerateConfiguration( - args: GetBucketAccelerateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketAccelerateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action uses the acl subresource - * to return the access control list (ACL) of a bucket. To use GET to return the - * ACL of the bucket, you must have READ_ACP access to the bucket. If - * READ_ACP permission is granted to the anonymous user, you can return the - * ACL of the bucket without using an authorization header.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, - * requests to read ACLs are still supported and return the - * bucket-owner-full-control ACL with the owner being the account that - * created the bucket. For more information, see Controlling object - * ownership and disabling ACLs in the - * Amazon S3 User Guide.

- * - *

- * Related Resources - *

- * + * @see {@link GetBucketAclCommand} */ - public getBucketAcl( - args: GetBucketAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBucketAcl(args: GetBucketAclCommandInput, cb: (err: any, data?: GetBucketAclCommandOutput) => void): void; - public getBucketAcl( + getBucketAcl(args: GetBucketAclCommandInput, options?: __HttpHandlerOptions): Promise; + getBucketAcl(args: GetBucketAclCommandInput, cb: (err: any, data?: GetBucketAclCommandOutput) => void): void; + getBucketAcl( args: GetBucketAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAclCommandOutput) => void ): void; - public getBucketAcl( - args: GetBucketAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAclCommandOutput) => void), - cb?: (err: any, data?: GetBucketAclCommandOutput) => void - ): Promise | void { - const command = new GetBucketAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action returns an analytics configuration (identified by - * the analytics configuration ID) from the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:GetAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis in the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link GetBucketAnalyticsConfigurationCommand} */ - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void ): void; - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void ): void; - public getBucketAnalyticsConfiguration( - args: GetBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the - * bucket.

- *

To use this operation, you must have permission to perform the - * s3:GetBucketCORS action. By default, the bucket owner has this permission - * and can grant it to others.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about CORS, see Enabling Cross-Origin Resource - * Sharing.

- *

The following operations are related to GetBucketCors:

- * + * @see {@link GetBucketCorsCommand} */ - public getBucketCors( - args: GetBucketCorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBucketCors( - args: GetBucketCorsCommandInput, - cb: (err: any, data?: GetBucketCorsCommandOutput) => void - ): void; - public getBucketCors( + getBucketCors(args: GetBucketCorsCommandInput, options?: __HttpHandlerOptions): Promise; + getBucketCors(args: GetBucketCorsCommandInput, cb: (err: any, data?: GetBucketCorsCommandOutput) => void): void; + getBucketCors( args: GetBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketCorsCommandOutput) => void ): void; - public getBucketCors( - args: GetBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketCorsCommandOutput) => void), - cb?: (err: any, data?: GetBucketCorsCommandOutput) => void - ): Promise | void { - const command = new GetBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that - * uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information - * about the bucket default encryption feature, see Amazon S3 Bucket - * Default Encryption in the Amazon S3 User Guide.

- *

To use this operation, you must have permission to perform the - * s3:GetEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The following operations are related to GetBucketEncryption:

- * + * @see {@link GetBucketEncryptionCommand} */ - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, cb: (err: any, data?: GetBucketEncryptionCommandOutput) => void ): void; - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketEncryptionCommandOutput) => void ): void; - public getBucketEncryption( - args: GetBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: GetBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new GetBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to GetBucketIntelligentTieringConfiguration include:

- * + * @see {@link GetBucketIntelligentTieringConfigurationCommand} */ - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public getBucketIntelligentTieringConfiguration( - args: GetBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an inventory configuration (identified by the inventory configuration ID) from - * the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:GetInventoryConfiguration action. The bucket owner has this permission - * by default and can grant this permission to others. For more information about permissions, - * see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

- *

The following operations are related to - * GetBucketInventoryConfiguration:

- * + * @see {@link GetBucketInventoryConfigurationCommand} */ - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, cb: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void ): void; - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void ): void; - public getBucketInventoryConfiguration( - args: GetBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

Bucket lifecycle configuration now supports specifying a lifecycle rule using an - * object key name prefix, one or more object tags, or a combination of both. Accordingly, - * this section describes the latest API. The response describes the new filter element - * that you can use to specify a filter to select a subset of objects to which the rule - * applies. If you are using a previous version of the lifecycle configuration, it still - * works. For the earlier action, see GetBucketLifecycle.

- * - *

Returns the lifecycle configuration information set on the bucket. For information about - * lifecycle configuration, see Object Lifecycle - * Management.

- *

To use this operation, you must have permission to perform the - * s3:GetLifecycleConfiguration action. The bucket owner has this permission, - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * GetBucketLifecycleConfiguration has the following special error:

- *
    - *
  • - *

    Error code: NoSuchLifecycleConfiguration - *

    - *
      - *
    • - *

      Description: The lifecycle configuration does not exist.

      - *
      • - *
    • - *

      HTTP Status Code: 404 Not Found

      - *
      • - *
    • - *

      SOAP Fault Code Prefix: Client

      - *
      • - *
    - *
    • - *
- *

The following operations are related to - * GetBucketLifecycleConfiguration:

- * + * @see {@link GetBucketLifecycleConfigurationCommand} */ - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( - args: GetBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Region the bucket resides in. You set the bucket's Region using the - * LocationConstraint request parameter in a CreateBucket - * request. For more information, see CreateBucket.

- *

To use this implementation of the operation, you must be the bucket owner.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- * - *

For requests made using Amazon Web Services Signature Version 4 (SigV4), we recommend that you use - * HeadBucket to return the bucket Region instead of GetBucketLocation.

- * - *

The following operations are related to GetBucketLocation:

- * + * @see {@link GetBucketLocationCommand} */ - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, cb: (err: any, data?: GetBucketLocationCommandOutput) => void ): void; - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLocationCommandOutput) => void ): void; - public getBucketLocation( - args: GetBucketLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLocationCommandOutput) => void), - cb?: (err: any, data?: GetBucketLocationCommandOutput) => void - ): Promise | void { - const command = new GetBucketLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the logging status of a bucket and the permissions users have to view and modify - * that status.

- *

The following operations are related to GetBucketLogging:

- * + * @see {@link GetBucketLoggingCommand} */ - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, cb: (err: any, data?: GetBucketLoggingCommandOutput) => void ): void; - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLoggingCommandOutput) => void ): void; - public getBucketLogging( - args: GetBucketLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLoggingCommandOutput) => void), - cb?: (err: any, data?: GetBucketLoggingCommandOutput) => void - ): Promise | void { - const command = new GetBucketLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a metrics configuration (specified by the metrics configuration ID) from the - * bucket. Note that this doesn't include the daily storage metrics.

- *

To use this operation, you must have permissions to perform the - * s3:GetMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring - * Metrics with Amazon CloudWatch.

- *

The following operations are related to - * GetBucketMetricsConfiguration:

- * + * @see {@link GetBucketMetricsConfigurationCommand} */ - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, cb: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void ): void; - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void ): void; - public getBucketMetricsConfiguration( - args: GetBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the notification configuration of a bucket.

- *

If notifications are not enabled on the bucket, the action returns an empty - * NotificationConfiguration element.

- *

By default, you must be the bucket owner to read the notification configuration of a - * bucket. However, the bucket owner can use a bucket policy to grant permission to other - * users to read this configuration with the s3:GetBucketNotification - * permission.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about setting and reading the notification configuration on a - * bucket, see Setting Up Notification of Bucket Events. For more information about bucket - * policies, see Using Bucket Policies.

- *

The following action is related to GetBucketNotification:

- * + * @see {@link GetBucketNotificationConfigurationCommand} */ - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, cb: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void ): void; - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void ): void; - public getBucketNotificationConfiguration( - args: GetBucketNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:GetBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying permissions in a - * policy.

- *

For information about Amazon S3 Object Ownership, see Using Object - * Ownership.

- *

The following operations are related to GetBucketOwnershipControls:

- * + * @see {@link GetBucketOwnershipControlsCommand} */ - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, cb: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void ): void; - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void ): void; - public getBucketOwnershipControls( - args: GetBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new GetBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the policy of a specified bucket. If you are using an identity other than the - * root user of the Amazon Web Services account that owns the bucket, the calling identity must have the - * GetBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account in order to use this operation.

- *

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- * - *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about bucket policies, see Using Bucket Policies and User - * Policies.

- *

The following action is related to GetBucketPolicy:

- * + * @see {@link GetBucketPolicyCommand} */ - public getBucketPolicy( + getBucketPolicy( args: GetBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - cb: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): void; - public getBucketPolicy( + getBucketPolicy(args: GetBucketPolicyCommandInput, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void): void; + getBucketPolicy( args: GetBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void ): void; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new GetBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. - * In order to use this operation, you must have the s3:GetBucketPolicyStatus - * permission. For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- *

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

- *

The following operations are related to GetBucketPolicyStatus:

- * + * @see {@link GetBucketPolicyStatusCommand} */ - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, cb: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void ): void; - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void ): void; - public getBucketPolicyStatus( - args: GetBucketPolicyStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketPolicyStatusCommandOutput) => void), - cb?: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void - ): Promise | void { - const command = new GetBucketPolicyStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the replication configuration of a bucket.

- * - *

It can take a while to propagate the put or delete a replication configuration to - * all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong - * result.

- * - *

For information about replication configuration, see Replication in the - * Amazon S3 User Guide.

- *

This action requires permissions for the s3:GetReplicationConfiguration - * action. For more information about permissions, see Using Bucket Policies and User - * Policies.

- *

If you include the Filter element in a replication configuration, you must - * also include the DeleteMarkerReplication and Priority elements. - * The response also returns those elements.

- *

For information about GetBucketReplication errors, see List of - * replication-related error codes - *

- *

The following operations are related to GetBucketReplication:

- * + * @see {@link GetBucketReplicationCommand} */ - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( - args: GetBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: GetBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new GetBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the request payment configuration of a bucket. To use this version of the - * operation, you must be the bucket owner. For more information, see Requester Pays - * Buckets.

- *

The following operations are related to GetBucketRequestPayment:

- * + * @see {@link GetBucketRequestPaymentCommand} */ - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, cb: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void ): void; - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void ): void; - public getBucketRequestPayment( - args: GetBucketRequestPaymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketRequestPaymentCommandOutput) => void), - cb?: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void - ): Promise | void { - const command = new GetBucketRequestPaymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tag set associated with the bucket.

- *

To use this operation, you must have permission to perform the - * s3:GetBucketTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

- * GetBucketTagging has the following special error:

- *
    - *
  • - *

    Error code: NoSuchTagSet - *

    - *
      - *
    • - *

      Description: There is no tag set associated with the bucket.

      - *
      • - *
    - *
    • - *
- *

The following operations are related to GetBucketTagging:

- * + * @see {@link GetBucketTaggingCommand} */ - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( - args: GetBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: GetBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new GetBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the versioning state of a bucket.

- *

To retrieve the versioning state of a bucket, you must be the bucket owner.

- *

This implementation also returns the MFA Delete status of the versioning state. If the - * MFA Delete status is enabled, the bucket owner must use an authentication - * device to change the versioning state of the bucket.

- *

The following operations are related to GetBucketVersioning:

- * + * @see {@link GetBucketVersioningCommand} */ - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( - args: GetBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: GetBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new GetBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the website configuration for a bucket. To host website on Amazon S3, you can - * configure a bucket as website by adding a website configuration. For more information about - * hosting websites, see Hosting Websites on Amazon S3.

- *

This GET action requires the S3:GetBucketWebsite permission. By default, - * only the bucket owner can read the bucket website configuration. However, bucket owners can - * allow other users to read the website configuration by writing a bucket policy granting - * them the S3:GetBucketWebsite permission.

- *

The following operations are related to DeleteBucketWebsite:

- * + * @see {@link GetBucketWebsiteCommand} */ - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, cb: (err: any, data?: GetBucketWebsiteCommandOutput) => void ): void; - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketWebsiteCommandOutput) => void ): void; - public getBucketWebsite( - args: GetBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: GetBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new GetBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

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.

- *

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 - * InvalidObjectState 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 KMS keys - * (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.

- * - *
    - *
  • - *

    If you supply a versionId, you need the - * s3:GetObjectVersion permission to access a specific version of an - * object. If you request a specific version, you do not need to have the - * s3:GetObject permission. If you request the current version - * without a specific version ID, only s3:GetObject permission is - * required. s3:GetObjectVersion permission won't be required.

    - *
    • - *
  • - *

    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:

- * + * @see {@link GetObjectCommand} */ - public getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; - public getObject( + getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; + getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; + getObject( args: GetObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectCommandOutput) => void ): void; - public getObject( - args: GetObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectCommandOutput) => void), - cb?: (err: any, data?: GetObjectCommandOutput) => void - ): Promise | void { - const command = new GetObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the access control list (ACL) of an object. To use this operation, you must have - * s3:GetObjectAcl permissions or READ_ACP access to the object. - * For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 - * User Guide - *

- *

This action is not supported by Amazon S3 on Outposts.

- *

- * Versioning - *

- *

By default, GET returns ACL information about the current version of an object. To - * return ACL information about a different version, use the versionId subresource.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, - * requests to read ACLs are still supported and return the - * bucket-owner-full-control ACL with the owner being the account that - * created the bucket. For more information, see Controlling object - * ownership and disabling ACLs in the - * Amazon S3 User Guide.

- * - *

The following operations are related to GetObjectAcl:

- * + * @see {@link GetObjectAclCommand} */ - public getObjectAcl( - args: GetObjectAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getObjectAcl(args: GetObjectAclCommandInput, cb: (err: any, data?: GetObjectAclCommandOutput) => void): void; - public getObjectAcl( + getObjectAcl(args: GetObjectAclCommandInput, options?: __HttpHandlerOptions): Promise; + getObjectAcl(args: GetObjectAclCommandInput, cb: (err: any, data?: GetObjectAclCommandOutput) => void): void; + getObjectAcl( args: GetObjectAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectAclCommandOutput) => void ): void; - public getObjectAcl( - args: GetObjectAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectAclCommandOutput) => void), - cb?: (err: any, data?: GetObjectAclCommandOutput) => void - ): Promise | void { - const command = new GetObjectAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all the metadata from an object without returning the object itself. This - * action is useful if you're interested only in an object's metadata. To use - * GetObjectAttributes, you must have READ access to the object.

- *

- * GetObjectAttributes combines the functionality of HeadObject - * and ListParts. All of the data returned with each of those individual calls - * can be returned with a single call to GetObjectAttributes.

- *

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) in the - * Amazon S3 User Guide.

- * - *
    - *
  • - *

    Encryption request headers, such as x-amz-server-side-encryption, - * should not be sent for GET requests if your object uses server-side encryption - * with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or - * server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use - * these types of keys, you'll get an HTTP 400 Bad Request error.

    - *
    • - *
  • - *

    The last modified property in this case is the creation date of the - * object.

    - *
    • - *
- * - *

Consider the following when using request headers:

- *
    - *
  • - *

    If both of the If-Match and If-Unmodified-Since headers - * are present in the request as follows, then Amazon S3 returns the HTTP status code - * 200 OK and the data requested:

    - *
      - *
    • - *

      - * If-Match condition evaluates to true.

      - *
      • - *
    • - *

      - * If-Unmodified-Since condition evaluates to - * false.

      - *
      • - *
    - *
    • - *
  • - *

    If both of the If-None-Match and If-Modified-Since - * headers are present in the request as follows, then Amazon S3 returns the HTTP status code - * 304 Not Modified:

    - *
      - *
    • - *

      - * If-None-Match condition evaluates to false.

      - *
      • - *
    • - *

      - * If-Modified-Since condition evaluates to - * true.

      - *
      • - *
    - *
    • - *
- *

For more information about conditional requests, see RFC 7232.

- *

- * Permissions - *

- *

The permissions that you need to use this operation depend on whether the bucket is - * versioned. If the bucket is versioned, you need both the s3:GetObjectVersion - * and s3:GetObjectVersionAttributes permissions for this operation. If the - * bucket is not versioned, you need the s3:GetObject and - * s3:GetObjectAttributes permissions. For more information, see Specifying - * Permissions in a Policy in the Amazon S3 User Guide. If the - * object that 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 Not Found ("no such key") error.

    - *
    • - *
  • - *

    If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP - * status code 403 Forbidden ("access denied") error.

    - *
    • - *
- *

The following actions are related to GetObjectAttributes:

- * + * @see {@link GetObjectAttributesCommand} */ - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( - args: GetObjectAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectAttributesCommandOutput) => void), - cb?: (err: any, data?: GetObjectAttributesCommandOutput) => void - ): Promise | void { - const command = new GetObjectAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an object's current legal hold status. For more information, see Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectLegalHold:

- * + * @see {@link GetObjectLegalHoldCommand} */ - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, cb: (err: any, data?: GetObjectLegalHoldCommandOutput) => void ): void; - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectLegalHoldCommandOutput) => void ): void; - public getObjectLegalHold( - args: GetObjectLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectLegalHoldCommandOutput) => void), - cb?: (err: any, data?: GetObjectLegalHoldCommandOutput) => void - ): Promise | void { - const command = new GetObjectLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock - * configuration will be applied by default to every new object placed in the specified - * bucket. For more information, see Locking Objects.

- *

The following action is related to GetObjectLockConfiguration:

- * + * @see {@link GetObjectLockConfigurationCommand} */ - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, cb: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void ): void; - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void ): void; - public getObjectLockConfiguration( - args: GetObjectLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetObjectLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an object's retention settings. For more information, see Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectRetention:

- * + * @see {@link GetObjectRetentionCommand} */ - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, cb: (err: any, data?: GetObjectRetentionCommandOutput) => void ): void; - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectRetentionCommandOutput) => void ): void; - public getObjectRetention( - args: GetObjectRetentionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectRetentionCommandOutput) => void), - cb?: (err: any, data?: GetObjectRetentionCommandOutput) => void - ): Promise | void { - const command = new GetObjectRetentionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tag-set of an object. You send the GET request against the tagging - * subresource associated with the object.

- *

To use this operation, you must have permission to perform the - * s3:GetObjectTagging action. By default, the GET action returns information - * about current version of an object. For a versioned bucket, you can have multiple versions - * of an object in your bucket. To retrieve tags of any other version, use the versionId query - * parameter. You also need permission for the s3:GetObjectVersionTagging - * action.

- *

By default, the bucket owner has this permission and can grant this permission to - * others.

- *

For information about the Amazon S3 object tagging feature, see Object Tagging.

- *

The following actions are related to GetObjectTagging:

- * + * @see {@link GetObjectTaggingCommand} */ - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, cb: (err: any, data?: GetObjectTaggingCommandOutput) => void ): void; - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectTaggingCommandOutput) => void ): void; - public getObjectTagging( - args: GetObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: GetObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new GetObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - * distributing large files.

- * - *

You can get torrent only for objects that are less than 5 GB in size, and that are - * not encrypted using server-side encryption with a customer-provided encryption - * key.

- * - *

To use GET, you must have READ access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectTorrent:

- * + * @see {@link GetObjectTorrentCommand} */ - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, cb: (err: any, data?: GetObjectTorrentCommandOutput) => void ): void; - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectTorrentCommandOutput) => void ): void; - public getObjectTorrent( - args: GetObjectTorrentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectTorrentCommandOutput) => void), - cb?: (err: any, data?: GetObjectTorrentCommandOutput) => void - ): Promise | void { - const command = new GetObjectTorrentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use - * this operation, you must have the s3:GetBucketPublicAccessBlock permission. - * For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- * - *

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or - * an object, it checks the PublicAccessBlock configuration for both the - * bucket (or the bucket that contains the object) and the bucket owner's account. If the - * PublicAccessBlock settings are different between the bucket and the - * account, Amazon S3 uses the most restrictive combination of the bucket-level and - * account-level settings.

- * - *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

- *

The following operations are related to GetPublicAccessBlock:

- * + * @see {@link GetPublicAccessBlockCommand} */ - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( - args: GetPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: GetPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new GetPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action is useful to determine if a bucket exists and you have permission to access - * it. The action returns a 200 OK if the bucket exists and you have permission - * to access it.

- *

If the bucket does not exist or you do not have permission to access it, the - * HEAD request returns a generic 400 Bad Request, 403 - * Forbidden or 404 Not Found code. A message body is not included, so - * you cannot determine the exception beyond these error codes.

- *

To use this operation, you must have permissions to perform the - * s3:ListBucket action. The bucket owner has this permission by default and - * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

To use this API against an access point, you must provide the alias of the access point in place of the - * bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to - * the access point hostname. The access point hostname takes the form - * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, - * you provide the ARN in place of the bucket name. For more information see, Using - * access points.

+ * @see {@link HeadBucketCommand} */ - public headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise; - public headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void; - public headBucket( + headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise; + headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void; + headBucket( args: HeadBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HeadBucketCommandOutput) => void ): void; - public headBucket( - args: HeadBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HeadBucketCommandOutput) => void), - cb?: (err: any, data?: HeadBucketCommandOutput) => void - ): Promise | void { - const command = new HeadBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

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 400 Bad Request, 403 Forbidden or 404 Not - * Found 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 KMS keys (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 actions are related to HeadObject:

- * + * @see {@link HeadObjectCommand} */ - public headObject(args: HeadObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public headObject(args: HeadObjectCommandInput, cb: (err: any, data?: HeadObjectCommandOutput) => void): void; - public headObject( + headObject(args: HeadObjectCommandInput, options?: __HttpHandlerOptions): Promise; + headObject(args: HeadObjectCommandInput, cb: (err: any, data?: HeadObjectCommandOutput) => void): void; + headObject( args: HeadObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HeadObjectCommandOutput) => void ): void; - public headObject( - args: HeadObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HeadObjectCommandOutput) => void), - cb?: (err: any, data?: HeadObjectCommandOutput) => void - ): Promise | void { - const command = new HeadObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - * configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. You should always check the IsTruncated element in the response. If - * there are no more configurations to list, IsTruncated is set to false. If - * there are more configurations to list, IsTruncated is set to true, and there - * will be a value in NextContinuationToken. You use the - * NextContinuationToken value to continue the pagination of the list by - * passing the value in continuation-token in the request to GET the next - * page.

- *

To use this operation, you must have permissions to perform the - * s3:GetAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis.

- *

The following operations are related to - * ListBucketAnalyticsConfigurations:

- * + * @see {@link ListBucketAnalyticsConfigurationsCommand} */ - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, cb: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void ): void; - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void ): void; - public listBucketAnalyticsConfigurations( - args: ListBucketAnalyticsConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketAnalyticsConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to ListBucketIntelligentTieringConfigurations include:

- * + * @see {@link ListBucketIntelligentTieringConfigurationsCommand} */ - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, cb: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void ): void; - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void ): void; - public listBucketIntelligentTieringConfigurations( - args: ListBucketIntelligentTieringConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketIntelligentTieringConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of inventory configurations for the bucket. You can have up to 1,000 - * analytics configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. Always check the IsTruncated element in the response. If there are no - * more configurations to list, IsTruncated is set to false. If there are more - * configurations to list, IsTruncated is set to true, and there is a value in - * NextContinuationToken. You use the NextContinuationToken value - * to continue the pagination of the list by passing the value in continuation-token in the - * request to GET the next page.

- *

To use this operation, you must have permissions to perform the - * s3:GetInventoryConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory - *

- *

The following operations are related to - * ListBucketInventoryConfigurations:

- * + * @see {@link ListBucketInventoryConfigurationsCommand} */ - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, cb: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void ): void; - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void ): void; - public listBucketInventoryConfigurations( - args: ListBucketInventoryConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketInventoryConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the metrics configurations for the bucket. The metrics configurations are only for - * the request metrics of the bucket and do not provide information on daily storage metrics. - * You can have up to 1,000 configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. Always check the IsTruncated element in the response. If there are no - * more configurations to list, IsTruncated is set to false. If there are more - * configurations to list, IsTruncated is set to true, and there is a value in - * NextContinuationToken. You use the NextContinuationToken value - * to continue the pagination of the list by passing the value in - * continuation-token in the request to GET the next page.

- *

To use this operation, you must have permissions to perform the - * s3:GetMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For more information about metrics configurations and CloudWatch request metrics, see - * Monitoring Metrics with Amazon CloudWatch.

- *

The following operations are related to - * ListBucketMetricsConfigurations:

- * + * @see {@link ListBucketMetricsConfigurationsCommand} */ - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, cb: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void ): void; - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void ): void; - public listBucketMetricsConfigurations( - args: ListBucketMetricsConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketMetricsConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all buckets owned by the authenticated sender of the request. To use - * this operation, you must have the s3:ListAllMyBuckets permission.

- *

For information about Amazon S3 buckets, see Creating, configuring, and - * working with Amazon S3 buckets.

+ * @see {@link ListBucketsCommand} */ - public listBuckets(args: ListBucketsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBuckets(args: ListBucketsCommandInput, cb: (err: any, data?: ListBucketsCommandOutput) => void): void; - public listBuckets( + listBuckets(args: ListBucketsCommandInput, options?: __HttpHandlerOptions): Promise; + listBuckets(args: ListBucketsCommandInput, cb: (err: any, data?: ListBucketsCommandOutput) => void): void; + listBuckets( args: ListBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketsCommandOutput) => void ): void; - public listBuckets( - args: ListBucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketsCommandOutput) => void), - cb?: (err: any, data?: ListBucketsCommandOutput) => void - ): Promise | void { - const command = new ListBucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action lists in-progress multipart uploads. An in-progress multipart upload is a - * multipart upload that has been initiated using the Initiate Multipart Upload request, but - * has not yet been completed or aborted.

- *

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - * uploads is the maximum number of uploads a response can include, which is also the default - * value. You can further limit the number of uploads in a response by specifying the - * max-uploads parameter in the response. If additional multipart uploads - * satisfy the list criteria, the response will contain an IsTruncated element - * with the value true. To list the additional multipart uploads, use the - * key-marker and upload-id-marker request parameters.

- *

In the response, the uploads are sorted by key. If your application has initiated more - * than one multipart upload using the same object key, then uploads in the response are first - * sorted by key. Additionally, uploads are sorted in ascending order within each key by the - * upload initiation time.

- *

For more information on multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information on permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

The following operations are related to ListMultipartUploads:

- * + * @see {@link ListMultipartUploadsCommand} */ - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( - args: ListMultipartUploadsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultipartUploadsCommandOutput) => void), - cb?: (err: any, data?: ListMultipartUploadsCommandOutput) => void - ): Promise | void { - const command = new ListMultipartUploadsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - * parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK - * response can contain valid or invalid XML. Be sure to design your application to parse the - * contents of the response and handle it appropriately.

- * - *

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, - * Amazon S3 continues to support ListObjects.

- * - *

The following operations are related to ListObjects:

- * + * @see {@link ListObjectsCommand} */ - public listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; - public listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; - public listObjects( + listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; + listObjects( args: ListObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsCommandOutput) => void ): void; - public listObjects( - args: ListObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectsCommandOutput) => void), - cb?: (err: any, data?: ListObjectsCommandOutput) => void - ): Promise | void { - const command = new ListObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can - * use the request parameters as selection criteria to return a subset of the objects in a - * bucket. A 200 OK response can contain valid or invalid XML. Make sure to - * design your application to parse the contents of the response and handle it appropriately. - * Objects are returned sorted in an ascending order of the respective key names in the list. - * For more information about listing objects, see Listing object keys - * programmatically - *

- *

To use this operation, you must have READ access to the bucket.

- *

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform - * the s3:ListBucket action. The bucket owner has this permission by default and - * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- * - *

This section describes the latest revision of this action. We recommend that you use - * this revised API for application development. For backward compatibility, Amazon S3 continues - * to support the prior version of this API, ListObjects.

- * - *

To get a list of your buckets, see ListBuckets.

- *

The following operations are related to ListObjectsV2:

- * + * @see {@link ListObjectsV2Command} */ - public listObjectsV2( - args: ListObjectsV2CommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listObjectsV2( - args: ListObjectsV2CommandInput, - cb: (err: any, data?: ListObjectsV2CommandOutput) => void - ): void; - public listObjectsV2( + listObjectsV2(args: ListObjectsV2CommandInput, options?: __HttpHandlerOptions): Promise; + listObjectsV2(args: ListObjectsV2CommandInput, cb: (err: any, data?: ListObjectsV2CommandOutput) => void): void; + listObjectsV2( args: ListObjectsV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsV2CommandOutput) => void ): void; - public listObjectsV2( - args: ListObjectsV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectsV2CommandOutput) => void), - cb?: (err: any, data?: ListObjectsV2CommandOutput) => void - ): Promise | void { - const command = new ListObjectsV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about all versions of the objects in a bucket. You can also use request - * parameters as selection criteria to return metadata about a subset of all the object - * versions.

- * - *

To use this operation, you must have permissions to perform the - * s3:ListBucketVersions action. Be aware of the name difference.

- * - * - *

A 200 OK response can contain valid or invalid XML. Make sure to design your - * application to parse the contents of the response and handle it appropriately.

- * - *

To use this operation, you must have READ access to the bucket.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following operations are related to ListObjectVersions:

- * + * @see {@link ListObjectVersionsCommand} */ - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, cb: (err: any, data?: ListObjectVersionsCommandOutput) => void ): void; - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectVersionsCommandOutput) => void ): void; - public listObjectVersions( - args: ListObjectVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectVersionsCommandOutput) => void), - cb?: (err: any, data?: ListObjectVersionsCommandOutput) => void - ): Promise | void { - const command = new ListObjectVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the parts that have been uploaded for a specific multipart upload. This operation - * must include the upload ID, which you obtain by sending the initiate multipart upload - * request (see CreateMultipartUpload). - * This request returns a maximum of 1,000 uploaded parts. The default number of parts - * returned is 1,000 parts. You can restrict the number of parts returned by specifying the - * max-parts request parameter. If your multipart upload consists of more than - * 1,000 parts, the response returns an IsTruncated field with the value of true, - * and a NextPartNumberMarker element. In subsequent ListParts - * requests you can include the part-number-marker query string parameter and set its value to - * the NextPartNumberMarker field value from the previous response.

- *

If the upload was created using a checksum algorithm, you will need to have permission - * to the kms:Decrypt action for the request to succeed.

- *

For more information on multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information on permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

The following operations are related to ListParts:

- * + * @see {@link ListPartsCommand} */ - public listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; - public listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; - public listParts( + listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; + listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; + listParts( args: ListPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartsCommandOutput) => void ): void; - public listParts( - args: ListPartsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartsCommandOutput) => void), - cb?: (err: any, data?: ListPartsCommandOutput) => void - ): Promise | void { - const command = new ListPartsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a - * bucket-level feature that enables you to perform faster data transfers to Amazon S3.

- *

To use this operation, you must have permission to perform the - * s3:PutAccelerateConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The Transfer Acceleration state of a bucket can be set to one of the following two - * values:

- *
    - *
  • - *

    Enabled – Enables accelerated data transfers to the bucket.

    - *
    • - *
  • - *

    Suspended – Disables accelerated data transfers to the bucket.

    - *
    • - *
- *

The GetBucketAccelerateConfiguration action returns the transfer acceleration state - * of a bucket.

- *

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up - * to thirty minutes before the data transfer rates to the bucket increase.

- *

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - * not contain periods (".").

- *

For more information about transfer acceleration, see Transfer - * Acceleration.

- *

The following operations are related to - * PutBucketAccelerateConfiguration:

- * + * @see {@link PutBucketAccelerateConfigurationCommand} */ - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, cb: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void ): void; - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void ): void; - public putBucketAccelerateConfiguration( - args: PutBucketAccelerateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketAccelerateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the permissions on an existing bucket using access control lists (ACL). For more - * information, see Using ACLs. To set the ACL of a - * bucket, you must have WRITE_ACP permission.

- *

You can use one of the following two ways to set a bucket's permissions:

- *
    - *
  • - *

    Specify the ACL in the request body

    - *
    • - *
  • - *

    Specify permissions using request headers

    - *
    • - *
- * - *

You cannot specify access permission using both the body and the request - * headers.

- * - *

Depending on your application needs, you may choose to set the ACL on a bucket using - * either the request body or the headers. For example, if you have an existing application - * that updates a bucket ACL using the request body, then you can continue to use that - * approach.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs - * are disabled and no longer affect permissions. You must use policies to grant access to - * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return - * the AccessControlListNotSupported error code. Requests to read ACLs are - * still supported. For more information, see Controlling object - * ownership in the Amazon S3 User Guide.

- * - *

- * Access Permissions - *

- *

You can set access permissions using one of the following methods:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports - * a set of predefined ACLs, known as canned ACLs. Each canned ACL - * has a predefined set of grantees and permissions. Specify the canned ACL name as the - * value of x-amz-acl. If you use this header, you cannot use other access - * control-specific headers in your request. For more information, see Canned - * ACL.

    - *
    • - *
  • - *

    Specify access permissions explicitly with the x-amz-grant-read, - * x-amz-grant-read-acp, x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. When using these headers, you - * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who - * will receive the permission. If you use these ACL-specific headers, you cannot use - * the x-amz-acl header to set a canned ACL. These parameters map to the - * set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control - * List (ACL) Overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
      • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
      • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       - *
      • - *
    - *

    For example, the following x-amz-grant-write header grants create, - * overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and - * two Amazon Web Services accounts identified by their email addresses.

    - *

    - * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", - * id="111122223333", id="555566667777" - *

    - *
    • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You cannot do - * both.

- *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request

    - *
    • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
    • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<>& - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - * - *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    - *
      - *
    • - *

      US East (N. Virginia)

      - *
      • - *
    • - *

      US West (N. California)

      - *
      • - *
    • - *

      US West (Oregon)

      - *
      • - *
    • - *

      Asia Pacific (Singapore)

      - *
      • - *
    • - *

      Asia Pacific (Sydney)

      - *
      • - *
    • - *

      Asia Pacific (Tokyo)

      - *
      • - *
    • - *

      Europe (Ireland)

      - *
      • - *
    • - *

      South America (São Paulo)

      - *
      • - *
    - *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    - *     - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketAclCommand} */ - public putBucketAcl( - args: PutBucketAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putBucketAcl(args: PutBucketAclCommandInput, cb: (err: any, data?: PutBucketAclCommandOutput) => void): void; - public putBucketAcl( + putBucketAcl(args: PutBucketAclCommandInput, options?: __HttpHandlerOptions): Promise; + putBucketAcl(args: PutBucketAclCommandInput, cb: (err: any, data?: PutBucketAclCommandOutput) => void): void; + putBucketAcl( args: PutBucketAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAclCommandOutput) => void ): void; - public putBucketAcl( - args: PutBucketAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAclCommandOutput) => void), - cb?: (err: any, data?: PutBucketAclCommandOutput) => void - ): Promise | void { - const command = new PutBucketAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets an analytics configuration for the bucket (specified by the analytics configuration - * ID). You can have up to 1,000 analytics configurations per bucket.

- *

You can choose to have storage class analysis export analysis reports sent to a - * comma-separated values (CSV) flat file. See the DataExport request element. - * Reports are updated daily and are based on the object filters that you configure. When - * selecting data export, you specify a destination bucket and an optional destination prefix - * where the file is written. You can export the data to a destination bucket in a different - * account. However, the destination bucket must be in the same Region as the bucket that you - * are making the PUT analytics configuration to. For more information, see Amazon S3 - * Analytics – Storage Class Analysis.

- * - *

You must create a bucket policy on the destination bucket where the exported file is - * written to grant permissions to Amazon S3 to write objects to the bucket. For an example - * policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

- * - *

To use this operation, you must have permissions to perform the - * s3:PutAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 400 Bad Request - *

      - *
      • - *
    • - *

      - * Code: InvalidArgument - *

      - *
      • - *
    • - *

      - * Cause: Invalid argument. - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 400 Bad Request - *

      - *
      • - *
    • - *

      - * Code: TooManyConfigurations - *

      - *
      • - *
    • - *

      - * Cause: You are attempting to create a new configuration but have - * already reached the 1,000-configuration limit. - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 403 Forbidden - *

      - *
      • - *
    • - *

      - * Code: AccessDenied - *

      - *
      • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, or you do - * not have the s3:PutAnalyticsConfiguration bucket permission to set the - * configuration on the bucket. - *

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketAnalyticsConfigurationCommand} */ - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void ): void; - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void ): void; - public putBucketAnalyticsConfiguration( - args: PutBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the cors configuration for your bucket. If the configuration exists, - * Amazon S3 replaces it.

- *

To use this operation, you must be allowed to perform the s3:PutBucketCORS - * action. By default, the bucket owner has this permission and can grant it to others.

- *

You set this configuration on a bucket so that the bucket can service cross-origin - * requests. For example, you might want to enable a request whose origin is - * http://www.example.com to access your Amazon S3 bucket at - * my.example.bucket.com by using the browser's XMLHttpRequest - * capability.

- *

To enable cross-origin resource sharing (CORS) on a bucket, you add the - * cors subresource to the bucket. The cors subresource is an XML - * document in which you configure rules that identify origins and the HTTP methods that can - * be executed on your bucket. The document is limited to 64 KB in size.

- *

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a - * bucket, it evaluates the cors configuration on the bucket and uses the first - * CORSRule rule that matches the incoming browser request to enable a - * cross-origin request. For a rule to match, the following conditions must be met:

- *
    - *
  • - *

    The request's Origin header must match AllowedOrigin - * elements.

    - *
    • - *
  • - *

    The request method (for example, GET, PUT, HEAD, and so on) or the - * Access-Control-Request-Method header in case of a pre-flight - * OPTIONS request must be one of the AllowedMethod - * elements.

    - *
    • - *
  • - *

    Every header specified in the Access-Control-Request-Headers request - * header of a pre-flight request must match an AllowedHeader element. - *

    - *
    • - *
- *

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in - * the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link PutBucketCorsCommand} */ - public putBucketCors( - args: PutBucketCorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putBucketCors( - args: PutBucketCorsCommandInput, - cb: (err: any, data?: PutBucketCorsCommandOutput) => void - ): void; - public putBucketCors( + putBucketCors(args: PutBucketCorsCommandInput, options?: __HttpHandlerOptions): Promise; + putBucketCors(args: PutBucketCorsCommandInput, cb: (err: any, data?: PutBucketCorsCommandOutput) => void): void; + putBucketCors( args: PutBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketCorsCommandOutput) => void ): void; - public putBucketCors( - args: PutBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketCorsCommandOutput) => void), - cb?: (err: any, data?: PutBucketCorsCommandOutput) => void - ): Promise | void { - const command = new PutBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action uses the encryption subresource to configure default encryption - * and Amazon S3 Bucket Keys for an existing bucket.

- *

By default, all buckets have a default encryption configuration that - * uses server-side encryption with Amazon S3 managed keys (SSE-S3). - * You can optionally configure default encryption for a bucket by using server-side - * encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using - * SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption, - * see Amazon S3 - * bucket default encryption in the Amazon S3 User Guide. For more - * information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the - * Amazon S3 User Guide.

- * - *

This action requires Amazon Web Services Signature Version 4. For more information, see - * Authenticating Requests (Amazon Web Services Signature Version 4).

- * - *

To use this operation, you must have permissions to perform the - * s3:PutEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link PutBucketEncryptionCommand} */ - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, cb: (err: any, data?: PutBucketEncryptionCommandOutput) => void ): void; - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketEncryptionCommandOutput) => void ): void; - public putBucketEncryption( - args: PutBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: PutBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new PutBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to - * 1,000 S3 Intelligent-Tiering configurations per bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to PutBucketIntelligentTieringConfiguration include:

- * - * - *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically - * move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access - * or Deep Archive Access tier.

- * - *

- * Special Errors - *

- *
    - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: InvalidArgument

      - *
      • - *
    • - *

      - * Cause: Invalid Argument

      - *
      • - *
    - *
    • - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: TooManyConfigurations

      - *
      • - *
    • - *

      - * Cause: You are attempting to create a new configuration - * but have already reached the 1,000-configuration limit.

      - *
      • - *
    - *
    • - *
  • - *

    - * HTTP 403 Forbidden Error - *

    - *
      - *
    • - *

      - * Code: AccessDenied

      - *
      • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, - * or you do not have the s3:PutIntelligentTieringConfiguration - * bucket permission to set the configuration on the bucket.

      - *
      • - *
    - *
    • - *
+ * @see {@link PutBucketIntelligentTieringConfigurationCommand} */ - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public putBucketIntelligentTieringConfiguration( - args: PutBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the PUT action adds an inventory configuration - * (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory - * configurations per bucket.

- *

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly - * basis, and the results are published to a flat file. The bucket that is inventoried is - * called the source bucket, and the bucket where the inventory flat file - * is stored is called the destination bucket. The - * destination bucket must be in the same Amazon Web Services Region as the - * source bucket.

- *

When you configure an inventory for a source bucket, you specify - * the destination bucket where you want the inventory to be stored, and - * whether to generate the inventory daily or weekly. You can also configure what object - * metadata to include and whether to inventory all object versions or only current versions. - * For more information, see Amazon S3 Inventory in the - * Amazon S3 User Guide.

- * - *

You must create a bucket policy on the destination bucket to - * grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an - * example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

- * - *

- * Permissions - *

- *

To use this operation, you must have permission to perform the - * s3:PutInventoryConfiguration action. The bucket owner has this permission - * by default and can grant this permission to others.

- *

The s3:PutInventoryConfiguration permission allows a user to create an - * S3 - * Inventory report that includes all object metadata fields available and to - * specify the destination bucket to store the inventory. A user with read access to objects - * in the destination bucket can also access all object metadata fields that are available in - * the inventory report.

- *

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the - * Amazon S3 User Guide. For more information about the metadata fields - * available in S3 Inventory, see Amazon S3 - * Inventory lists in the Amazon S3 User Guide. For more - * information about permissions, see Permissions related to bucket subresource operations and Identity and - * access management in Amazon S3 in the Amazon S3 User Guide.

- *

- * Special Errors - *

- *
    - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: InvalidArgument

      - *
      • - *
    • - *

      - * Cause: Invalid Argument

      - *
      • - *
    - *
    • - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: TooManyConfigurations

      - *
      • - *
    • - *

      - * Cause: You are attempting to create a new configuration - * but have already reached the 1,000-configuration limit.

      - *
      • - *
    - *
    • - *
  • - *

    - * HTTP 403 Forbidden Error - *

    - *
      - *
    • - *

      - * Code: AccessDenied

      - *
      • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, - * or you do not have the s3:PutInventoryConfiguration bucket - * permission to set the configuration on the bucket.

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketInventoryConfigurationCommand} */ - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, cb: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void ): void; - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void ): void; - public putBucketInventoryConfiguration( - args: PutBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - * configuration. Keep in mind that this will overwrite an existing lifecycle configuration, - * so if you want to retain any configuration details, they must be included in the new - * lifecycle configuration. For information about lifecycle configuration, see Managing - * your storage lifecycle.

- * - *

Bucket lifecycle configuration now supports specifying a lifecycle rule using an - * object key name prefix, one or more object tags, or a combination of both. Accordingly, - * this section describes the latest API. The previous version of the API supported - * filtering based only on an object key name prefix, which is supported for backward - * compatibility. For the related API description, see PutBucketLifecycle.

- * - *

- * Rules - *

- *

You specify the lifecycle configuration in your request body. The lifecycle - * configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle - * configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists - * of the following:

- *
    - *
  • - *

    Filter identifying a subset of objects to which the rule applies. The filter can - * be based on a key name prefix, object tags, or a combination of both.

    - *
    • - *
  • - *

    Status whether the rule is in effect.

    - *
    • - *
  • - *

    One or more lifecycle transition and expiration actions that you want Amazon S3 to - * perform on the objects identified by the filter. If the state of your bucket is - * versioning-enabled or versioning-suspended, you can have many versions of the same - * object (one current version and zero or more noncurrent versions). Amazon S3 provides - * predefined actions that you can specify for current and noncurrent object - * versions.

    - *
    • - *
- *

For more information, see Object Lifecycle Management - * and Lifecycle Configuration Elements.

- *

- * Permissions - *

- *

By default, all Amazon S3 resources are private, including buckets, objects, and related - * subresources (for example, lifecycle configuration and website configuration). Only the - * resource owner (that is, the Amazon Web Services account that created it) can access the resource. The - * resource owner can optionally grant access permissions to others by writing an access - * policy. For this operation, a user must get the s3:PutLifecycleConfiguration - * permission.

- *

You can also explicitly deny permissions. Explicit deny also supersedes any other - * permissions. If you want to block users or accounts from removing or deleting objects from - * your bucket, you must deny them permissions for the following actions:

- *
    - *
  • - *

    - * s3:DeleteObject - *

    - *
    • - *
  • - *

    - * s3:DeleteObjectVersion - *

    - *
    • - *
  • - *

    - * s3:PutLifecycleConfiguration - *

    - *
    • - *
- *

For more information about permissions, see Managing Access Permissions to - * Your Amazon S3 Resources.

- *

The following are related to PutBucketLifecycleConfiguration:

- * + * @see {@link PutBucketLifecycleConfigurationCommand} */ - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( - args: PutBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set the logging parameters for a bucket and to specify permissions for who can view and - * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as - * the source bucket. To set the logging status of a bucket, you must be the bucket - * owner.

- *

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the - * Grantee request element to grant access to other people. The - * Permissions request element specifies the kind of access the grantee has to - * the logs.

- * - *

If the target bucket for log delivery uses the bucket owner enforced setting for S3 - * Object Ownership, you can't use the Grantee request element to grant access - * to others. Permissions can only be granted using policies. For more information, see - * Permissions for server access log delivery in the - * Amazon S3 User Guide.

- * - *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
    • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - *
    • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
    • - *
- *

To enable logging, you use LoggingEnabled and its children request elements. To disable - * logging, you use an empty BucketLoggingStatus request element:

- *

- * - *

- *

For more information about server access logging, see Server Access Logging in the - * Amazon S3 User Guide.

- *

For more information about creating a bucket, see CreateBucket. For more - * information about returning the logging status of a bucket, see GetBucketLogging.

- *

The following operations are related to PutBucketLogging:

- * + * @see {@link PutBucketLoggingCommand} */ - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, cb: (err: any, data?: PutBucketLoggingCommandOutput) => void ): void; - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLoggingCommandOutput) => void ): void; - public putBucketLogging( - args: PutBucketLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketLoggingCommandOutput) => void), - cb?: (err: any, data?: PutBucketLoggingCommandOutput) => void - ): Promise | void { - const command = new PutBucketLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - * You can have up to 1,000 metrics configurations per bucket. If you're updating an existing - * metrics configuration, note that this is a full replacement of the existing metrics - * configuration. If you don't include the elements you want to keep, they are erased.

- *

To use this operation, you must have permissions to perform the - * s3:PutMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring - * Metrics with Amazon CloudWatch.

- *

The following operations are related to - * PutBucketMetricsConfiguration:

- * - *

- * GetBucketLifecycle has the following special error:

- *
    - *
  • - *

    Error code: TooManyConfigurations - *

    - *
      - *
    • - *

      Description: You are attempting to create a new configuration but have - * already reached the 1,000-configuration limit.

      - *
      • - *
    • - *

      HTTP Status Code: HTTP 400 Bad Request

      - *
      • - *
    - *
    • - *
+ * @see {@link PutBucketMetricsConfigurationCommand} */ - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, cb: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void ): void; - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void ): void; - public putBucketMetricsConfiguration( - args: PutBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables notifications of specified events for a bucket. For more information about event - * notifications, see Configuring Event - * Notifications.

- *

Using this API, you can replace an existing notification configuration. The - * configuration is an XML file that defines the event types that you want Amazon S3 to publish and - * the destination where you want Amazon S3 to publish an event notification when it detects an - * event of the specified type.

- *

By default, your bucket has no event notifications configured. That is, the notification - * configuration will be an empty NotificationConfiguration.

- *

- * - *

- *

- * - *

- *

This action replaces the existing notification configuration with the configuration you - * include in the request body.

- *

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - * Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and - * that the bucket owner has permission to publish to it by sending a test notification. In - * the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions - * grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, - * see Configuring Notifications for Amazon S3 Events.

- *

You can disable notifications by adding the empty NotificationConfiguration - * element.

- *

For more information about the number of event notification configurations that you can - * create per bucket, see Amazon S3 service quotas in Amazon Web Services - * General Reference.

- *

By default, only the bucket owner can configure notifications on a bucket. However, - * bucket owners can use a bucket policy to grant permission to other users to set this - * configuration with s3:PutBucketNotification permission.

- * - *

The PUT notification is an atomic operation. For example, suppose your notification - * configuration includes SNS topic, SQS queue, and Lambda function configurations. When - * you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS - * topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the - * configuration to your bucket.

- * - *

- * Responses - *

- *

If the configuration in the request body includes only one - * TopicConfiguration specifying only the - * s3:ReducedRedundancyLostObject event type, the response will also include - * the x-amz-sns-test-message-id header containing the message ID of the test - * notification sent to the topic.

- *

The following action is related to - * PutBucketNotificationConfiguration:

- * + * @see {@link PutBucketNotificationConfigurationCommand} */ - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, cb: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void ): void; - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void ): void; - public putBucketNotificationConfiguration( - args: PutBucketNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketOwnershipControls permission. For - * more information about Amazon S3 permissions, see Specifying permissions in a - * policy.

- *

For information about Amazon S3 Object Ownership, see Using object - * ownership.

- *

The following operations are related to PutBucketOwnershipControls:

- * + * @see {@link PutBucketOwnershipControlsCommand} */ - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, cb: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void ): void; - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void ): void; - public putBucketOwnershipControls( - args: PutBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new PutBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than - * the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the - * PutBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account in order to use this operation.

- *

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- * - *

For more information, see Bucket policy - * examples.

- *

The following operations are related to PutBucketPolicy:

- * + * @see {@link PutBucketPolicyCommand} */ - public putBucketPolicy( + putBucketPolicy( args: PutBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - cb: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): void; - public putBucketPolicy( + putBucketPolicy(args: PutBucketPolicyCommandInput, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void): void; + putBucketPolicy( args: PutBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void ): void; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new PutBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a replication configuration or replaces an existing one. For more information, - * see Replication in the Amazon S3 User Guide.

- *

Specify the replication configuration in the request body. In the replication - * configuration, you provide the name of the destination bucket or buckets where you want - * Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your - * behalf, and other relevant information.

- *

A replication configuration must include at least one rule, and can contain a maximum of - * 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in - * the source bucket. To choose additional subsets of objects to replicate, add a rule for - * each subset.

- *

To specify a subset of the objects in the source bucket to apply a replication rule to, - * add the Filter element as a child of the Rule element. You can filter objects based on an - * object key prefix, one or more object tags, or both. When you add the Filter element in the - * configuration, you must also add the following elements: - * DeleteMarkerReplication, Status, and - * Priority.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- * - *

For information about enabling versioning on a bucket, see Using Versioning.

- *

- * Handling Replication of Encrypted Objects - *

- *

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - * encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: - * SourceSelectionCriteria, SseKmsEncryptedObjects, - * Status, EncryptionConfiguration, and - * ReplicaKmsKeyID. For information about replication configuration, see - * Replicating Objects - * Created with SSE Using KMS keys.

- *

For information on PutBucketReplication errors, see List of - * replication-related error codes - *

- *

- * Permissions - *

- *

To create a PutBucketReplication request, you must have - * s3:PutReplicationConfiguration permissions for the bucket. - * - *

- *

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, - * can perform this operation. The resource owner can also grant others permissions to perform - * the operation. For more information about permissions, see Specifying Permissions in a - * Policy and Managing Access Permissions to - * Your Amazon S3 Resources.

- * - *

To perform this operation, the user or role performing the action must have the - * iam:PassRole permission.

- * - *

The following operations are related to PutBucketReplication:

- * + * @see {@link PutBucketReplicationCommand} */ - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( - args: PutBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: PutBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new PutBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the request payment configuration for a bucket. By default, the bucket owner pays - * for downloads from the bucket. This configuration parameter enables the bucket owner (only) - * to specify that the person requesting the download will be charged for the download. For - * more information, see Requester Pays - * Buckets.

- *

The following operations are related to PutBucketRequestPayment:

- * + * @see {@link PutBucketRequestPaymentCommand} */ - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, cb: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void ): void; - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void ): void; - public putBucketRequestPayment( - args: PutBucketRequestPaymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketRequestPaymentCommandOutput) => void), - cb?: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void - ): Promise | void { - const command = new PutBucketRequestPaymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the tags for a bucket.

- *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, - * sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost - * of combined resources, organize your billing information according to resources with the - * same tag key values. For example, you can tag several resources with a specific application - * name, and then organize your billing information to see the total cost of that application - * across several services. For more information, see Cost Allocation and - * Tagging and Using Cost Allocation in Amazon S3 Bucket - * Tags.

- * - *

When this operation sets the tags for a bucket, it will overwrite any current tags - * the bucket already has. You cannot use this operation to add tags to an existing list of - * tags.

- * - *

To use this operation, you must have permissions to perform the - * s3:PutBucketTagging action. The bucket owner has this permission by default - * and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * PutBucketTagging has the following special errors:

- *
    - *
  • - *

    Error code: InvalidTagError - *

    - * - *
    • - *
  • - *

    Error code: MalformedXMLError - *

    - *
      - *
    • - *

      Description: The XML provided does not match the schema.

      - *
      • - *
    - *
    • - *
  • - *

    Error code: OperationAbortedError - *

    - *
      - *
    • - *

      Description: A conflicting conditional action is currently in progress - * against this resource. Please try again.

      - *
      • - *
    - *
    • - *
  • - *

    Error code: InternalError - *

    - *
      - *
    • - *

      Description: The service was unable to apply the provided tag to the - * bucket.

      - *
      • - *
    - *
    • - *
- *

The following operations are related to PutBucketTagging:

- * + * @see {@link PutBucketTaggingCommand} */ - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( - args: PutBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: PutBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new PutBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the versioning state of an existing bucket.

- *

You can set the versioning state with one of the following values:

- *

- * Enabled—Enables versioning for the objects in the - * bucket. All objects added to the bucket receive a unique version ID.

- *

- * Suspended—Disables versioning for the objects in the - * bucket. All objects added to the bucket receive the version ID null.

- *

If the versioning state has never been set on a bucket, it has no versioning state; a - * GetBucketVersioning request does not return a versioning state value.

- *

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner - * and want to enable MFA Delete in the bucket versioning configuration, you must include the - * x-amz-mfa request header and the Status and the - * MfaDelete request elements in a request to set the versioning state of the - * bucket.

- * - *

If you have an object expiration lifecycle policy in your non-versioned bucket and - * you want to maintain the same permanent delete behavior when you enable versioning, you - * must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will - * manage the deletes of the noncurrent object versions in the version-enabled bucket. (A - * version-enabled bucket maintains one current and zero or more noncurrent object - * versions.) For more information, see Lifecycle and Versioning.

- * - *

- * Related Resources - *

- * + * @see {@link PutBucketVersioningCommand} */ - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( - args: PutBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: PutBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new PutBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the configuration of the website that is specified in the website - * subresource. To configure a bucket as a website, you can add this subresource on the bucket - * with website configuration information such as the file name of the index document and any - * redirect rules. For more information, see Hosting Websites on Amazon S3.

- *

This PUT action requires the S3:PutBucketWebsite permission. By default, - * only the bucket owner can configure the website attached to a bucket; however, bucket - * owners can allow other users to set the website configuration by writing a bucket policy - * that grants them the S3:PutBucketWebsite permission.

- *

To redirect all website requests sent to the bucket's website endpoint, you add a - * website configuration with the following elements. Because all requests are sent to another - * website, you don't need to provide index document name for the bucket.

- *
    - *
  • - *

    - * WebsiteConfiguration - *

    - *
    • - *
  • - *

    - * RedirectAllRequestsTo - *

    - *
    • - *
  • - *

    - * HostName - *

    - *
    • - *
  • - *

    - * Protocol - *

    - *
    • - *
- *

If you want granular control over redirects, you can use the following elements to add - * routing rules that describe conditions for redirecting requests and information about the - * redirect destination. In this case, the website configuration must provide an index - * document for the bucket, because some requests might not be redirected.

- *
    - *
  • - *

    - * WebsiteConfiguration - *

    - *
    • - *
  • - *

    - * IndexDocument - *

    - *
    • - *
  • - *

    - * Suffix - *

    - *
    • - *
  • - *

    - * ErrorDocument - *

    - *
    • - *
  • - *

    - * Key - *

    - *
    • - *
  • - *

    - * RoutingRules - *

    - *
    • - *
  • - *

    - * RoutingRule - *

    - *
    • - *
  • - *

    - * Condition - *

    - *
    • - *
  • - *

    - * HttpErrorCodeReturnedEquals - *

    - *
    • - *
  • - *

    - * KeyPrefixEquals - *

    - *
    • - *
  • - *

    - * Redirect - *

    - *
    • - *
  • - *

    - * Protocol - *

    - *
    • - *
  • - *

    - * HostName - *

    - *
    • - *
  • - *

    - * ReplaceKeyPrefixWith - *

    - *
    • - *
  • - *

    - * ReplaceKeyWith - *

    - *
    • - *
  • - *

    - * HttpRedirectCode - *

    - *
    • - *
- *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more - * than 50 routing rules, you can use object redirect. For more information, see Configuring an - * Object Redirect in the Amazon S3 User Guide.

+ * @see {@link PutBucketWebsiteCommand} */ - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, cb: (err: any, data?: PutBucketWebsiteCommandOutput) => void ): void; - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketWebsiteCommandOutput) => void ): void; - public putBucketWebsite( - args: PutBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: PutBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new PutBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object - * to it.

- * - *

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the - * entire object to the bucket. You cannot use PutObject to only update a - * single piece of metadata for an existing object. You must put the entire object with - * updated metadata if you want to update some values.

- * - *

Amazon S3 is a distributed system. If it receives multiple write requests for the same object - * simultaneously, it overwrites all but the last object written. To prevent objects from - * being deleted or overwritten, you can use Amazon S3 Object - * Lock.

- *

To ensure that data is not corrupted traversing the network, use the - * Content-MD5 header. When you use this header, Amazon S3 checks the object - * against the provided MD5 value and, if they do not match, returns an error. Additionally, - * you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to - * the calculated MD5 value.

- * - *
    - *
  • - *

    To successfully complete the PutObject request, you must have the - * s3:PutObject in your IAM permissions.

    - *
    • - *
  • - *

    To successfully change the objects acl of your PutObject request, - * you must have the s3:PutObjectAcl in your IAM permissions.

    - *
    • - *
  • - *

    To successfully set the tag-set with your PutObject request, you - * must have the s3:PutObjectTagging in your IAM permissions.

    - *
    • - *
  • - *

    The Content-MD5 header is required for any request to upload an - * object with a retention period configured using Amazon S3 Object Lock. For more - * information about Amazon S3 Object Lock, see Amazon S3 Object Lock - * Overview in the Amazon S3 User Guide.

    - *
    • - *
- * - *

You have three mutually exclusive options to protect data using server-side encryption - * in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the - * encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and - * customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using - * Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at by - * rest using server-side encryption with other key options. For more information, see Using - * Server-Side Encryption.

- *

When adding a new object, you can use headers to grant ACL-based permissions to - * individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are - * then added to the ACL on the object. By default, all objects are private. Only the owner - * has full access control. For more information, see Access Control List (ACL) Overview - * and Managing - * ACLs Using the REST API.

- *

If the bucket that you're uploading objects to uses the bucket owner enforced setting - * for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that - * use this setting only accept PUT requests that don't specify an ACL or PUT requests that - * specify bucket owner full control ACLs, such as the bucket-owner-full-control - * canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that - * contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a - * 400 error with the error code AccessControlListNotSupported. - * For more information, see Controlling ownership of - * objects and disabling ACLs in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for Object Ownership, all - * objects written to the bucket by any account will be owned by the bucket owner.

- * - *

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The - * STANDARD storage class provides high durability and high availability. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

- *

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID - * for the object being stored. Amazon S3 returns this ID in the response. When you enable - * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object - * simultaneously, it stores all of the objects. For more information about versioning, see - * Adding Objects to - * Versioning Enabled Buckets. For information about returning the versioning state - * of a bucket, see GetBucketVersioning.

- *

For more information about related Amazon S3 APIs, see the following:

- * + * @see {@link PutObjectCommand} */ - public putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; - public putObject( + putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; + putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; + putObject( args: PutObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectCommandOutput) => void ): void; - public putObject( - args: PutObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectCommandOutput) => void), - cb?: (err: any, data?: PutObjectCommandOutput) => void - ): Promise | void { - const command = new PutObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uses the acl subresource to set the access control list (ACL) permissions - * for a new or existing object in an S3 bucket. You must have WRITE_ACP - * permission to set the ACL of an object. For more information, see What - * permissions can I grant? in the Amazon S3 User Guide.

- *

This action is not supported by Amazon S3 on Outposts.

- *

Depending on your application needs, you can choose to set the ACL on an object using - * either the request body or the headers. For example, if you have an existing application - * that updates a bucket ACL using the request body, you can continue to use that approach. - * For more information, see Access Control List (ACL) Overview - * in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs - * are disabled and no longer affect permissions. You must use policies to grant access to - * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return - * the AccessControlListNotSupported error code. Requests to read ACLs are - * still supported. For more information, see Controlling object - * ownership in the Amazon S3 User Guide.

- * - *

- * Access Permissions - *

- *

You can set access permissions using one of the following methods:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports - * a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set - * of grantees and permissions. Specify the canned ACL name as the value of - * x-amz-acl. If you use this header, you cannot use other access - * control-specific headers in your request. For more information, see Canned - * ACL.

    - *
    • - *
  • - *

    Specify access permissions explicitly with the x-amz-grant-read, - * x-amz-grant-read-acp, x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. When using these headers, you - * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who - * will receive the permission. If you use these ACL-specific headers, you cannot use - * x-amz-acl header to set a canned ACL. These parameters map to the set - * of permissions that Amazon S3 supports in an ACL. For more information, see Access Control - * List (ACL) Overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
      • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
      • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       - *
      • - *
    - *

    For example, the following x-amz-grant-read header grants list - * objects permission to the two Amazon Web Services accounts identified by their email - * addresses.

    - *

    - * x-amz-grant-read: emailAddress="xyz@amazon.com", - * emailAddress="abc@amazon.com" - *

    - *
    • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You cannot do - * both.

- *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
    • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
    • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<>lt;/Grantee> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - * - *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    - *
      - *
    • - *

      US East (N. Virginia)

      - *
      • - *
    • - *

      US West (N. California)

      - *
      • - *
    • - *

      US West (Oregon)

      - *
      • - *
    • - *

      Asia Pacific (Singapore)

      - *
      • - *
    • - *

      Asia Pacific (Sydney)

      - *
      • - *
    • - *

      Asia Pacific (Tokyo)

      - *
      • - *
    • - *

      Europe (Ireland)

      - *
      • - *
    • - *

      South America (São Paulo)

      - *
      • - *
    - *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    - *     - *
    • - *
- *

- * Versioning - *

- *

The ACL of an object is set at the object version level. By default, PUT sets the ACL of - * the current version of an object. To set the ACL of a different version, use the - * versionId subresource.

- *

- * Related Resources - *

- * + * @see {@link PutObjectAclCommand} */ - public putObjectAcl( - args: PutObjectAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putObjectAcl(args: PutObjectAclCommandInput, cb: (err: any, data?: PutObjectAclCommandOutput) => void): void; - public putObjectAcl( + putObjectAcl(args: PutObjectAclCommandInput, options?: __HttpHandlerOptions): Promise; + putObjectAcl(args: PutObjectAclCommandInput, cb: (err: any, data?: PutObjectAclCommandOutput) => void): void; + putObjectAcl( args: PutObjectAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectAclCommandOutput) => void ): void; - public putObjectAcl( - args: PutObjectAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectAclCommandOutput) => void), - cb?: (err: any, data?: PutObjectAclCommandOutput) => void - ): Promise | void { - const command = new PutObjectAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a legal hold configuration to the specified object. For more information, see - * Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ * @see {@link PutObjectLegalHoldCommand} */ - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, cb: (err: any, data?: PutObjectLegalHoldCommandOutput) => void ): void; - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectLegalHoldCommandOutput) => void ): void; - public putObjectLegalHold( - args: PutObjectLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectLegalHoldCommandOutput) => void), - cb?: (err: any, data?: PutObjectLegalHoldCommandOutput) => void - ): Promise | void { - const command = new PutObjectLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Places an Object Lock configuration on the specified bucket. The rule specified in the - * Object Lock configuration will be applied by default to every new object placed in the - * specified bucket. For more information, see Locking Objects.

- * - *
    - *
  • - *

    The DefaultRetention settings require both a mode and a - * period.

    - *
    • - *
  • - *

    The DefaultRetention period can be either Days or - * Years but you must select one. You cannot specify - * Days and Years at the same time.

    - *
    • - *
  • - *

    You can only enable Object Lock for new buckets. If you want to turn on Object - * Lock for an existing bucket, contact Amazon Web Services Support.

    - *
    • - *
- * + * @see {@link PutObjectLockConfigurationCommand} */ - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, cb: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void ): void; - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void ): void; - public putObjectLockConfiguration( - args: PutObjectLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutObjectLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Places an Object Retention configuration on an object. For more information, see Locking Objects. - * Users or accounts require the s3:PutObjectRetention permission in order to - * place an Object Retention configuration on objects. Bypassing a Governance Retention - * configuration requires the s3:BypassGovernanceRetention permission.

- *

This action is not supported by Amazon S3 on Outposts.

+ * @see {@link PutObjectRetentionCommand} */ - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, cb: (err: any, data?: PutObjectRetentionCommandOutput) => void ): void; - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectRetentionCommandOutput) => void ): void; - public putObjectRetention( - args: PutObjectRetentionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectRetentionCommandOutput) => void), - cb?: (err: any, data?: PutObjectRetentionCommandOutput) => void - ): Promise | void { - const command = new PutObjectRetentionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the supplied tag-set to an object that already exists in a bucket.

- *

A tag is a key-value pair. You can associate tags with an object by sending a PUT - * request against the tagging subresource that is associated with the object. You can - * retrieve tags by sending a GET request. For more information, see GetObjectTagging.

- *

For tagging-related restrictions related to characters and encodings, see Tag - * Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per - * object.

- *

To use this operation, you must have permission to perform the - * s3:PutObjectTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

To put tags of any other version, use the versionId query parameter. You - * also need permission for the s3:PutObjectVersionTagging action.

- *

For information about the Amazon S3 object tagging feature, see Object Tagging.

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: InvalidTagError - *

      - *
      • - *
    • - *

      - * Cause: The tag provided was not a valid tag. This error can occur - * if the tag did not pass input validation. For more information, see Object - * Tagging. - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * Code: MalformedXMLError - *

      - *
      • - *
    • - *

      - * Cause: The XML provided does not match the schema. - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * Code: OperationAbortedError - *

      - *
      • - *
    • - *

      - * Cause: A conflicting conditional action is currently in progress - * against this resource. Please try again. - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * Code: InternalError - *

      - *
      • - *
    • - *

      - * Cause: The service was unable to apply the provided tag to the - * object. - *

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link PutObjectTaggingCommand} */ - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, cb: (err: any, data?: PutObjectTaggingCommandOutput) => void ): void; - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectTaggingCommandOutput) => void ): void; - public putObjectTagging( - args: PutObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: PutObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new PutObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. - * To use this operation, you must have the s3:PutBucketPublicAccessBlock - * permission. For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- * - *

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or - * an object, it checks the PublicAccessBlock configuration for both the - * bucket (or the bucket that contains the object) and the bucket owner's account. If the - * PublicAccessBlock configurations are different between the bucket and - * the account, Amazon S3 uses the most restrictive combination of the bucket-level and - * account-level settings.

- * - *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

- *

- * Related Resources - *

- * + * @see {@link PutPublicAccessBlockCommand} */ - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( - args: PutPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: PutPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new PutPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores an archived copy of an object back into Amazon S3

- *

This action is not supported by Amazon S3 on Outposts.

- *

This action performs the following types of requests:

- *
    - *
  • - *

    - * select - Perform a select query on an archived object

    - *
    • - *
  • - *

    - * restore an archive - Restore an archived object

    - *
    • - *
- *

To use this operation, you must have permissions to perform the - * s3:RestoreObject action. The bucket owner has this permission by default - * and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

For more information about the S3 structure in the request body, see the - * following:

- *
    - *
  • - * - *
    • - *
  • - *

    Define the SQL expression for the SELECT type of restoration for your - * query in the request body's SelectParameters structure. You can use - * expressions like the following examples.

    - *
      - *
    • - *

      The following expression returns all records from the specified - * object.

      - *

      - * SELECT * FROM Object - *

      - *
      • - *
    • - *

      Assuming that you are not using any headers for data stored in the object, - * you can specify columns with positional headers.

      - *

      - * SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 - *

      - *
      • - *
    • - *

      If you have headers and you set the fileHeaderInfo in the - * CSV structure in the request body to USE, you can - * specify headers in the query. (If you set the fileHeaderInfo field - * to IGNORE, the first row is skipped for the query.) You cannot mix - * ordinal positions with header column names.

      - *

      - * SELECT s.Id, s.FirstName, s.SSN FROM S3Object s - *

      - *
      • - *
    - *
    • - *
- *

When making a select request, you can also do the following:

- *
    - *
  • - *

    To expedite your queries, specify the Expedited tier. For more - * information about tiers, see "Restoring Archives," later in this topic.

    - *
    • - *
  • - *

    Specify details about the data serialization format of both the input object that - * is being queried and the serialization of the CSV-encoded query results.

    - *
    • - *
- *

The following are additional important facts about the select feature:

- *
    - *
  • - *

    The output results are new Amazon S3 objects. Unlike archive retrievals, they are - * stored until explicitly deleted-manually or through a lifecycle policy.

    - *
    • - *
  • - *

    You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't - * duplicate requests, so avoid issuing duplicate requests.

    - *
    • - *
  • - *

    Amazon S3 accepts a select request even if the object has already been restored. A - * select request doesn’t return error response 409.

    - *
    • - *
- *

- * Restoring objects - *

- *

Objects that you archive to the S3 Glacier Flexible Retrieval or - * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the - * S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage - * classes, you must first initiate a restore request, and then wait until a temporary copy of - * the object is available. If you want a permanent copy of the object, create a copy of it in - * the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must - * restore the object for the duration (number of days) that you specify. For objects in the - * Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first - * initiate a restore request, and then wait until the object is moved into the Frequent - * Access tier.

- *

To restore a specific object version, you can provide a version ID. If you don't provide - * a version ID, Amazon S3 restores the current version.

- *

When restoring an archived object, you can specify one of the following data access tier - * options in the Tier element of the request body:

- *
    - *
  • - *

    - * Expedited - Expedited retrievals allow you to quickly access your - * data stored in the S3 Glacier Flexible Retrieval storage class or - * S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives - * are required. For all but the largest archived objects (250 MB+), data accessed using - * Expedited retrievals is typically made available within 1–5 minutes. Provisioned - * capacity ensures that retrieval capacity for Expedited retrievals is available when - * you need it. Expedited retrievals and provisioned capacity are not available for - * objects stored in the S3 Glacier Deep Archive storage class or - * S3 Intelligent-Tiering Deep Archive tier.

    - *
    • - *
  • - *

    - * Standard - Standard retrievals allow you to access any of your - * archived objects within several hours. This is the default option for retrieval - * requests that do not specify the retrieval option. Standard retrievals typically - * finish within 3–5 hours for objects stored in the S3 Glacier Flexible - * Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within - * 12 hours for objects stored in the S3 Glacier Deep Archive storage class or - * S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in - * S3 Intelligent-Tiering.

    - *
    • - *
  • - *

    - * Bulk - Bulk retrievals free for objects stored in the S3 Glacier - * Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to - * retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically - * finish within 5–12 hours for objects stored in the S3 Glacier - * Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are - * also the lowest-cost retrieval option when restoring objects from - * S3 Glacier Deep Archive. They typically finish within 48 hours for objects - * stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive - * tier.

    - *
    • - *
- *

For more information about archive retrieval options and provisioned capacity for - * Expedited data access, see Restoring Archived Objects in - * the Amazon S3 User Guide.

- *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed - * while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the - * Amazon S3 User Guide.

- *

To get the status of object restoration, you can send a HEAD request. - * Operations return the x-amz-restore header, which provides information about - * the restoration status, in the response. You can use Amazon S3 event notifications to notify you - * when a restore is initiated or completed. For more information, see Configuring Amazon S3 - * Event Notifications in the Amazon S3 User Guide.

- *

After restoring an archived object, you can update the restoration period by reissuing - * the request with a new period. Amazon S3 updates the restoration period relative to the current - * time and charges only for the request-there are no data transfer charges. You cannot - * update the restoration period when Amazon S3 is actively processing your current restore request - * for the object.

- *

If your bucket has a lifecycle configuration with a rule that includes an expiration - * action, the object expiration overrides the life span that you specify in a restore - * request. For example, if you restore an object copy for 10 days, but the object is - * scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information - * about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management - * in Amazon S3 User Guide.

- *

- * Responses - *

- *

A successful action returns either the 200 OK or 202 Accepted - * status code.

- *
    - *
  • - *

    If the object is not previously restored, then Amazon S3 returns 202 - * Accepted in the response.

    - *
    • - *
  • - *

    If the object is previously restored, Amazon S3 returns 200 OK in the - * response.

    - *
    • - *
- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: RestoreAlreadyInProgress - *

      - *
      • - *
    • - *

      - * Cause: Object restore is already in progress. (This error does not - * apply to SELECT type requests.) - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 409 Conflict - *

      - *
      • - *
    • - *

      - * SOAP Fault Code Prefix: Client - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * Code: GlacierExpeditedRetrievalNotAvailable - *

      - *
      • - *
    • - *

      - * Cause: expedited retrievals are currently not available. Try again - * later. (Returned if there is insufficient capacity to process the Expedited - * request. This error applies only to Expedited retrievals and not to - * S3 Standard or Bulk retrievals.) - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 503 - *

      - *
      • - *
    • - *

      - * SOAP Fault Code Prefix: N/A - *

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link RestoreObjectCommand} */ - public restoreObject( - args: RestoreObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreObject( - args: RestoreObjectCommandInput, - cb: (err: any, data?: RestoreObjectCommandOutput) => void - ): void; - public restoreObject( + restoreObject(args: RestoreObjectCommandInput, options?: __HttpHandlerOptions): Promise; + restoreObject(args: RestoreObjectCommandInput, cb: (err: any, data?: RestoreObjectCommandOutput) => void): void; + restoreObject( args: RestoreObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreObjectCommandOutput) => void ): void; - public restoreObject( - args: RestoreObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreObjectCommandOutput) => void), - cb?: (err: any, data?: RestoreObjectCommandOutput) => void - ): Promise | void { - const command = new RestoreObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action filters the contents of an Amazon S3 object based on a simple structured query - * language (SQL) statement. In the request, along with the SQL expression, you must also - * specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses - * this format to parse object data into records, and returns only records that match the - * specified SQL expression. You must also specify the data serialization format for the - * response.

- *

This action is not supported by Amazon S3 on Outposts.

- *

For more information about Amazon S3 Select, see Selecting Content from - * Objects and SELECT - * Command in the Amazon S3 User Guide.

- *

- *

- * Permissions - *

- *

You must have s3:GetObject permission for this operation. Amazon S3 Select does - * not support anonymous access. For more information about permissions, see Specifying - * Permissions in a Policy in the Amazon S3 User Guide.

- *

- *

- * Object Data Formats - *

- *

You can use Amazon S3 Select to query objects that have the following format - * properties:

- *
    - *
  • - *

    - * CSV, JSON, and Parquet - Objects must be in CSV, JSON, or - * Parquet format.

    - *
    • - *
  • - *

    - * UTF-8 - UTF-8 is the only encoding type Amazon S3 Select - * supports.

    - *
    • - *
  • - *

    - * GZIP or BZIP2 - CSV and JSON files can be compressed using - * GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select - * supports for CSV and JSON files. Amazon S3 Select supports columnar compression for - * Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression - * for Parquet objects.

    - *
    • - *
  • - *

    - * Server-side encryption - Amazon S3 Select supports querying - * objects that are protected with server-side encryption.

    - *

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you - * must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side - * Encryption (Using Customer-Provided Encryption Keys) in the - * Amazon S3 User Guide.

    - *

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys - * (SSE-KMS), server-side encryption is handled transparently, so you don't need to - * specify anything. For more information about server-side encryption, including SSE-S3 - * and SSE-KMS, see Protecting Data Using - * Server-Side Encryption in the Amazon S3 User Guide.

    - *
    • - *
- *

- * Working with the Response Body - *

- *

Given the response size is unknown, Amazon S3 Select streams the response as a series of - * messages and includes a Transfer-Encoding header with chunked as - * its value in the response. For more information, see Appendix: SelectObjectContent - * Response.

- *

- *

- * GetObject Support - *

- *

The SelectObjectContent action does not support the following - * GetObject functionality. For more information, see GetObject.

- *
    - *
  • - *

    - * Range: Although you can specify a scan range for an Amazon S3 Select request - * (see SelectObjectContentRequest - ScanRange in the request parameters), - * you cannot specify the range of bytes of an object to return.

    - *
    • - *
  • - *

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify - * the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For - * more information, about storage classes see Storage - * Classes in the Amazon S3 User Guide.

    - *
    • - *
- *

- *

- * Special Errors - *

- *

For a list of special errors for this operation, see List of - * SELECT Object Content Error Codes - *

- *

- * Related Resources - *

- * + * @see {@link SelectObjectContentCommand} */ - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, cb: (err: any, data?: SelectObjectContentCommandOutput) => void ): void; - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectObjectContentCommandOutput) => void ): void; - public selectObjectContent( - args: SelectObjectContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SelectObjectContentCommandOutput) => void), - cb?: (err: any, data?: SelectObjectContentCommandOutput) => void - ): Promise | void { - const command = new SelectObjectContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a part in a multipart upload.

- * - *

In this operation, you provide part data in your request. However, you have an option - * to specify your existing Amazon S3 object as a data source for the part you are uploading. To - * upload a part from an existing object, you use the UploadPartCopy operation. - *

- * - *

You must initiate a multipart upload (see CreateMultipartUpload) - * before you can upload any part. In response to your initiate request, Amazon S3 returns an - * upload ID, a unique identifier, that you must include in your upload part request.

- *

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely - * identifies a part and also defines its position within the object being created. If you - * upload a new part using the same part number that was used with a previous part, the - * previously uploaded part is overwritten.

- *

For information about maximum and minimum part sizes and other multipart upload - * specifications, see Multipart upload limits in the Amazon S3 User Guide.

- *

To ensure that data is not corrupted when traversing the network, specify the - * Content-MD5 header in the upload part request. Amazon S3 checks the part data - * against the provided MD5 value. If they do not match, Amazon S3 returns an error.

- *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the - * x-amz-content-sha256 header as a checksum instead of - * Content-MD5. For more information see Authenticating - * Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

- *

- * Note: After you initiate multipart upload and upload - * one or more parts, you must either complete or abort multipart upload in order to stop - * getting charged for storage of the uploaded parts. Only after you either complete or abort - * multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts - * storage.

- *

For more information on multipart uploads, go to Multipart Upload Overview in the - * Amazon S3 User Guide .

- *

For information on the permissions required to use the multipart upload API, go to - * Multipart - * Upload and Permissions in the Amazon S3 User Guide.

- *

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts it when you access it. You have three - * mutually exclusive options to protect data using server-side encryption in Amazon S3, depending - * on how you choose to manage the encryption keys. Specifically, the encryption key options - * are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys - * (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by - * default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption - * with other key options. The option you use depends on whether you want to use KMS keys - * (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own - * encryption key, the request headers you provide in the request must match the headers you - * used in the request to initiate the upload by using CreateMultipartUpload. - * For more information, go to Using Server-Side - * Encryption in the Amazon S3 User Guide.

- *

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are - * using a customer-provided encryption key (SSE-C), you don't need to specify the encryption - * parameters in each UploadPart request. Instead, you only need to specify the server-side - * encryption parameters in the initial Initiate Multipart request. For more information, see - * CreateMultipartUpload.

- *

If you requested server-side encryption using a customer-provided encryption key (SSE-C) - * in your initiate multipart upload request, you must provide identical encryption - * information in each part upload using 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

    - *
    • - *
- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: NoSuchUpload - *

      - *
      • - *
    • - *

      - * Cause: The specified multipart upload does not exist. The upload - * ID might be invalid, or the multipart upload might have been aborted or - * completed. - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 404 Not Found - *

      - *
      • - *
    • - *

      - * SOAP Fault Code Prefix: Client - *

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link UploadPartCommand} */ - public uploadPart(args: UploadPartCommandInput, options?: __HttpHandlerOptions): Promise; - public uploadPart(args: UploadPartCommandInput, cb: (err: any, data?: UploadPartCommandOutput) => void): void; - public uploadPart( + uploadPart(args: UploadPartCommandInput, options?: __HttpHandlerOptions): Promise; + uploadPart(args: UploadPartCommandInput, cb: (err: any, data?: UploadPartCommandOutput) => void): void; + uploadPart( args: UploadPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadPartCommandOutput) => void ): void; - public uploadPart( - args: UploadPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadPartCommandOutput) => void), - cb?: (err: any, data?: UploadPartCommandOutput) => void - ): Promise | void { - const command = new UploadPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a part by copying data from an existing object as data source. You specify the - * data source by adding the request header x-amz-copy-source in your request and - * a byte range by adding the request header x-amz-copy-source-range in your - * request.

- *

For information about maximum and minimum part sizes and other multipart upload - * specifications, see Multipart upload limits in the Amazon S3 User Guide.

- * - *

Instead of using an existing object as part data, you might use the UploadPart - * action and provide data in your request.

- * - *

You must initiate a multipart upload before you can upload any part. In response to your - * initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in - * your upload part request.

- *

For more information about using the UploadPartCopy operation, see the - * following:

- *
    - *
  • - *

    For conceptual information about multipart uploads, see Uploading - * Objects Using Multipart Upload in the - * Amazon S3 User Guide.

    - *
    • - *
  • - *

    For information about permissions required to use the multipart upload API, see - * Multipart Upload and Permissions in the - * Amazon S3 User Guide.

    - *
    • - *
  • - *

    For information about copying objects using a single atomic action vs. a multipart - * upload, see Operations on Objects in - * the Amazon S3 User Guide.

    - *
    • - *
  • - *

    For information about using server-side encryption with customer-provided - * encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

    - *
    • - *
- *

Note the following additional considerations about the request headers - * x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - * x-amz-copy-source-if-unmodified-since, and - * x-amz-copy-source-if-modified-since:

- *

- *
    - *
  • - *

    - * Consideration 1 - If both of the - * x-amz-copy-source-if-match and - * x-amz-copy-source-if-unmodified-since headers are present in the - * request as follows:

    - *

    - * x-amz-copy-source-if-match condition evaluates to true, - * and;

    - *

    - * x-amz-copy-source-if-unmodified-since condition evaluates to - * false;

    - *

    Amazon S3 returns 200 OK and copies the data. - *

    - *
    • - *
  • - *

    - * Consideration 2 - If both of the - * x-amz-copy-source-if-none-match and - * x-amz-copy-source-if-modified-since headers are present in the - * request as follows:

    - *

    - * x-amz-copy-source-if-none-match condition evaluates to - * false, and;

    - *

    - * x-amz-copy-source-if-modified-since condition evaluates to - * true;

    - *

    Amazon S3 returns 412 Precondition Failed response code. - *

    - *
    • - *
- *

- * Versioning - *

- *

If your bucket has versioning enabled, you could have multiple versions of the same - * object. By default, x-amz-copy-source identifies the current version of the - * object to copy. If the current version is a delete marker and you don't specify a versionId - * in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does - * not exist. If you specify versionId in the x-amz-copy-source and the versionId - * is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify - * a delete marker as a version for the x-amz-copy-source.

- *

You can optionally specify a specific version of the source object to copy by adding the - * versionId subresource as shown in the following example:

- *

- * x-amz-copy-source: /bucket/object?versionId=version id - *

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: NoSuchUpload - *

      - *
      • - *
    • - *

      - * Cause: The specified multipart upload does not exist. The upload - * ID might be invalid, or the multipart upload might have been aborted or - * completed. - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 404 Not Found - *

      - *
      • - *
    - *
    • - *
  • - *
      - *
    • - *

      - * Code: InvalidRequest - *

      - *
      • - *
    • - *

      - * Cause: The specified copy source is not supported as a byte-range - * copy source. - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 400 Bad Request - *

      - *
      • - *
    - *
    • - *
- *

- * Related Resources - *

- * + * @see {@link UploadPartCopyCommand} */ - public uploadPartCopy( + uploadPartCopy( args: UploadPartCopyCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadPartCopy( - args: UploadPartCopyCommandInput, - cb: (err: any, data?: UploadPartCopyCommandOutput) => void - ): void; - public uploadPartCopy( + uploadPartCopy(args: UploadPartCopyCommandInput, cb: (err: any, data?: UploadPartCopyCommandOutput) => void): void; + uploadPartCopy( args: UploadPartCopyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadPartCopyCommandOutput) => void ): void; - public uploadPartCopy( - args: UploadPartCopyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadPartCopyCommandOutput) => void), - cb?: (err: any, data?: UploadPartCopyCommandOutput) => void - ): Promise | void { - const command = new UploadPartCopyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Passes transformed objects to a GetObject operation when using Object Lambda access points. For - * information about Object Lambda access points, see Transforming objects with - * Object Lambda access points in the Amazon S3 User Guide.

- *

This operation supports metadata that can be returned by GetObject, in addition to - * RequestRoute, RequestToken, StatusCode, - * ErrorCode, and ErrorMessage. The GetObject - * response metadata is supported so that the WriteGetObjectResponse caller, - * typically an Lambda function, can provide the same metadata when it internally invokes - * GetObject. When WriteGetObjectResponse is called by a - * customer-owned Lambda function, the metadata returned to the end user - * GetObject call might differ from what Amazon S3 would normally return.

- *

You can include any number of metadata headers. When including a metadata header, it - * should be prefaced with x-amz-meta. For example, - * x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this - * is to forward GetObject metadata.

- *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to - * detect and redact personally identifiable information (PII) and decompress S3 objects. - * These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and - * can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

- *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a - * natural language processing (NLP) service using machine learning to find insights and - * relationships in text. It automatically detects personally identifiable information (PII) - * such as names, addresses, dates, credit card numbers, and social security numbers from - * documents in your Amazon S3 bucket.

- *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - * language processing (NLP) service using machine learning to find insights and relationships - * in text. It automatically redacts personally identifiable information (PII) such as names, - * addresses, dates, credit card numbers, and social security numbers from documents in your - * Amazon S3 bucket.

- *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is - * equipped to decompress objects stored in S3 in one of six compressed file formats including - * bzip2, gzip, snappy, zlib, zstandard and ZIP.

- *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda - * functions in the Amazon S3 User Guide.

+ * @see {@link WriteGetObjectResponseCommand} */ - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, cb: (err: any, data?: WriteGetObjectResponseCommandOutput) => void ): void; - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WriteGetObjectResponseCommandOutput) => void ): void; - public writeGetObjectResponse( - args: WriteGetObjectResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: WriteGetObjectResponseCommandOutput) => void), - cb?: (err: any, data?: WriteGetObjectResponseCommandOutput) => void - ): Promise | void { - const command = new WriteGetObjectResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + *

+ */ +export class S3 extends S3Client implements S3 { + public constructor(config: S3ClientConfig) { + super(config); + createAggregatedClient(commands, this); } } diff --git a/packages/smithy-client/src/index.ts b/packages/smithy-client/src/index.ts index 7828236d3647..344c64f9d147 100644 --- a/packages/smithy-client/src/index.ts +++ b/packages/smithy-client/src/index.ts @@ -2,6 +2,7 @@ export * from "./NoOpLogger"; export * from "./client"; export * from "./command"; export * from "./constants"; +export * from "./create-aggregated-client"; export * from "./date-utils"; export * from "./default-error-handler"; export * from "./defaults-mode"; diff --git a/private/aws-echo-service/src/EchoService.ts b/private/aws-echo-service/src/EchoService.ts index 36383c282b99..55b7da45298e 100644 --- a/private/aws-echo-service/src/EchoService.ts +++ b/private/aws-echo-service/src/EchoService.ts @@ -1,62 +1,41 @@ // smithy-typescript generated code -import { EchoServiceClient } from "./EchoServiceClient"; +import { EchoServiceClient, EchoServiceClientConfig } from "./EchoServiceClient"; import { EchoCommand, EchoCommandInput, EchoCommandOutput } from "./commands/EchoCommand"; import { LengthCommand, LengthCommandInput, LengthCommandOutput } from "./commands/LengthCommand"; +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -/** - * @public - */ -export class EchoService extends EchoServiceClient { +const commands = { + EchoCommand, + LengthCommand, +}; +export interface EchoService { /** - * @public + * @see {@link EchoCommand} */ - public echo(args: EchoCommandInput, options?: __HttpHandlerOptions): Promise; - public echo(args: EchoCommandInput, cb: (err: any, data?: EchoCommandOutput) => void): void; - public echo( - args: EchoCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: EchoCommandOutput) => void - ): void; - public echo( - args: EchoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EchoCommandOutput) => void), - cb?: (err: any, data?: EchoCommandOutput) => void - ): Promise | void { - const command = new EchoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + echo(args: EchoCommandInput, options?: __HttpHandlerOptions): Promise; + echo(args: EchoCommandInput, cb: (err: any, data?: EchoCommandOutput) => void): void; + echo(args: EchoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EchoCommandOutput) => void): void; /** - * @public + * @see {@link LengthCommand} */ - public length(args: LengthCommandInput, options?: __HttpHandlerOptions): Promise; - public length(args: LengthCommandInput, cb: (err: any, data?: LengthCommandOutput) => void): void; - public length( + length(args: LengthCommandInput, options?: __HttpHandlerOptions): Promise; + length(args: LengthCommandInput, cb: (err: any, data?: LengthCommandOutput) => void): void; + length( args: LengthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LengthCommandOutput) => void ): void; - public length( - args: LengthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LengthCommandOutput) => void), - cb?: (err: any, data?: LengthCommandOutput) => void - ): Promise | void { - const command = new LengthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + */ +export class EchoService extends EchoServiceClient implements EchoService { + public constructor(config: EchoServiceClientConfig) { + super(config); + const target: any = {}; + return createProxyClient(target, commands, this); } } diff --git a/private/aws-protocoltests-ec2/src/EC2Protocol.ts b/private/aws-protocoltests-ec2/src/EC2Protocol.ts index 010d4e9c4b50..49686ff2b312 100644 --- a/private/aws-protocoltests-ec2/src/EC2Protocol.ts +++ b/private/aws-protocoltests-ec2/src/EC2Protocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -101,791 +102,392 @@ import { XmlTimestampsCommandInput, XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; -import { EC2ProtocolClient } from "./EC2ProtocolClient"; +import { EC2ProtocolClient, EC2ProtocolClientConfig } from "./EC2ProtocolClient"; -/** - * @public - * An EC2 query service that sends query requests and XML responses. - */ -export class EC2Protocol extends EC2ProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + IgnoresWrappingXmlNameCommand, + NestedStructuresCommand, + NoInputAndOutputCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryListsCommand, + QueryTimestampsCommand, + RecursiveXmlShapesCommand, + SimpleInputParamsCommand, + SimpleScalarXmlPropertiesCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, +}; +export interface EC2Protocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response members. - * - * While this should be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The xmlName trait on the output structure is ignored in AWS Query. - * - * The wrapping element is always operation name + "Response". + * @see {@link IgnoresWrappingXmlNameCommand} */ - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( - args: IgnoresWrappingXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void), - cb?: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void - ): Promise | void { - const command = new IgnoresWrappingXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes nested and recursive structure members. + * @see {@link NestedStructuresCommand} */ - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options?: __HttpHandlerOptions ): Promise; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( - args: NestedStructuresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedStructuresCommandOutput) => void), - cb?: (err: any, data?: NestedStructuresCommandOutput) => void - ): Promise | void { - const command = new NestedStructuresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request payload or response members. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex lists. + * @see {@link QueryListsCommand} */ - public queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; - public queryLists( + queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; + queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; + queryLists( args: QueryListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryListsCommandOutput) => void ): void; - public queryLists( - args: QueryListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryListsCommandOutput) => void), - cb?: (err: any, data?: QueryListsCommandOutput) => void - ): Promise | void { - const command = new QueryListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes timestamps. - * - * 1. Timestamps are serialized as RFC 3339 date-time values by default. - * 2. A timestampFormat trait on a member changes the format. - * 3. A timestampFormat trait on the shape targeted by the member changes the format. + * @see {@link QueryTimestampsCommand} */ - public queryTimestamps( + queryTimestamps( args: QueryTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryTimestamps( - args: QueryTimestampsCommandInput, - cb: (err: any, data?: QueryTimestampsCommandOutput) => void - ): void; - public queryTimestamps( + queryTimestamps(args: QueryTimestampsCommandInput, cb: (err: any, data?: QueryTimestampsCommandOutput) => void): void; + queryTimestamps( args: QueryTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryTimestampsCommandOutput) => void ): void; - public queryTimestamps( - args: QueryTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryTimestampsCommandOutput) => void), - cb?: (err: any, data?: QueryTimestampsCommandOutput) => void - ): Promise | void { - const command = new QueryTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveXmlShapesCommand} */ - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( - args: RecursiveXmlShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveXmlShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveXmlShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveXmlShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes strings, numbers, and boolean values. + * @see {@link SimpleInputParamsCommand} */ - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( - args: SimpleInputParamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleInputParamsCommandOutput) => void), - cb?: (err: any, data?: SimpleInputParamsCommandOutput) => void - ): Promise | void { - const command = new SimpleInputParamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarXmlPropertiesCommand} */ - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( - args: SimpleScalarXmlPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarXmlPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes intEnums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Flattened XML lists with @xmlNamespace. - * 8. Lists of structures. + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + * An EC2 query service that sends query requests and XML responses. + */ +export class EC2Protocol extends EC2ProtocolClient implements EC2Protocol { + public constructor(config: EC2ProtocolClientConfig) { + const client = new EC2ProtocolClient(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/private/aws-protocoltests-json-10/src/JSONRPC10.ts b/private/aws-protocoltests-json-10/src/JSONRPC10.ts index 6a6987ab65b8..8f95874061b0 100644 --- a/private/aws-protocoltests-json-10/src/JSONRPC10.ts +++ b/private/aws-protocoltests-json-10/src/JSONRPC10.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -42,311 +43,175 @@ import { SimpleScalarPropertiesCommandInput, SimpleScalarPropertiesCommandOutput, } from "./commands/SimpleScalarPropertiesCommand"; -import { JSONRPC10Client } from "./JSONRPC10Client"; +import { JSONRPC10Client, JSONRPC10ClientConfig } from "./JSONRPC10Client"; -/** - * @public - */ -export class JSONRPC10 extends JSONRPC10Client { +const commands = { + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + JsonUnionsCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + SimpleScalarPropertiesCommand, +}; +export interface JSONRPC10 { /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A ComplexError error. - * - * Implementations must be able to successfully take a response and - * properly deserialize successful and error responses. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation uses unions for inputs and outputs. + * @see {@link JsonUnionsCommand} */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + */ +export class JSONRPC10 extends JSONRPC10Client implements JSONRPC10 { + public constructor(config: JSONRPC10ClientConfig) { + const client = new JSONRPC10Client(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/private/aws-protocoltests-json/src/JsonProtocol.ts b/private/aws-protocoltests-json/src/JsonProtocol.ts index b6521901ea48..a59c97496e0a 100644 --- a/private/aws-protocoltests-json/src/JsonProtocol.ts +++ b/private/aws-protocoltests-json/src/JsonProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -63,456 +64,247 @@ import { SimpleScalarPropertiesCommandInput, SimpleScalarPropertiesCommandOutput, } from "./commands/SimpleScalarPropertiesCommand"; -import { JsonProtocolClient } from "./JsonProtocolClient"; +import { JsonProtocolClient, JsonProtocolClientConfig } from "./JsonProtocolClient"; -/** - * @public - */ -export class JsonProtocol extends JsonProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyOperationCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + JsonEnumsCommand, + JsonUnionsCommand, + KitchenSinkOperationCommand, + NullOperationCommand, + OperationWithOptionalInputOutputCommand, + PutAndGetInlineDocumentsCommand, + SimpleScalarPropertiesCommand, +}; +export interface JsonProtocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EmptyOperationCommand} */ - public emptyOperation( + emptyOperation( args: EmptyOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyOperation( - args: EmptyOperationCommandInput, - cb: (err: any, data?: EmptyOperationCommandOutput) => void - ): void; - public emptyOperation( + emptyOperation(args: EmptyOperationCommandInput, cb: (err: any, data?: EmptyOperationCommandOutput) => void): void; + emptyOperation( args: EmptyOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyOperationCommandOutput) => void ): void; - public emptyOperation( - args: EmptyOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyOperationCommandOutput) => void), - cb?: (err: any, data?: EmptyOperationCommandOutput) => void - ): Promise | void { - const command = new EmptyOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A ComplexError error. - * - * Implementations must be able to successfully take a response and - * properly deserialize successful and error responses. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link JsonEnumsCommand} */ - public jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; - public jsonEnums( + jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; + jsonEnums( args: JsonEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonEnumsCommandOutput) => void ): void; - public jsonEnums( - args: JsonEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation uses unions for inputs and outputs. + * @see {@link JsonUnionsCommand} */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link KitchenSinkOperationCommand} */ - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, cb: (err: any, data?: KitchenSinkOperationCommandOutput) => void ): void; - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: KitchenSinkOperationCommandOutput) => void ): void; - public kitchenSinkOperation( - args: KitchenSinkOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: KitchenSinkOperationCommandOutput) => void), - cb?: (err: any, data?: KitchenSinkOperationCommandOutput) => void - ): Promise | void { - const command = new KitchenSinkOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link NullOperationCommand} */ - public nullOperation( - args: NullOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public nullOperation( - args: NullOperationCommandInput, - cb: (err: any, data?: NullOperationCommandOutput) => void - ): void; - public nullOperation( + nullOperation(args: NullOperationCommandInput, options?: __HttpHandlerOptions): Promise; + nullOperation(args: NullOperationCommandInput, cb: (err: any, data?: NullOperationCommandOutput) => void): void; + nullOperation( args: NullOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullOperationCommandOutput) => void ): void; - public nullOperation( - args: NullOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullOperationCommandOutput) => void), - cb?: (err: any, data?: NullOperationCommandOutput) => void - ): Promise | void { - const command = new NullOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link OperationWithOptionalInputOutputCommand} */ - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, cb: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void ): void; - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void ): void; - public operationWithOptionalInputOutput( - args: OperationWithOptionalInputOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void), - cb?: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void - ): Promise | void { - const command = new OperationWithOptionalInputOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an inline document as part of the payload. + * @see {@link PutAndGetInlineDocumentsCommand} */ - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, cb: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void ): void; - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void ): void; - public putAndGetInlineDocuments( - args: PutAndGetInlineDocumentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void), - cb?: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void - ): Promise | void { - const command = new PutAndGetInlineDocumentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + */ +export class JsonProtocol extends JsonProtocolClient implements JsonProtocol { + public constructor(config: JsonProtocolClientConfig) { + const client = new JsonProtocolClient(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/private/aws-protocoltests-query/src/QueryProtocol.ts b/private/aws-protocoltests-query/src/QueryProtocol.ts index 279731cc8457..05e063fb52a0 100644 --- a/private/aws-protocoltests-query/src/QueryProtocol.ts +++ b/private/aws-protocoltests-query/src/QueryProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -133,1041 +134,512 @@ import { XmlTimestampsCommandInput, XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; -import { QueryProtocolClient } from "./QueryProtocolClient"; +import { QueryProtocolClient, QueryProtocolClientConfig } from "./QueryProtocolClient"; -/** - * @public - * A query service that sends query requests and XML responses. - */ -export class QueryProtocol extends QueryProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FlattenedXmlMapCommand, + FlattenedXmlMapWithXmlNameCommand, + FlattenedXmlMapWithXmlNamespaceCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + IgnoresWrappingXmlNameCommand, + NestedStructuresCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryListsCommand, + QueryMapsCommand, + QueryTimestampsCommand, + RecursiveXmlShapesCommand, + SimpleInputParamsCommand, + SimpleScalarXmlPropertiesCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEmptyMapsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlMapsCommand, + XmlMapsXmlNameCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, +}; +export interface QueryProtocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response members. - * - * While this should be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps + * @see {@link FlattenedXmlMapCommand} */ - public flattenedXmlMap( + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): void; - public flattenedXmlMap( + flattenedXmlMap(args: FlattenedXmlMapCommandInput, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void): void; + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void ): void; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlName + * @see {@link FlattenedXmlMapWithXmlNameCommand} */ - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( - args: FlattenedXmlMapWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlNamespace and @xmlName + * @see {@link FlattenedXmlMapWithXmlNamespaceCommand} */ - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( - args: FlattenedXmlMapWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The xmlName trait on the output structure is ignored in AWS Query. - * - * The wrapping element is always operation name + "Response", and - * inside of that wrapper is another wrapper named operation name + "Result". + * @see {@link IgnoresWrappingXmlNameCommand} */ - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( - args: IgnoresWrappingXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void), - cb?: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void - ): Promise | void { - const command = new IgnoresWrappingXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes nested and recursive structure members. + * @see {@link NestedStructuresCommand} */ - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options?: __HttpHandlerOptions ): Promise; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( - args: NestedStructuresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedStructuresCommandOutput) => void), - cb?: (err: any, data?: NestedStructuresCommandOutput) => void - ): Promise | void { - const command = new NestedStructuresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request payload or response members. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex lists. + * @see {@link QueryListsCommand} */ - public queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; - public queryLists( + queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; + queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; + queryLists( args: QueryListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryListsCommandOutput) => void ): void; - public queryLists( - args: QueryListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryListsCommandOutput) => void), - cb?: (err: any, data?: QueryListsCommandOutput) => void - ): Promise | void { - const command = new QueryListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex maps. + * @see {@link QueryMapsCommand} */ - public queryMaps(args: QueryMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryMaps(args: QueryMapsCommandInput, cb: (err: any, data?: QueryMapsCommandOutput) => void): void; - public queryMaps( + queryMaps(args: QueryMapsCommandInput, options?: __HttpHandlerOptions): Promise; + queryMaps(args: QueryMapsCommandInput, cb: (err: any, data?: QueryMapsCommandOutput) => void): void; + queryMaps( args: QueryMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryMapsCommandOutput) => void ): void; - public queryMaps( - args: QueryMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryMapsCommandOutput) => void), - cb?: (err: any, data?: QueryMapsCommandOutput) => void - ): Promise | void { - const command = new QueryMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes timestamps. - * - * 1. Timestamps are serialized as RFC 3339 date-time values by default. - * 2. A timestampFormat trait on a member changes the format. - * 3. A timestampFormat trait on the shape targeted by the member changes the format. + * @see {@link QueryTimestampsCommand} */ - public queryTimestamps( + queryTimestamps( args: QueryTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryTimestamps( - args: QueryTimestampsCommandInput, - cb: (err: any, data?: QueryTimestampsCommandOutput) => void - ): void; - public queryTimestamps( + queryTimestamps(args: QueryTimestampsCommandInput, cb: (err: any, data?: QueryTimestampsCommandOutput) => void): void; + queryTimestamps( args: QueryTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryTimestampsCommandOutput) => void ): void; - public queryTimestamps( - args: QueryTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryTimestampsCommandOutput) => void), - cb?: (err: any, data?: QueryTimestampsCommandOutput) => void - ): Promise | void { - const command = new QueryTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveXmlShapesCommand} */ - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( - args: RecursiveXmlShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveXmlShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveXmlShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveXmlShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes strings, numbers, and boolean values. + * @see {@link SimpleInputParamsCommand} */ - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( - args: SimpleInputParamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleInputParamsCommandOutput) => void), - cb?: (err: any, data?: SimpleInputParamsCommandOutput) => void - ): Promise | void { - const command = new SimpleInputParamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarXmlPropertiesCommand} */ - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( - args: SimpleScalarXmlPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarXmlPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyMapsCommand} */ - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; - public xmlEmptyMaps( + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; + xmlEmptyMaps( args: XmlEmptyMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void ): void; - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyMapsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyMapsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Lists of structures. + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests basic map serialization. + * @see {@link XmlMapsCommand} */ - public xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; - public xmlMaps( + xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; + xmlMaps( args: XmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsCommandOutput) => void ): void; - public xmlMaps( - args: XmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsCommandOutput) => void), - cb?: (err: any, data?: XmlMapsCommandOutput) => void - ): Promise | void { - const command = new XmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlMapsXmlNameCommand} */ - public xmlMapsXmlName( + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): void; - public xmlMapsXmlName( + xmlMapsXmlName(args: XmlMapsXmlNameCommandInput, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void): void; + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void ): void; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsXmlNameCommandOutput) => void), - cb?: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): Promise | void { - const command = new XmlMapsXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + * A query service that sends query requests and XML responses. + */ +export class QueryProtocol extends QueryProtocolClient implements QueryProtocol { + public constructor(config: QueryProtocolClientConfig) { + const client = new QueryProtocolClient(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts b/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts index d33e3f2edd83..c505e022cd2f 100644 --- a/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts +++ b/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -431,2974 +432,1523 @@ import { UnitInputAndOutputCommandInput, UnitInputAndOutputCommandOutput, } from "./commands/UnitInputAndOutputCommand"; -import { RestJsonProtocolClient } from "./RestJsonProtocolClient"; +import { RestJsonProtocolClient, RestJsonProtocolClientConfig } from "./RestJsonProtocolClient"; -/** - * @public - * A REST JSON service that sends JSON requests and responses. - */ -export class RestJsonProtocol extends RestJsonProtocolClient { +const commands = { + AllQueryStringTypesCommand, + ConstantAndVariableQueryStringCommand, + ConstantQueryStringCommand, + DatetimeOffsetsCommand, + DocumentTypeCommand, + DocumentTypeAsPayloadCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + HttpChecksumRequiredCommand, + HttpEnumPayloadCommand, + HttpPayloadTraitsCommand, + HttpPayloadTraitsWithMediaTypeCommand, + HttpPayloadWithStructureCommand, + HttpPrefixHeadersCommand, + HttpPrefixHeadersInResponseCommand, + HttpRequestWithFloatLabelsCommand, + HttpRequestWithGreedyLabelInPathCommand, + HttpRequestWithLabelsCommand, + HttpRequestWithLabelsAndTimestampFormatCommand, + HttpRequestWithRegexLiteralCommand, + HttpResponseCodeCommand, + HttpStringPayloadCommand, + IgnoreQueryParamsInResponseCommand, + InputAndOutputWithHeadersCommand, + JsonBlobsCommand, + JsonEnumsCommand, + JsonIntEnumsCommand, + JsonListsCommand, + JsonMapsCommand, + JsonTimestampsCommand, + JsonUnionsCommand, + MalformedAcceptWithBodyCommand, + MalformedAcceptWithGenericStringCommand, + MalformedAcceptWithPayloadCommand, + MalformedBlobCommand, + MalformedBooleanCommand, + MalformedByteCommand, + MalformedContentTypeWithBodyCommand, + MalformedContentTypeWithGenericStringCommand, + MalformedContentTypeWithoutBodyCommand, + MalformedContentTypeWithPayloadCommand, + MalformedDoubleCommand, + MalformedFloatCommand, + MalformedIntegerCommand, + MalformedListCommand, + MalformedLongCommand, + MalformedMapCommand, + MalformedRequestBodyCommand, + MalformedShortCommand, + MalformedStringCommand, + MalformedTimestampBodyDateTimeCommand, + MalformedTimestampBodyDefaultCommand, + MalformedTimestampBodyHttpDateCommand, + MalformedTimestampHeaderDateTimeCommand, + MalformedTimestampHeaderDefaultCommand, + MalformedTimestampHeaderEpochCommand, + MalformedTimestampPathDefaultCommand, + MalformedTimestampPathEpochCommand, + MalformedTimestampPathHttpDateCommand, + MalformedTimestampQueryDefaultCommand, + MalformedTimestampQueryEpochCommand, + MalformedTimestampQueryHttpDateCommand, + MalformedUnionCommand, + MediaTypeHeaderCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + NullAndEmptyHeadersClientCommand, + NullAndEmptyHeadersServerCommand, + OmitsNullSerializesEmptyStringCommand, + OmitsSerializingEmptyListsCommand, + PostPlayerActionCommand, + PostUnionWithJsonNameCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryParamsAsStringListMapCommand, + QueryPrecedenceCommand, + RecursiveShapesCommand, + SimpleScalarPropertiesCommand, + StreamingTraitsCommand, + StreamingTraitsRequireLengthCommand, + StreamingTraitsWithMediaTypeCommand, + TestBodyStructureCommand, + TestNoPayloadCommand, + TestPayloadBlobCommand, + TestPayloadStructureCommand, + TimestampFormatHeadersCommand, + UnitInputAndOutputCommand, +}; +export interface RestJsonProtocol { /** - * @public - * This example uses all query string types. + * @see {@link AllQueryStringTypesCommand} */ - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( - args: AllQueryStringTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllQueryStringTypesCommandOutput) => void), - cb?: (err: any, data?: AllQueryStringTypesCommandOutput) => void - ): Promise | void { - const command = new AllQueryStringTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses fixed query string params and variable query string params. - * The fixed query string parameters and variable parameters must both be - * serialized (implementations may need to merge them together). + * @see {@link ConstantAndVariableQueryStringCommand} */ - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( - args: ConstantAndVariableQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantAndVariableQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses a constant query string parameters and a label. - * This simply tests that labels and query string parameters are - * compatible. The fixed query string parameter named "hello" should - * in no way conflict with the label, `\{hello\}`. + * @see {@link ConstantQueryStringCommand} */ - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( - args: ConstantQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes a document as part of the payload. + * @see {@link DocumentTypeCommand} */ - public documentType( - args: DocumentTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public documentType(args: DocumentTypeCommandInput, cb: (err: any, data?: DocumentTypeCommandOutput) => void): void; - public documentType( + documentType(args: DocumentTypeCommandInput, options?: __HttpHandlerOptions): Promise; + documentType(args: DocumentTypeCommandInput, cb: (err: any, data?: DocumentTypeCommandOutput) => void): void; + documentType( args: DocumentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DocumentTypeCommandOutput) => void ): void; - public documentType( - args: DocumentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DocumentTypeCommandOutput) => void), - cb?: (err: any, data?: DocumentTypeCommandOutput) => void - ): Promise | void { - const command = new DocumentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes a document as the entire HTTP payload. + * @see {@link DocumentTypeAsPayloadCommand} */ - public documentTypeAsPayload( + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public documentTypeAsPayload( + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, cb: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void ): void; - public documentTypeAsPayload( + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void ): void; - public documentTypeAsPayload( - args: DocumentTypeAsPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DocumentTypeAsPayloadCommandOutput) => void), - cb?: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void - ): Promise | void { - const command = new DocumentTypeAsPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has four possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. - * 4. A FooError. - * - * Implementations must be able to successfully take a response and - * properly (de)serialize successful and error responses based on the - * the presence of the + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example tests httpChecksumRequired trait + * @see {@link HttpChecksumRequiredCommand} */ - public httpChecksumRequired( + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpChecksumRequired( + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, cb: (err: any, data?: HttpChecksumRequiredCommandOutput) => void ): void; - public httpChecksumRequired( + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpChecksumRequiredCommandOutput) => void ): void; - public httpChecksumRequired( - args: HttpChecksumRequiredCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpChecksumRequiredCommandOutput) => void), - cb?: (err: any, data?: HttpChecksumRequiredCommandOutput) => void - ): Promise | void { - const command = new HttpChecksumRequiredCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpEnumPayloadCommand} */ - public httpEnumPayload( + httpEnumPayload( args: HttpEnumPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpEnumPayload( - args: HttpEnumPayloadCommandInput, - cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void - ): void; - public httpEnumPayload( + httpEnumPayload(args: HttpEnumPayloadCommandInput, cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void): void; + httpEnumPayload( args: HttpEnumPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void ): void; - public httpEnumPayload( - args: HttpEnumPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpEnumPayloadCommandOutput) => void), - cb?: (err: any, data?: HttpEnumPayloadCommandOutput) => void - ): Promise | void { - const command = new HttpEnumPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a blob shape in the payload. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. + * @see {@link HttpPayloadTraitsCommand} */ - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( - args: HttpPayloadTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. + * @see {@link HttpPayloadTraitsWithMediaTypeCommand} */ - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( - args: HttpPayloadTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a structure in the payload. - * - * Note that serializing a structure changes the wrapper element name - * to match the targeted structure. + * @see {@link HttpPayloadWithStructureCommand} */ - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( - args: HttpPayloadWithStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithStructureCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples adds headers to the input of a request and response by prefix. + * @see {@link HttpPrefixHeadersCommand} */ - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( - args: HttpPrefixHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Clients that perform this test extract all headers from the response. + * @see {@link HttpPrefixHeadersInResponseCommand} */ - public httpPrefixHeadersInResponse( + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeadersInResponse( + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, cb: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void ): void; - public httpPrefixHeadersInResponse( + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void ): void; - public httpPrefixHeadersInResponse( - args: HttpPrefixHeadersInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithFloatLabelsCommand} */ - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( - args: HttpRequestWithFloatLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithFloatLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithGreedyLabelInPathCommand} */ - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( - args: HttpRequestWithGreedyLabelInPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithGreedyLabelInPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests are serialized when there's no input - * payload but there are HTTP labels. + * @see {@link HttpRequestWithLabelsCommand} */ - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( - args: HttpRequestWithLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests serialize different timestamp formats in the - * URI path. + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommand} */ - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( - args: HttpRequestWithLabelsAndTimestampFormatCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsAndTimestampFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithRegexLiteralCommand} */ - public httpRequestWithRegexLiteral( + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithRegexLiteral( + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, cb: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void ): void; - public httpRequestWithRegexLiteral( + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void ): void; - public httpRequestWithRegexLiteral( - args: HttpRequestWithRegexLiteralCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithRegexLiteralCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpResponseCodeCommand} */ - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( - args: HttpResponseCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpResponseCodeCommandOutput) => void), - cb?: (err: any, data?: HttpResponseCodeCommandOutput) => void - ): Promise | void { - const command = new HttpResponseCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpStringPayloadCommand} */ - public httpStringPayload( + httpStringPayload( args: HttpStringPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpStringPayload( + httpStringPayload( args: HttpStringPayloadCommandInput, cb: (err: any, data?: HttpStringPayloadCommandOutput) => void ): void; - public httpStringPayload( + httpStringPayload( args: HttpStringPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpStringPayloadCommandOutput) => void ): void; - public httpStringPayload( - args: HttpStringPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpStringPayloadCommandOutput) => void), - cb?: (err: any, data?: HttpStringPayloadCommandOutput) => void - ): Promise | void { - const command = new HttpStringPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example ensures that query string bound request parameters are - * serialized in the body of responses if the structure is used in both - * the request and response. + * @see {@link IgnoreQueryParamsInResponseCommand} */ - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( - args: IgnoreQueryParamsInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void), - cb?: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void - ): Promise | void { - const command = new IgnoreQueryParamsInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there is - * no input or output payload but there are HTTP header bindings. + * @see {@link InputAndOutputWithHeadersCommand} */ - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( - args: InputAndOutputWithHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InputAndOutputWithHeadersCommandOutput) => void), - cb?: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void - ): Promise | void { - const command = new InputAndOutputWithHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link JsonBlobsCommand} */ - public jsonBlobs(args: JsonBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonBlobs(args: JsonBlobsCommandInput, cb: (err: any, data?: JsonBlobsCommandOutput) => void): void; - public jsonBlobs( + jsonBlobs(args: JsonBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonBlobs(args: JsonBlobsCommandInput, cb: (err: any, data?: JsonBlobsCommandOutput) => void): void; + jsonBlobs( args: JsonBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonBlobsCommandOutput) => void ): void; - public jsonBlobs( - args: JsonBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonBlobsCommandOutput) => void), - cb?: (err: any, data?: JsonBlobsCommandOutput) => void - ): Promise | void { - const command = new JsonBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link JsonEnumsCommand} */ - public jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; - public jsonEnums( + jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; + jsonEnums( args: JsonEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonEnumsCommandOutput) => void ): void; - public jsonEnums( - args: JsonEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes intEnums as top level properties, in lists, sets, and maps. + * @see {@link JsonIntEnumsCommand} */ - public jsonIntEnums( - args: JsonIntEnumsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public jsonIntEnums(args: JsonIntEnumsCommandInput, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void): void; - public jsonIntEnums( + jsonIntEnums(args: JsonIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonIntEnums(args: JsonIntEnumsCommandInput, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void): void; + jsonIntEnums( args: JsonIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void ): void; - public jsonIntEnums( - args: JsonIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonIntEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonIntEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes JSON lists for the following cases for both - * input and output: - * - * 1. Normal JSON lists. - * 2. Normal JSON sets. - * 3. JSON lists of lists. - * 4. Lists of structures. + * @see {@link JsonListsCommand} */ - public jsonLists(args: JsonListsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonLists(args: JsonListsCommandInput, cb: (err: any, data?: JsonListsCommandOutput) => void): void; - public jsonLists( + jsonLists(args: JsonListsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonLists(args: JsonListsCommandInput, cb: (err: any, data?: JsonListsCommandOutput) => void): void; + jsonLists( args: JsonListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonListsCommandOutput) => void ): void; - public jsonLists( - args: JsonListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonListsCommandOutput) => void), - cb?: (err: any, data?: JsonListsCommandOutput) => void - ): Promise | void { - const command = new JsonListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests basic map serialization. + * @see {@link JsonMapsCommand} */ - public jsonMaps(args: JsonMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonMaps(args: JsonMapsCommandInput, cb: (err: any, data?: JsonMapsCommandOutput) => void): void; - public jsonMaps( + jsonMaps(args: JsonMapsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonMaps(args: JsonMapsCommandInput, cb: (err: any, data?: JsonMapsCommandOutput) => void): void; + jsonMaps( args: JsonMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonMapsCommandOutput) => void ): void; - public jsonMaps( - args: JsonMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonMapsCommandOutput) => void), - cb?: (err: any, data?: JsonMapsCommandOutput) => void - ): Promise | void { - const command = new JsonMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link JsonTimestampsCommand} */ - public jsonTimestamps( + jsonTimestamps( args: JsonTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public jsonTimestamps( - args: JsonTimestampsCommandInput, - cb: (err: any, data?: JsonTimestampsCommandOutput) => void - ): void; - public jsonTimestamps( + jsonTimestamps(args: JsonTimestampsCommandInput, cb: (err: any, data?: JsonTimestampsCommandOutput) => void): void; + jsonTimestamps( args: JsonTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonTimestampsCommandOutput) => void ): void; - public jsonTimestamps( - args: JsonTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonTimestampsCommandOutput) => void), - cb?: (err: any, data?: JsonTimestampsCommandOutput) => void - ): Promise | void { - const command = new JsonTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation uses unions for inputs and outputs. + * @see {@link JsonUnionsCommand} */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedAcceptWithBodyCommand} */ - public malformedAcceptWithBody( + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithBody( + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, cb: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void ): void; - public malformedAcceptWithBody( + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void ): void; - public malformedAcceptWithBody( - args: MalformedAcceptWithBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedAcceptWithGenericStringCommand} */ - public malformedAcceptWithGenericString( + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithGenericString( + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, cb: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void ): void; - public malformedAcceptWithGenericString( + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void ): void; - public malformedAcceptWithGenericString( - args: MalformedAcceptWithGenericStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithGenericStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedAcceptWithPayloadCommand} */ - public malformedAcceptWithPayload( + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithPayload( + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, cb: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void ): void; - public malformedAcceptWithPayload( + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void ): void; - public malformedAcceptWithPayload( - args: MalformedAcceptWithPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedBlobCommand} */ - public malformedBlob( - args: MalformedBlobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedBlob( - args: MalformedBlobCommandInput, - cb: (err: any, data?: MalformedBlobCommandOutput) => void - ): void; - public malformedBlob( + malformedBlob(args: MalformedBlobCommandInput, options?: __HttpHandlerOptions): Promise; + malformedBlob(args: MalformedBlobCommandInput, cb: (err: any, data?: MalformedBlobCommandOutput) => void): void; + malformedBlob( args: MalformedBlobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedBlobCommandOutput) => void ): void; - public malformedBlob( - args: MalformedBlobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedBlobCommandOutput) => void), - cb?: (err: any, data?: MalformedBlobCommandOutput) => void - ): Promise | void { - const command = new MalformedBlobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedBooleanCommand} */ - public malformedBoolean( + malformedBoolean( args: MalformedBooleanCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedBoolean( + malformedBoolean( args: MalformedBooleanCommandInput, cb: (err: any, data?: MalformedBooleanCommandOutput) => void ): void; - public malformedBoolean( + malformedBoolean( args: MalformedBooleanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedBooleanCommandOutput) => void ): void; - public malformedBoolean( - args: MalformedBooleanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedBooleanCommandOutput) => void), - cb?: (err: any, data?: MalformedBooleanCommandOutput) => void - ): Promise | void { - const command = new MalformedBooleanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedByteCommand} */ - public malformedByte( - args: MalformedByteCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedByte( - args: MalformedByteCommandInput, - cb: (err: any, data?: MalformedByteCommandOutput) => void - ): void; - public malformedByte( + malformedByte(args: MalformedByteCommandInput, options?: __HttpHandlerOptions): Promise; + malformedByte(args: MalformedByteCommandInput, cb: (err: any, data?: MalformedByteCommandOutput) => void): void; + malformedByte( args: MalformedByteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedByteCommandOutput) => void ): void; - public malformedByte( - args: MalformedByteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedByteCommandOutput) => void), - cb?: (err: any, data?: MalformedByteCommandOutput) => void - ): Promise | void { - const command = new MalformedByteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedContentTypeWithBodyCommand} */ - public malformedContentTypeWithBody( + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithBody( + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, cb: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void ): void; - public malformedContentTypeWithBody( + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void ): void; - public malformedContentTypeWithBody( - args: MalformedContentTypeWithBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedContentTypeWithGenericStringCommand} */ - public malformedContentTypeWithGenericString( + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithGenericString( + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, cb: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void ): void; - public malformedContentTypeWithGenericString( + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void ): void; - public malformedContentTypeWithGenericString( - args: MalformedContentTypeWithGenericStringCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithGenericStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedContentTypeWithoutBodyCommand} */ - public malformedContentTypeWithoutBody( + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithoutBody( + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, cb: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void ): void; - public malformedContentTypeWithoutBody( + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void ): void; - public malformedContentTypeWithoutBody( - args: MalformedContentTypeWithoutBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithoutBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedContentTypeWithPayloadCommand} */ - public malformedContentTypeWithPayload( + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithPayload( + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, cb: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void ): void; - public malformedContentTypeWithPayload( + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void ): void; - public malformedContentTypeWithPayload( - args: MalformedContentTypeWithPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedDoubleCommand} */ - public malformedDouble( + malformedDouble( args: MalformedDoubleCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedDouble( - args: MalformedDoubleCommandInput, - cb: (err: any, data?: MalformedDoubleCommandOutput) => void - ): void; - public malformedDouble( + malformedDouble(args: MalformedDoubleCommandInput, cb: (err: any, data?: MalformedDoubleCommandOutput) => void): void; + malformedDouble( args: MalformedDoubleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedDoubleCommandOutput) => void ): void; - public malformedDouble( - args: MalformedDoubleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedDoubleCommandOutput) => void), - cb?: (err: any, data?: MalformedDoubleCommandOutput) => void - ): Promise | void { - const command = new MalformedDoubleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedFloatCommand} */ - public malformedFloat( + malformedFloat( args: MalformedFloatCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedFloat( - args: MalformedFloatCommandInput, - cb: (err: any, data?: MalformedFloatCommandOutput) => void - ): void; - public malformedFloat( + malformedFloat(args: MalformedFloatCommandInput, cb: (err: any, data?: MalformedFloatCommandOutput) => void): void; + malformedFloat( args: MalformedFloatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedFloatCommandOutput) => void ): void; - public malformedFloat( - args: MalformedFloatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedFloatCommandOutput) => void), - cb?: (err: any, data?: MalformedFloatCommandOutput) => void - ): Promise | void { - const command = new MalformedFloatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedIntegerCommand} */ - public malformedInteger( + malformedInteger( args: MalformedIntegerCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedInteger( + malformedInteger( args: MalformedIntegerCommandInput, cb: (err: any, data?: MalformedIntegerCommandOutput) => void ): void; - public malformedInteger( + malformedInteger( args: MalformedIntegerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedIntegerCommandOutput) => void ): void; - public malformedInteger( - args: MalformedIntegerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedIntegerCommandOutput) => void), - cb?: (err: any, data?: MalformedIntegerCommandOutput) => void - ): Promise | void { - const command = new MalformedIntegerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedListCommand} */ - public malformedList( - args: MalformedListCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedList( - args: MalformedListCommandInput, - cb: (err: any, data?: MalformedListCommandOutput) => void - ): void; - public malformedList( + malformedList(args: MalformedListCommandInput, options?: __HttpHandlerOptions): Promise; + malformedList(args: MalformedListCommandInput, cb: (err: any, data?: MalformedListCommandOutput) => void): void; + malformedList( args: MalformedListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedListCommandOutput) => void ): void; - public malformedList( - args: MalformedListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedListCommandOutput) => void), - cb?: (err: any, data?: MalformedListCommandOutput) => void - ): Promise | void { - const command = new MalformedListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedLongCommand} */ - public malformedLong( - args: MalformedLongCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedLong( - args: MalformedLongCommandInput, - cb: (err: any, data?: MalformedLongCommandOutput) => void - ): void; - public malformedLong( + malformedLong(args: MalformedLongCommandInput, options?: __HttpHandlerOptions): Promise; + malformedLong(args: MalformedLongCommandInput, cb: (err: any, data?: MalformedLongCommandOutput) => void): void; + malformedLong( args: MalformedLongCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedLongCommandOutput) => void ): void; - public malformedLong( - args: MalformedLongCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedLongCommandOutput) => void), - cb?: (err: any, data?: MalformedLongCommandOutput) => void - ): Promise | void { - const command = new MalformedLongCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedMapCommand} */ - public malformedMap( - args: MalformedMapCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedMap(args: MalformedMapCommandInput, cb: (err: any, data?: MalformedMapCommandOutput) => void): void; - public malformedMap( + malformedMap(args: MalformedMapCommandInput, options?: __HttpHandlerOptions): Promise; + malformedMap(args: MalformedMapCommandInput, cb: (err: any, data?: MalformedMapCommandOutput) => void): void; + malformedMap( args: MalformedMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedMapCommandOutput) => void ): void; - public malformedMap( - args: MalformedMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedMapCommandOutput) => void), - cb?: (err: any, data?: MalformedMapCommandOutput) => void - ): Promise | void { - const command = new MalformedMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedRequestBodyCommand} */ - public malformedRequestBody( + malformedRequestBody( args: MalformedRequestBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedRequestBody( + malformedRequestBody( args: MalformedRequestBodyCommandInput, cb: (err: any, data?: MalformedRequestBodyCommandOutput) => void ): void; - public malformedRequestBody( + malformedRequestBody( args: MalformedRequestBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedRequestBodyCommandOutput) => void ): void; - public malformedRequestBody( - args: MalformedRequestBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedRequestBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedRequestBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedRequestBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedShortCommand} */ - public malformedShort( + malformedShort( args: MalformedShortCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedShort( - args: MalformedShortCommandInput, - cb: (err: any, data?: MalformedShortCommandOutput) => void - ): void; - public malformedShort( + malformedShort(args: MalformedShortCommandInput, cb: (err: any, data?: MalformedShortCommandOutput) => void): void; + malformedShort( args: MalformedShortCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedShortCommandOutput) => void ): void; - public malformedShort( - args: MalformedShortCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedShortCommandOutput) => void), - cb?: (err: any, data?: MalformedShortCommandOutput) => void - ): Promise | void { - const command = new MalformedShortCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedStringCommand} */ - public malformedString( + malformedString( args: MalformedStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedString( - args: MalformedStringCommandInput, - cb: (err: any, data?: MalformedStringCommandOutput) => void - ): void; - public malformedString( + malformedString(args: MalformedStringCommandInput, cb: (err: any, data?: MalformedStringCommandOutput) => void): void; + malformedString( args: MalformedStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedStringCommandOutput) => void ): void; - public malformedString( - args: MalformedStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedStringCommandOutput) => void), - cb?: (err: any, data?: MalformedStringCommandOutput) => void - ): Promise | void { - const command = new MalformedStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampBodyDateTimeCommand} */ - public malformedTimestampBodyDateTime( + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyDateTime( + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, cb: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void ): void; - public malformedTimestampBodyDateTime( + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void ): void; - public malformedTimestampBodyDateTime( - args: MalformedTimestampBodyDateTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyDateTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampBodyDefaultCommand} */ - public malformedTimestampBodyDefault( + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyDefault( + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, cb: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void ): void; - public malformedTimestampBodyDefault( + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void ): void; - public malformedTimestampBodyDefault( - args: MalformedTimestampBodyDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampBodyHttpDateCommand} */ - public malformedTimestampBodyHttpDate( + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyHttpDate( + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void ): void; - public malformedTimestampBodyHttpDate( + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void ): void; - public malformedTimestampBodyHttpDate( - args: MalformedTimestampBodyHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampHeaderDateTimeCommand} */ - public malformedTimestampHeaderDateTime( + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderDateTime( + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, cb: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void ): void; - public malformedTimestampHeaderDateTime( + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void ): void; - public malformedTimestampHeaderDateTime( - args: MalformedTimestampHeaderDateTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderDateTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampHeaderDefaultCommand} */ - public malformedTimestampHeaderDefault( + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderDefault( + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, cb: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void ): void; - public malformedTimestampHeaderDefault( + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void ): void; - public malformedTimestampHeaderDefault( - args: MalformedTimestampHeaderDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampHeaderEpochCommand} */ - public malformedTimestampHeaderEpoch( + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderEpoch( + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, cb: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void ): void; - public malformedTimestampHeaderEpoch( + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void ): void; - public malformedTimestampHeaderEpoch( - args: MalformedTimestampHeaderEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampPathDefaultCommand} */ - public malformedTimestampPathDefault( + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathDefault( + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, cb: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void ): void; - public malformedTimestampPathDefault( + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void ): void; - public malformedTimestampPathDefault( - args: MalformedTimestampPathDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampPathEpochCommand} */ - public malformedTimestampPathEpoch( + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathEpoch( + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, cb: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void ): void; - public malformedTimestampPathEpoch( + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void ): void; - public malformedTimestampPathEpoch( - args: MalformedTimestampPathEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampPathHttpDateCommand} */ - public malformedTimestampPathHttpDate( + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathHttpDate( + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void ): void; - public malformedTimestampPathHttpDate( + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void ): void; - public malformedTimestampPathHttpDate( - args: MalformedTimestampPathHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampQueryDefaultCommand} */ - public malformedTimestampQueryDefault( + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryDefault( + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, cb: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void ): void; - public malformedTimestampQueryDefault( + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void ): void; - public malformedTimestampQueryDefault( - args: MalformedTimestampQueryDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampQueryEpochCommand} */ - public malformedTimestampQueryEpoch( + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryEpoch( + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, cb: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void ): void; - public malformedTimestampQueryEpoch( + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void ): void; - public malformedTimestampQueryEpoch( - args: MalformedTimestampQueryEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedTimestampQueryHttpDateCommand} */ - public malformedTimestampQueryHttpDate( + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryHttpDate( + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void ): void; - public malformedTimestampQueryHttpDate( + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void ): void; - public malformedTimestampQueryHttpDate( - args: MalformedTimestampQueryHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link MalformedUnionCommand} */ - public malformedUnion( + malformedUnion( args: MalformedUnionCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedUnion( - args: MalformedUnionCommandInput, - cb: (err: any, data?: MalformedUnionCommandOutput) => void - ): void; - public malformedUnion( + malformedUnion(args: MalformedUnionCommandInput, cb: (err: any, data?: MalformedUnionCommandOutput) => void): void; + malformedUnion( args: MalformedUnionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedUnionCommandOutput) => void ): void; - public malformedUnion( - args: MalformedUnionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedUnionCommandOutput) => void), - cb?: (err: any, data?: MalformedUnionCommandOutput) => void - ): Promise | void { - const command = new MalformedUnionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example ensures that mediaType strings are base64 encoded in headers. + * @see {@link MediaTypeHeaderCommand} */ - public mediaTypeHeader( + mediaTypeHeader( args: MediaTypeHeaderCommandInput, options?: __HttpHandlerOptions ): Promise; - public mediaTypeHeader( - args: MediaTypeHeaderCommandInput, - cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void - ): void; - public mediaTypeHeader( + mediaTypeHeader(args: MediaTypeHeaderCommandInput, cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void): void; + mediaTypeHeader( args: MediaTypeHeaderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void ): void; - public mediaTypeHeader( - args: MediaTypeHeaderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MediaTypeHeaderCommandOutput) => void), - cb?: (err: any, data?: MediaTypeHeaderCommandOutput) => void - ): Promise | void { - const command = new MediaTypeHeaderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersClientCommand} */ - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( - args: NullAndEmptyHeadersClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersServerCommand} */ - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( - args: NullAndEmptyHeadersServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Omits null, but serializes empty string value. + * @see {@link OmitsNullSerializesEmptyStringCommand} */ - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( - args: OmitsNullSerializesEmptyStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void), - cb?: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void - ): Promise | void { - const command = new OmitsNullSerializesEmptyStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Omits serializing empty lists. Because empty strings are serilized as - * `Foo=`, empty lists cannot also be serialized as `Foo=` and instead - * must be omitted. + * @see {@link OmitsSerializingEmptyListsCommand} */ - public omitsSerializingEmptyLists( + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsSerializingEmptyLists( + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, cb: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void ): void; - public omitsSerializingEmptyLists( + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void ): void; - public omitsSerializingEmptyLists( - args: OmitsSerializingEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void), - cb?: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void - ): Promise | void { - const command = new OmitsSerializingEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation defines a union with a Unit member. + * @see {@link PostPlayerActionCommand} */ - public postPlayerAction( + postPlayerAction( args: PostPlayerActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public postPlayerAction( + postPlayerAction( args: PostPlayerActionCommandInput, cb: (err: any, data?: PostPlayerActionCommandOutput) => void ): void; - public postPlayerAction( + postPlayerAction( args: PostPlayerActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostPlayerActionCommandOutput) => void ): void; - public postPlayerAction( - args: PostPlayerActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostPlayerActionCommandOutput) => void), - cb?: (err: any, data?: PostPlayerActionCommandOutput) => void - ): Promise | void { - const command = new PostPlayerActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation defines a union that uses jsonName on some members. + * @see {@link PostUnionWithJsonNameCommand} */ - public postUnionWithJsonName( + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public postUnionWithJsonName( + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, cb: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void ): void; - public postUnionWithJsonName( + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void ): void; - public postUnionWithJsonName( - args: PostUnionWithJsonNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostUnionWithJsonNameCommandOutput) => void), - cb?: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void - ): Promise | void { - const command = new PostUnionWithJsonNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryParamsAsStringListMapCommand} */ - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( - args: QueryParamsAsStringListMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryParamsAsStringListMapCommandOutput) => void), - cb?: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void - ): Promise | void { - const command = new QueryParamsAsStringListMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryPrecedenceCommand} */ - public queryPrecedence( + queryPrecedence( args: QueryPrecedenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - cb: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): void; - public queryPrecedence( + queryPrecedence(args: QueryPrecedenceCommandInput, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void): void; + queryPrecedence( args: QueryPrecedenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void ): void; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryPrecedenceCommandOutput) => void), - cb?: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): Promise | void { - const command = new QueryPrecedenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveShapesCommand} */ - public recursiveShapes( + recursiveShapes( args: RecursiveShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveShapes( - args: RecursiveShapesCommandInput, - cb: (err: any, data?: RecursiveShapesCommandOutput) => void - ): void; - public recursiveShapes( + recursiveShapes(args: RecursiveShapesCommandInput, cb: (err: any, data?: RecursiveShapesCommandOutput) => void): void; + recursiveShapes( args: RecursiveShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveShapesCommandOutput) => void ): void; - public recursiveShapes( - args: RecursiveShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a streaming blob shape in the request body. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. + * @see {@link StreamingTraitsCommand} */ - public streamingTraits( + streamingTraits( args: StreamingTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraits( - args: StreamingTraitsCommandInput, - cb: (err: any, data?: StreamingTraitsCommandOutput) => void - ): void; - public streamingTraits( + streamingTraits(args: StreamingTraitsCommandInput, cb: (err: any, data?: StreamingTraitsCommandOutput) => void): void; + streamingTraits( args: StreamingTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsCommandOutput) => void ): void; - public streamingTraits( - args: StreamingTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a streaming blob shape with a required content - * length in the request body. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. + * @see {@link StreamingTraitsRequireLengthCommand} */ - public streamingTraitsRequireLength( + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraitsRequireLength( + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, cb: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void ): void; - public streamingTraitsRequireLength( + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void ): void; - public streamingTraitsRequireLength( - args: StreamingTraitsRequireLengthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsRequireLengthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a streaming media-typed blob shape in the request body. - * - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. + * @see {@link StreamingTraitsWithMediaTypeCommand} */ - public streamingTraitsWithMediaType( + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraitsWithMediaType( + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, cb: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void ): void; - public streamingTraitsWithMediaType( + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void ): void; - public streamingTraitsWithMediaType( - args: StreamingTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example operation serializes a structure in the HTTP body. - * - * It should ensure Content-Type: application/json is - * used in all requests and that an "empty" body is - * an empty JSON document (\{\}). - * + * @see {@link TestBodyStructureCommand} */ - public testBodyStructure( + testBodyStructure( args: TestBodyStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public testBodyStructure( + testBodyStructure( args: TestBodyStructureCommandInput, cb: (err: any, data?: TestBodyStructureCommandOutput) => void ): void; - public testBodyStructure( + testBodyStructure( args: TestBodyStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestBodyStructureCommandOutput) => void ): void; - public testBodyStructure( - args: TestBodyStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestBodyStructureCommandOutput) => void), - cb?: (err: any, data?: TestBodyStructureCommandOutput) => void - ): Promise | void { - const command = new TestBodyStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example operation serializes a request without an HTTP body. - * - * These tests are to ensure we do not attach a body or related headers - * (Content-Length, Content-Type) to operations that semantically - * cannot produce an HTTP body. - * + * @see {@link TestNoPayloadCommand} */ - public testNoPayload( - args: TestNoPayloadCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public testNoPayload( - args: TestNoPayloadCommandInput, - cb: (err: any, data?: TestNoPayloadCommandOutput) => void - ): void; - public testNoPayload( + testNoPayload(args: TestNoPayloadCommandInput, options?: __HttpHandlerOptions): Promise; + testNoPayload(args: TestNoPayloadCommandInput, cb: (err: any, data?: TestNoPayloadCommandOutput) => void): void; + testNoPayload( args: TestNoPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestNoPayloadCommandOutput) => void ): void; - public testNoPayload( - args: TestNoPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestNoPayloadCommandOutput) => void), - cb?: (err: any, data?: TestNoPayloadCommandOutput) => void - ): Promise | void { - const command = new TestNoPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example operation serializes a payload targeting a blob. - * - * The Blob shape is not structured content and we cannot - * make assumptions about what data will be sent. This test ensures - * only a generic "Content-Type: application/octet-stream" header - * is used, and that we are not treating an empty body as an - * empty JSON document. - * + * @see {@link TestPayloadBlobCommand} */ - public testPayloadBlob( + testPayloadBlob( args: TestPayloadBlobCommandInput, options?: __HttpHandlerOptions ): Promise; - public testPayloadBlob( - args: TestPayloadBlobCommandInput, - cb: (err: any, data?: TestPayloadBlobCommandOutput) => void - ): void; - public testPayloadBlob( + testPayloadBlob(args: TestPayloadBlobCommandInput, cb: (err: any, data?: TestPayloadBlobCommandOutput) => void): void; + testPayloadBlob( args: TestPayloadBlobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestPayloadBlobCommandOutput) => void ): void; - public testPayloadBlob( - args: TestPayloadBlobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestPayloadBlobCommandOutput) => void), - cb?: (err: any, data?: TestPayloadBlobCommandOutput) => void - ): Promise | void { - const command = new TestPayloadBlobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example operation serializes a payload targeting a structure. - * - * This enforces the same requirements as TestBodyStructure - * but with the body specified by the @httpPayload trait. - * + * @see {@link TestPayloadStructureCommand} */ - public testPayloadStructure( + testPayloadStructure( args: TestPayloadStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public testPayloadStructure( + testPayloadStructure( args: TestPayloadStructureCommandInput, cb: (err: any, data?: TestPayloadStructureCommandOutput) => void ): void; - public testPayloadStructure( + testPayloadStructure( args: TestPayloadStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestPayloadStructureCommandOutput) => void ): void; - public testPayloadStructure( - args: TestPayloadStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestPayloadStructureCommandOutput) => void), - cb?: (err: any, data?: TestPayloadStructureCommandOutput) => void - ): Promise | void { - const command = new TestPayloadStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example tests how timestamp request and response headers are serialized. + * @see {@link TimestampFormatHeadersCommand} */ - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( - args: TimestampFormatHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TimestampFormatHeadersCommandOutput) => void), - cb?: (err: any, data?: TimestampFormatHeadersCommandOutput) => void - ): Promise | void { - const command = new TimestampFormatHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test is similar to NoInputAndNoOutput, but uses explicit Unit types. + * @see {@link UnitInputAndOutputCommand} */ - public unitInputAndOutput( + unitInputAndOutput( args: UnitInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public unitInputAndOutput( + unitInputAndOutput( args: UnitInputAndOutputCommandInput, cb: (err: any, data?: UnitInputAndOutputCommandOutput) => void ): void; - public unitInputAndOutput( + unitInputAndOutput( args: UnitInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnitInputAndOutputCommandOutput) => void ): void; - public unitInputAndOutput( - args: UnitInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnitInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: UnitInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new UnitInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + * A REST JSON service that sends JSON requests and responses. + */ +export class RestJsonProtocol extends RestJsonProtocolClient implements RestJsonProtocol { + public constructor(config: RestJsonProtocolClientConfig) { + const client = new RestJsonProtocolClient(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts b/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts index 28a4c46cb64a..216993348637 100644 --- a/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts +++ b/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createProxyClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -257,1852 +258,929 @@ import { XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; import { XmlUnionsCommand, XmlUnionsCommandInput, XmlUnionsCommandOutput } from "./commands/XmlUnionsCommand"; -import { RestXmlProtocolClient } from "./RestXmlProtocolClient"; +import { RestXmlProtocolClient, RestXmlProtocolClientConfig } from "./RestXmlProtocolClient"; -/** - * @public - * A REST XML service that sends XML requests and responses. - */ -export class RestXmlProtocol extends RestXmlProtocolClient { +const commands = { + AllQueryStringTypesCommand, + BodyWithXmlNameCommand, + ConstantAndVariableQueryStringCommand, + ConstantQueryStringCommand, + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelHeaderOperationCommand, + EndpointWithHostLabelOperationCommand, + FlattenedXmlMapCommand, + FlattenedXmlMapWithXmlNameCommand, + FlattenedXmlMapWithXmlNamespaceCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HttpPayloadTraitsCommand, + HttpPayloadTraitsWithMediaTypeCommand, + HttpPayloadWithMemberXmlNameCommand, + HttpPayloadWithStructureCommand, + HttpPayloadWithXmlNameCommand, + HttpPayloadWithXmlNamespaceCommand, + HttpPayloadWithXmlNamespaceAndPrefixCommand, + HttpPrefixHeadersCommand, + HttpRequestWithFloatLabelsCommand, + HttpRequestWithGreedyLabelInPathCommand, + HttpRequestWithLabelsCommand, + HttpRequestWithLabelsAndTimestampFormatCommand, + HttpResponseCodeCommand, + IgnoreQueryParamsInResponseCommand, + InputAndOutputWithHeadersCommand, + NestedXmlMapsCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + NullAndEmptyHeadersClientCommand, + NullAndEmptyHeadersServerCommand, + OmitsNullSerializesEmptyStringCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryParamsAsStringListMapCommand, + QueryPrecedenceCommand, + RecursiveShapesCommand, + SimpleScalarPropertiesCommand, + TimestampFormatHeadersCommand, + XmlAttributesCommand, + XmlAttributesOnPayloadCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEmptyMapsCommand, + XmlEmptyStringsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlMapsCommand, + XmlMapsXmlNameCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, + XmlUnionsCommand, +}; +export interface RestXmlProtocol { /** - * @public - * This example uses all query string types. + * @see {@link AllQueryStringTypesCommand} */ - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( - args: AllQueryStringTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllQueryStringTypesCommandOutput) => void), - cb?: (err: any, data?: AllQueryStringTypesCommandOutput) => void - ): Promise | void { - const command = new AllQueryStringTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a body that uses an XML name, - * changing the wrapper name. + * @see {@link BodyWithXmlNameCommand} */ - public bodyWithXmlName( + bodyWithXmlName( args: BodyWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public bodyWithXmlName( - args: BodyWithXmlNameCommandInput, - cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void - ): void; - public bodyWithXmlName( + bodyWithXmlName(args: BodyWithXmlNameCommandInput, cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void): void; + bodyWithXmlName( args: BodyWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void ): void; - public bodyWithXmlName( - args: BodyWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BodyWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: BodyWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new BodyWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses fixed query string params and variable query string params. - * The fixed query string parameters and variable parameters must both be - * serialized (implementations may need to merge them together). + * @see {@link ConstantAndVariableQueryStringCommand} */ - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( - args: ConstantAndVariableQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantAndVariableQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses a constant query string parameters and a label. - * This simply tests that labels and query string parameters are - * compatible. The fixed query string parameter named "hello" should - * in no way conflict with the label, `\{hello\}`. + * @see {@link ConstantQueryStringCommand} */ - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( - args: ConstantQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelHeaderOperationCommand} */ - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void ): void; - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void ): void; - public endpointWithHostLabelHeaderOperation( - args: EndpointWithHostLabelHeaderOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelHeaderOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps + * @see {@link FlattenedXmlMapCommand} */ - public flattenedXmlMap( + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): void; - public flattenedXmlMap( + flattenedXmlMap(args: FlattenedXmlMapCommandInput, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void): void; + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void ): void; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlName + * @see {@link FlattenedXmlMapWithXmlNameCommand} */ - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( - args: FlattenedXmlMapWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlNamespace and @xmlName + * @see {@link FlattenedXmlMapWithXmlNamespaceCommand} */ - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( - args: FlattenedXmlMapWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. - * - * Implementations must be able to successfully take a response and - * properly (de)serialize successful and error responses based on the - * the presence of the + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a blob shape in the payload. - * - * In this example, no XML document is synthesized because the payload is - * not a structure or a union type. + * @see {@link HttpPayloadTraitsCommand} */ - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( - args: HttpPayloadTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. + * @see {@link HttpPayloadTraitsWithMediaTypeCommand} */ - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( - args: HttpPayloadTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML name - * on the member, changing the wrapper name. + * @see {@link HttpPayloadWithMemberXmlNameCommand} */ - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, cb: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void ): void; - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void ): void; - public httpPayloadWithMemberXmlName( - args: HttpPayloadWithMemberXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithMemberXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a structure in the payload. - * - * Note that serializing a structure changes the wrapper element name - * to match the targeted structure. + * @see {@link HttpPayloadWithStructureCommand} */ - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( - args: HttpPayloadWithStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithStructureCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML name, - * changing the wrapper name. + * @see {@link HttpPayloadWithXmlNameCommand} */ - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void ): void; - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void ): void; - public httpPayloadWithXmlName( - args: HttpPayloadWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML namespace. + * @see {@link HttpPayloadWithXmlNamespaceCommand} */ - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void ): void; - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void ): void; - public httpPayloadWithXmlNamespace( - args: HttpPayloadWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML namespace. + * @see {@link HttpPayloadWithXmlNamespaceAndPrefixCommand} */ - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void ): void; - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void ): void; - public httpPayloadWithXmlNamespaceAndPrefix( - args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNamespaceAndPrefixCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples adds headers to the input of a request and response by prefix. + * @see {@link HttpPrefixHeadersCommand} */ - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( - args: HttpPrefixHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithFloatLabelsCommand} */ - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( - args: HttpRequestWithFloatLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithFloatLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithGreedyLabelInPathCommand} */ - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( - args: HttpRequestWithGreedyLabelInPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithGreedyLabelInPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests are serialized when there's no input - * payload but there are HTTP labels. + * @see {@link HttpRequestWithLabelsCommand} */ - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( - args: HttpRequestWithLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests serialize different timestamp formats in the - * URI path. + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommand} */ - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( - args: HttpRequestWithLabelsAndTimestampFormatCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsAndTimestampFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpResponseCodeCommand} */ - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( - args: HttpResponseCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpResponseCodeCommandOutput) => void), - cb?: (err: any, data?: HttpResponseCodeCommandOutput) => void - ): Promise | void { - const command = new HttpResponseCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example ensures that query string bound request parameters are - * serialized in the body of responses if the structure is used in both - * the request and response. + * @see {@link IgnoreQueryParamsInResponseCommand} */ - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( - args: IgnoreQueryParamsInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void), - cb?: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void - ): Promise | void { - const command = new IgnoreQueryParamsInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there is - * no input or output payload but there are HTTP header bindings. + * @see {@link InputAndOutputWithHeadersCommand} */ - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( - args: InputAndOutputWithHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InputAndOutputWithHeadersCommandOutput) => void), - cb?: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void - ): Promise | void { - const command = new InputAndOutputWithHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link NestedXmlMapsCommand} */ - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - cb: (err: any, data?: NestedXmlMapsCommandOutput) => void - ): void; - public nestedXmlMaps( + nestedXmlMaps(args: NestedXmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + nestedXmlMaps(args: NestedXmlMapsCommandInput, cb: (err: any, data?: NestedXmlMapsCommandOutput) => void): void; + nestedXmlMaps( args: NestedXmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedXmlMapsCommandOutput) => void ): void; - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedXmlMapsCommandOutput) => void), - cb?: (err: any, data?: NestedXmlMapsCommandOutput) => void - ): Promise | void { - const command = new NestedXmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersClientCommand} */ - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( - args: NullAndEmptyHeadersClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersServerCommand} */ - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( - args: NullAndEmptyHeadersServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Omits null, but serializes empty string value. + * @see {@link OmitsNullSerializesEmptyStringCommand} */ - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( - args: OmitsNullSerializesEmptyStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void), - cb?: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void - ): Promise | void { - const command = new OmitsNullSerializesEmptyStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryParamsAsStringListMapCommand} */ - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( - args: QueryParamsAsStringListMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryParamsAsStringListMapCommandOutput) => void), - cb?: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void - ): Promise | void { - const command = new QueryParamsAsStringListMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryPrecedenceCommand} */ - public queryPrecedence( + queryPrecedence( args: QueryPrecedenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - cb: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): void; - public queryPrecedence( + queryPrecedence(args: QueryPrecedenceCommandInput, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void): void; + queryPrecedence( args: QueryPrecedenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void ): void; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryPrecedenceCommandOutput) => void), - cb?: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): Promise | void { - const command = new QueryPrecedenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveShapesCommand} */ - public recursiveShapes( + recursiveShapes( args: RecursiveShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveShapes( - args: RecursiveShapesCommandInput, - cb: (err: any, data?: RecursiveShapesCommandOutput) => void - ): void; - public recursiveShapes( + recursiveShapes(args: RecursiveShapesCommandInput, cb: (err: any, data?: RecursiveShapesCommandOutput) => void): void; + recursiveShapes( args: RecursiveShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveShapesCommandOutput) => void ): void; - public recursiveShapes( - args: RecursiveShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how timestamp request and response headers are serialized. + * @see {@link TimestampFormatHeadersCommand} */ - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( - args: TimestampFormatHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TimestampFormatHeadersCommandOutput) => void), - cb?: (err: any, data?: TimestampFormatHeadersCommandOutput) => void - ): Promise | void { - const command = new TimestampFormatHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an XML attributes on synthesized document. + * @see {@link XmlAttributesCommand} */ - public xmlAttributes( - args: XmlAttributesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlAttributes( - args: XmlAttributesCommandInput, - cb: (err: any, data?: XmlAttributesCommandOutput) => void - ): void; - public xmlAttributes( + xmlAttributes(args: XmlAttributesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlAttributes(args: XmlAttributesCommandInput, cb: (err: any, data?: XmlAttributesCommandOutput) => void): void; + xmlAttributes( args: XmlAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlAttributesCommandOutput) => void ): void; - public xmlAttributes( - args: XmlAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlAttributesCommandOutput) => void), - cb?: (err: any, data?: XmlAttributesCommandOutput) => void - ): Promise | void { - const command = new XmlAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an XML attributes on a document targeted by httpPayload. + * @see {@link XmlAttributesOnPayloadCommand} */ - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, cb: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void ): void; - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void ): void; - public xmlAttributesOnPayload( - args: XmlAttributesOnPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlAttributesOnPayloadCommandOutput) => void), - cb?: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void - ): Promise | void { - const command = new XmlAttributesOnPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyMapsCommand} */ - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; - public xmlEmptyMaps( + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; + xmlEmptyMaps( args: XmlEmptyMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void ): void; - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyMapsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyMapsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyStringsCommand} */ - public xmlEmptyStrings( + xmlEmptyStrings( args: XmlEmptyStringsCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlEmptyStrings( - args: XmlEmptyStringsCommandInput, - cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void - ): void; - public xmlEmptyStrings( + xmlEmptyStrings(args: XmlEmptyStringsCommandInput, cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void): void; + xmlEmptyStrings( args: XmlEmptyStringsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void ): void; - public xmlEmptyStrings( - args: XmlEmptyStringsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyStringsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyStringsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyStringsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Flattened XML lists with @xmlNamespace. - * 8. Lists of structures. - * 9. Flattened XML list of structures + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests basic map serialization. + * @see {@link XmlMapsCommand} */ - public xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; - public xmlMaps( + xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; + xmlMaps( args: XmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsCommandOutput) => void ): void; - public xmlMaps( - args: XmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsCommandOutput) => void), - cb?: (err: any, data?: XmlMapsCommandOutput) => void - ): Promise | void { - const command = new XmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlMapsXmlNameCommand} */ - public xmlMapsXmlName( + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): void; - public xmlMapsXmlName( + xmlMapsXmlName(args: XmlMapsXmlNameCommandInput, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void): void; + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void ): void; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsXmlNameCommandOutput) => void), - cb?: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): Promise | void { - const command = new XmlMapsXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlUnionsCommand} */ - public xmlUnions(args: XmlUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlUnions(args: XmlUnionsCommandInput, cb: (err: any, data?: XmlUnionsCommandOutput) => void): void; - public xmlUnions( + xmlUnions(args: XmlUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlUnions(args: XmlUnionsCommandInput, cb: (err: any, data?: XmlUnionsCommandOutput) => void): void; + xmlUnions( args: XmlUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlUnionsCommandOutput) => void ): void; - public xmlUnions( - args: XmlUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlUnionsCommandOutput) => void), - cb?: (err: any, data?: XmlUnionsCommandOutput) => void - ): Promise | void { - const command = new XmlUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } +} + +/** + * @public + * A REST XML service that sends XML requests and responses. + */ +export class RestXmlProtocol extends RestXmlProtocolClient implements RestXmlProtocol { + public constructor(config: RestXmlProtocolClientConfig) { + const client = new RestXmlProtocolClient(config); + const target: any = {}; + return createProxyClient(target, commands, client); } } diff --git a/scripts/byte-count/get-cjs-byte-count.js b/scripts/byte-count/get-cjs-byte-count.js index 4ed5eeedb533..604818f6c15b 100644 --- a/scripts/byte-count/get-cjs-byte-count.js +++ b/scripts/byte-count/get-cjs-byte-count.js @@ -1,8 +1,7 @@ #!/usr/bin/env node const { join } = require("path"); -const { readdirSync, statSync, rmSync } = require("fs"); -const { removeSync } = require("fs-extra"); +const { readdirSync, statSync, rmSync, writeFileSync } = require("fs"); const { spawnProcess } = require("../utils/spawn-process"); const walk = require("../utils/walk"); const assert = require("assert"); @@ -23,13 +22,19 @@ locations.clients = join(locations.root, "clients"); for await (const clientFolderName of readdirSync(locations.clients)) { const clientLocation = join(locations.clients, clientFolderName); - removeSync(join(clientLocation, "dist-types")); - removeSync(join(clientLocation, "dist-es")); + const clientPkgJsonLocation = join(clientLocation, "package.json"); + const pkg = require(clientPkgJsonLocation); packs.push( - spawnProcess("npm", ["pack"], { - cwd: clientLocation, - }) + (async () => { + writeFileSync(clientPkgJsonLocation, JSON.stringify({ ...pkg, files: "dist-cjs" }, null, 2), "utf-8"); + + spawnProcess("npm", ["pack"], { + cwd: clientLocation, + }); + + writeFileSync(clientPkgJsonLocation, JSON.stringify(pkg, null, 2), "utf-8"); + })() ); }