Waiters#
Auto-generated documentation for S3 type annotations stubs module mypy-boto3-s3.
BucketExistsWaiter#
Type annotations and code completion for boto3.client("s3").get_waiter("bucket_exists")
.
boto3 documentation
# BucketExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_s3.waiter import BucketExistsWaiter
session = Session()
client = session.client("s3") # (1)
waiter: BucketExistsWaiter = client.get_waiter("bucket_exists") # (2)
await waiter.wait()
- client: S3Client
- waiter: BucketExistsWaiter
wait#
Type annotations and code completion for BucketExistsWaiter.wait
method.
# wait method definition
def wait(
self,
*,
Bucket: str,
ExpectedBucketOwner: str = ...,
WaiterConfig: WaiterConfigTypeDef = ..., # (1)
) -> None:
...
# wait method usage example with argument unpacking
kwargs: HeadBucketRequestBucketExistsWaitTypeDef = { # (1)
"Bucket": ...,
}
parent.wait(**kwargs)
BucketNotExistsWaiter#
Type annotations and code completion for boto3.client("s3").get_waiter("bucket_not_exists")
.
boto3 documentation
# BucketNotExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_s3.waiter import BucketNotExistsWaiter
session = Session()
client = session.client("s3") # (1)
waiter: BucketNotExistsWaiter = client.get_waiter("bucket_not_exists") # (2)
await waiter.wait()
- client: S3Client
- waiter: BucketNotExistsWaiter
wait#
Type annotations and code completion for BucketNotExistsWaiter.wait
method.
# wait method definition
def wait(
self,
*,
Bucket: str,
ExpectedBucketOwner: str = ...,
WaiterConfig: WaiterConfigTypeDef = ..., # (1)
) -> None:
...
# wait method usage example with argument unpacking
kwargs: HeadBucketRequestBucketNotExistsWaitTypeDef = { # (1)
"Bucket": ...,
}
parent.wait(**kwargs)
ObjectExistsWaiter#
Type annotations and code completion for boto3.client("s3").get_waiter("object_exists")
.
boto3 documentation
# ObjectExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_s3.waiter import ObjectExistsWaiter
session = Session()
client = session.client("s3") # (1)
waiter: ObjectExistsWaiter = client.get_waiter("object_exists") # (2)
await waiter.wait()
- client: S3Client
- waiter: ObjectExistsWaiter
wait#
Type annotations and code completion for ObjectExistsWaiter.wait
method.
# wait method definition
def wait(
self,
*,
Bucket: str,
Key: str,
IfMatch: str = ...,
IfModifiedSince: Union[datetime, str] = ...,
IfNoneMatch: str = ...,
IfUnmodifiedSince: Union[datetime, str] = ...,
Range: str = ...,
ResponseCacheControl: str = ...,
ResponseContentDisposition: str = ...,
ResponseContentEncoding: str = ...,
ResponseContentLanguage: str = ...,
ResponseContentType: str = ...,
ResponseExpires: Union[datetime, str] = ...,
VersionId: str = ...,
SSECustomerAlgorithm: str = ...,
SSECustomerKey: str = ...,
SSECustomerKeyMD5: str = ...,
RequestPayer: RequestPayerType = ..., # (1)
PartNumber: int = ...,
ExpectedBucketOwner: str = ...,
ChecksumMode: ChecksumModeType = ..., # (2)
WaiterConfig: WaiterConfigTypeDef = ..., # (3)
) -> None:
...
- See RequestPayerType
- See ChecksumModeType
- See WaiterConfigTypeDef
# wait method usage example with argument unpacking
kwargs: HeadObjectRequestObjectExistsWaitTypeDef = { # (1)
"Bucket": ...,
"Key": ...,
}
parent.wait(**kwargs)
ObjectNotExistsWaiter#
Type annotations and code completion for boto3.client("s3").get_waiter("object_not_exists")
.
boto3 documentation
# ObjectNotExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_s3.waiter import ObjectNotExistsWaiter
session = Session()
client = session.client("s3") # (1)
waiter: ObjectNotExistsWaiter = client.get_waiter("object_not_exists") # (2)
await waiter.wait()
- client: S3Client
- waiter: ObjectNotExistsWaiter
wait#
Type annotations and code completion for ObjectNotExistsWaiter.wait
method.
# wait method definition
def wait(
self,
*,
Bucket: str,
Key: str,
IfMatch: str = ...,
IfModifiedSince: Union[datetime, str] = ...,
IfNoneMatch: str = ...,
IfUnmodifiedSince: Union[datetime, str] = ...,
Range: str = ...,
ResponseCacheControl: str = ...,
ResponseContentDisposition: str = ...,
ResponseContentEncoding: str = ...,
ResponseContentLanguage: str = ...,
ResponseContentType: str = ...,
ResponseExpires: Union[datetime, str] = ...,
VersionId: str = ...,
SSECustomerAlgorithm: str = ...,
SSECustomerKey: str = ...,
SSECustomerKeyMD5: str = ...,
RequestPayer: RequestPayerType = ..., # (1)
PartNumber: int = ...,
ExpectedBucketOwner: str = ...,
ChecksumMode: ChecksumModeType = ..., # (2)
WaiterConfig: WaiterConfigTypeDef = ..., # (3)
) -> None:
...
- See RequestPayerType
- See ChecksumModeType
- See WaiterConfigTypeDef
# wait method usage example with argument unpacking
kwargs: HeadObjectRequestObjectNotExistsWaitTypeDef = { # (1)
"Bucket": ...,
"Key": ...,
}
parent.wait(**kwargs)