@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
28 lines (27 loc) • 2.01 kB
TypeScript
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
import { HeadBucketRequest } from "../models/models_0";
import { Command as $Command } from "@aws-sdk/smithy-client";
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@aws-sdk/types";
export declare type HeadBucketCommandInput = HeadBucketRequest;
export declare type HeadBucketCommandOutput = __MetadataBearer;
/**
* <p>This operation is useful to determine if a bucket exists and you have permission to
* access it. The operation returns a <code>200 OK</code> if the bucket exists and you have
* permission to access it. Otherwise, the operation might return responses such as <code>404
* Not Found</code> and <code>403 Forbidden</code>. </p>
*
* <p>To use this operation, you must have permissions to perform the
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Managing Access Permissions to Your Amazon S3
* Resources</a>.</p>
*/
export declare class HeadBucketCommand extends $Command<HeadBucketCommandInput, HeadBucketCommandOutput, S3ClientResolvedConfig> {
readonly input: HeadBucketCommandInput;
constructor(input: HeadBucketCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<HeadBucketCommandInput, HeadBucketCommandOutput>;
private serialize;
private deserialize;
}