IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Class ListDirectoryBucketsCommand

    Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

    Permissions

    You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    HTTP Host header syntax

    Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

    The BucketRegion response element is not part of the ListDirectoryBuckets Response Syntax.

    You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

    Use a bare-bones client and the command you need to make an API call.

    import { S3Client, ListDirectoryBucketsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, ListDirectoryBucketsCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
    // import type { S3ClientConfig } from "ibm-cos-sdk-v2";
    const config = {}; // type is S3ClientConfig
    const client = new S3Client(config);
    const input = { // ListDirectoryBucketsRequest
    ContinuationToken: "STRING_VALUE",
    MaxDirectoryBuckets: Number("int"),
    };
    const command = new ListDirectoryBucketsCommand(input);
    const response = await client.send(command);
    // { // ListDirectoryBucketsOutput
    // Buckets: [ // Buckets
    // { // Bucket
    // Name: "STRING_VALUE",
    // CreationDate: new Date("TIMESTAMP"),
    // BucketRegion: "STRING_VALUE",
    // BucketArn: "STRING_VALUE",
    // },
    // ],
    // ContinuationToken: "STRING_VALUE",
    // };

    ListDirectoryBucketsCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns ListDirectoryBucketsCommand

    • Parameters

      Returns ListDirectoryBucketsCommand