S3 / Waiter / ObjectExists

ObjectExists

class S3.Waiter.ObjectExists

waiter = client.get_waiter('object_exists')

wait(**kwargs)

Polls S3.Client.head_object() 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',
    IfMatch='string',
    IfModifiedSince=datetime(2015, 1, 1),
    IfNoneMatch='string',
    IfUnmodifiedSince=datetime(2015, 1, 1),
    Key='string',
    MirrorDestination='string',
    Range='string',
    VersionId='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey='string',
    RequestPayer='requester',
    PartNumber=123,
    ExpectedBucketOwner='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• Bucket (string) –

  [REQUIRED]

  The name of the bucket containing the object.

  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.

• IfMatch (string) – Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

• IfModifiedSince (datetime) – Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

• IfNoneMatch (string) – Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

• IfUnmodifiedSince (datetime) – Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

• Key (string) –

  [REQUIRED]

  The object key.

• MirrorDestination (string) – Mirror source for object reads.

• Range (string) – HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

• VersionId (string) – VersionId used to reference a specific version of the object.

• SSECustomerAlgorithm (string) – Specifies the algorithm to use to when encrypting the object (for example, AES256).

• SSECustomerKey (string) – Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

• SSECustomerKeyMD5 (string) –

  Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required

• RequestPayer (string) – Ignored by COS if present.

• PartNumber (integer) – Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

• ExpectedBucketOwner (string) – Ignored by COS if present.

• 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