BucketExists

class S3.Waiter.BucketExists

waiter = client.get_waiter('bucket_exists')

wait(**kwargs)

Polls S3.Client.head_bucket() every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Bucket='string',
    ExpectedBucketOwner='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• Bucket (string) --

  [REQUIRED]

  The bucket name.

  When using this action with an access point, 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 this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide .

  When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide .

• ExpectedBucketOwner (string) -- The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

    The amount of time in seconds to wait between attempts. Default: 5

  • MaxAttempts (integer) --

    The maximum number of attempts to be made. Default: 20

Returns

None