S3ControlClient#
Auto-generated documentation for S3Control type annotations stubs module types-aiobotocore-s3control.
S3ControlClient#
Type annotations and code completion for session.create_client("s3control")
boto3 documentation
S3ControlClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_s3control.client import S3ControlClient
session = get_session()
async with session.create_client("s3control") as client:
client: S3ControlClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("s3control").exceptions
structure.
S3ControlClient.exceptions usage example
async with session.create_client("s3control") as client:
try:
do_something(client)
except (
client.BadRequestException,
client.BucketAlreadyExists,
client.BucketAlreadyOwnedByYou,
client.ClientError,
client.IdempotencyException,
client.InternalServiceException,
client.InvalidNextTokenException,
client.InvalidRequestException,
client.JobStatusException,
client.NoSuchPublicAccessBlockConfiguration,
client.NotFoundException,
client.TooManyRequestsException,
client.TooManyTagsException,
) as e:
print(e)
S3ControlClient usage type checking example
from types_aiobotocore_s3control.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("s3control").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("s3control").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_access_point#
Creates an access point and associates it with the specified bucket.
Type annotations and code completion for session.create_client("s3control").create_access_point
method.
boto3 documentation
# create_access_point method definition
await def create_access_point(
self,
*,
AccountId: str,
Name: str,
Bucket: str,
VpcConfiguration: VpcConfigurationTypeDef = ..., # (1)
PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef = ..., # (2)
BucketAccountId: str = ...,
) -> CreateAccessPointResultTypeDef: # (3)
...
- See VpcConfigurationTypeDef
- See PublicAccessBlockConfigurationTypeDef
- See CreateAccessPointResultTypeDef
# create_access_point method usage example with argument unpacking
kwargs: CreateAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
"Bucket": ...,
}
parent.create_access_point(**kwargs)
create_access_point_for_object_lambda#
Creates an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").create_access_point_for_object_lambda
method.
boto3 documentation
# create_access_point_for_object_lambda method definition
await def create_access_point_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
Configuration: ObjectLambdaConfigurationTypeDef, # (1)
) -> CreateAccessPointForObjectLambdaResultTypeDef: # (2)
...
# create_access_point_for_object_lambda method usage example with argument unpacking
kwargs: CreateAccessPointForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
"Configuration": ...,
}
parent.create_access_point_for_object_lambda(**kwargs)
create_bucket#
.
Type annotations and code completion for session.create_client("s3control").create_bucket
method.
boto3 documentation
# create_bucket method definition
await def create_bucket(
self,
*,
Bucket: str,
ACL: BucketCannedACLType = ..., # (1)
CreateBucketConfiguration: CreateBucketConfigurationTypeDef = ..., # (2)
GrantFullControl: str = ...,
GrantRead: str = ...,
GrantReadACP: str = ...,
GrantWrite: str = ...,
GrantWriteACP: str = ...,
ObjectLockEnabledForBucket: bool = ...,
OutpostId: str = ...,
) -> CreateBucketResultTypeDef: # (3)
...
# create_bucket method usage example with argument unpacking
kwargs: CreateBucketRequestRequestTypeDef = { # (1)
"Bucket": ...,
}
parent.create_bucket(**kwargs)
create_job#
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
Type annotations and code completion for session.create_client("s3control").create_job
method.
boto3 documentation
# create_job method definition
await def create_job(
self,
*,
AccountId: str,
Operation: JobOperationTypeDef, # (1)
Report: JobReportTypeDef, # (2)
ClientRequestToken: str,
Priority: int,
RoleArn: str,
ConfirmationRequired: bool = ...,
Manifest: JobManifestTypeDef = ..., # (3)
Description: str = ...,
Tags: Sequence[S3TagTypeDef] = ..., # (4)
ManifestGenerator: JobManifestGeneratorTypeDef = ..., # (5)
) -> CreateJobResultTypeDef: # (6)
...
- See JobOperationTypeDef
- See JobReportTypeDef
- See JobManifestTypeDef
- See S3TagTypeDef
- See JobManifestGeneratorTypeDef
- See CreateJobResultTypeDef
# create_job method usage example with argument unpacking
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Operation": ...,
"Report": ...,
"ClientRequestToken": ...,
"Priority": ...,
"RoleArn": ...,
}
parent.create_job(**kwargs)
create_multi_region_access_point#
Creates a Multi-Region Access Point and associates it with the specified buckets.
Type annotations and code completion for session.create_client("s3control").create_multi_region_access_point
method.
boto3 documentation
# create_multi_region_access_point method definition
await def create_multi_region_access_point(
self,
*,
AccountId: str,
ClientToken: str,
Details: CreateMultiRegionAccessPointInputTypeDef, # (1)
) -> CreateMultiRegionAccessPointResultTypeDef: # (2)
...
# create_multi_region_access_point method usage example with argument unpacking
kwargs: CreateMultiRegionAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ClientToken": ...,
"Details": ...,
}
parent.create_multi_region_access_point(**kwargs)
delete_access_point#
Deletes the specified access point.
Type annotations and code completion for session.create_client("s3control").delete_access_point
method.
boto3 documentation
# delete_access_point method definition
await def delete_access_point(
self,
*,
AccountId: str,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_point method usage example with argument unpacking
kwargs: DeleteAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.delete_access_point(**kwargs)
delete_access_point_for_object_lambda#
Deletes the specified Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").delete_access_point_for_object_lambda
method.
boto3 documentation
# delete_access_point_for_object_lambda method definition
await def delete_access_point_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_point_for_object_lambda method usage example with argument unpacking
kwargs: DeleteAccessPointForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.delete_access_point_for_object_lambda(**kwargs)
delete_access_point_policy#
Deletes the access point policy for the specified access point.
Type annotations and code completion for session.create_client("s3control").delete_access_point_policy
method.
boto3 documentation
# delete_access_point_policy method definition
await def delete_access_point_policy(
self,
*,
AccountId: str,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_point_policy method usage example with argument unpacking
kwargs: DeleteAccessPointPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.delete_access_point_policy(**kwargs)
delete_access_point_policy_for_object_lambda#
Removes the resource policy for an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").delete_access_point_policy_for_object_lambda
method.
boto3 documentation
# delete_access_point_policy_for_object_lambda method definition
await def delete_access_point_policy_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_point_policy_for_object_lambda method usage example with argument unpacking
kwargs: DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.delete_access_point_policy_for_object_lambda(**kwargs)
delete_bucket#
.
Type annotations and code completion for session.create_client("s3control").delete_bucket
method.
boto3 documentation
# delete_bucket method definition
await def delete_bucket(
self,
*,
AccountId: str,
Bucket: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_bucket method usage example with argument unpacking
kwargs: DeleteBucketRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.delete_bucket(**kwargs)
delete_bucket_lifecycle_configuration#
.
Type annotations and code completion for session.create_client("s3control").delete_bucket_lifecycle_configuration
method.
boto3 documentation
# delete_bucket_lifecycle_configuration method definition
await def delete_bucket_lifecycle_configuration(
self,
*,
AccountId: str,
Bucket: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_bucket_lifecycle_configuration method usage example with argument unpacking
kwargs: DeleteBucketLifecycleConfigurationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.delete_bucket_lifecycle_configuration(**kwargs)
delete_bucket_policy#
.
Type annotations and code completion for session.create_client("s3control").delete_bucket_policy
method.
boto3 documentation
# delete_bucket_policy method definition
await def delete_bucket_policy(
self,
*,
AccountId: str,
Bucket: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_bucket_policy method usage example with argument unpacking
kwargs: DeleteBucketPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.delete_bucket_policy(**kwargs)
delete_bucket_replication#
.
Type annotations and code completion for session.create_client("s3control").delete_bucket_replication
method.
boto3 documentation
# delete_bucket_replication method definition
await def delete_bucket_replication(
self,
*,
AccountId: str,
Bucket: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_bucket_replication method usage example with argument unpacking
kwargs: DeleteBucketReplicationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.delete_bucket_replication(**kwargs)
delete_bucket_tagging#
.
Type annotations and code completion for session.create_client("s3control").delete_bucket_tagging
method.
boto3 documentation
# delete_bucket_tagging method definition
await def delete_bucket_tagging(
self,
*,
AccountId: str,
Bucket: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_bucket_tagging method usage example with argument unpacking
kwargs: DeleteBucketTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.delete_bucket_tagging(**kwargs)
delete_job_tagging#
Removes the entire tag set from the specified S3 Batch Operations job.
Type annotations and code completion for session.create_client("s3control").delete_job_tagging
method.
boto3 documentation
# delete_job_tagging method definition
await def delete_job_tagging(
self,
*,
AccountId: str,
JobId: str,
) -> Dict[str, Any]:
...
# delete_job_tagging method usage example with argument unpacking
kwargs: DeleteJobTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
}
parent.delete_job_tagging(**kwargs)
delete_multi_region_access_point#
Deletes a Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").delete_multi_region_access_point
method.
boto3 documentation
# delete_multi_region_access_point method definition
await def delete_multi_region_access_point(
self,
*,
AccountId: str,
ClientToken: str,
Details: DeleteMultiRegionAccessPointInputTypeDef, # (1)
) -> DeleteMultiRegionAccessPointResultTypeDef: # (2)
...
# delete_multi_region_access_point method usage example with argument unpacking
kwargs: DeleteMultiRegionAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ClientToken": ...,
"Details": ...,
}
parent.delete_multi_region_access_point(**kwargs)
delete_public_access_block#
Removes the PublicAccessBlock
configuration for an Amazon Web Services
account.
Type annotations and code completion for session.create_client("s3control").delete_public_access_block
method.
boto3 documentation
# delete_public_access_block method definition
await def delete_public_access_block(
self,
*,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_public_access_block method usage example with argument unpacking
kwargs: DeletePublicAccessBlockRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.delete_public_access_block(**kwargs)
delete_storage_lens_configuration#
Deletes the Amazon S3 Storage Lens configuration.
Type annotations and code completion for session.create_client("s3control").delete_storage_lens_configuration
method.
boto3 documentation
# delete_storage_lens_configuration method definition
await def delete_storage_lens_configuration(
self,
*,
ConfigId: str,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_storage_lens_configuration method usage example with argument unpacking
kwargs: DeleteStorageLensConfigurationRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
}
parent.delete_storage_lens_configuration(**kwargs)
delete_storage_lens_configuration_tagging#
Deletes the Amazon S3 Storage Lens configuration tags.
Type annotations and code completion for session.create_client("s3control").delete_storage_lens_configuration_tagging
method.
boto3 documentation
# delete_storage_lens_configuration_tagging method definition
await def delete_storage_lens_configuration_tagging(
self,
*,
ConfigId: str,
AccountId: str,
) -> Dict[str, Any]:
...
# delete_storage_lens_configuration_tagging method usage example with argument unpacking
kwargs: DeleteStorageLensConfigurationTaggingRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
}
parent.delete_storage_lens_configuration_tagging(**kwargs)
describe_job#
Retrieves the configuration parameters and status for a Batch Operations job.
Type annotations and code completion for session.create_client("s3control").describe_job
method.
boto3 documentation
# describe_job method definition
await def describe_job(
self,
*,
AccountId: str,
JobId: str,
) -> DescribeJobResultTypeDef: # (1)
...
# describe_job method usage example with argument unpacking
kwargs: DescribeJobRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
}
parent.describe_job(**kwargs)
describe_multi_region_access_point_operation#
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").describe_multi_region_access_point_operation
method.
boto3 documentation
# describe_multi_region_access_point_operation method definition
await def describe_multi_region_access_point_operation(
self,
*,
AccountId: str,
RequestTokenARN: str,
) -> DescribeMultiRegionAccessPointOperationResultTypeDef: # (1)
...
# describe_multi_region_access_point_operation method usage example with argument unpacking
kwargs: DescribeMultiRegionAccessPointOperationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"RequestTokenARN": ...,
}
parent.describe_multi_region_access_point_operation(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("s3control").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_access_point#
Returns configuration information about the specified access point.
Type annotations and code completion for session.create_client("s3control").get_access_point
method.
boto3 documentation
# get_access_point method definition
await def get_access_point(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointResultTypeDef: # (1)
...
# get_access_point method usage example with argument unpacking
kwargs: GetAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point(**kwargs)
get_access_point_configuration_for_object_lambda#
Returns configuration for an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").get_access_point_configuration_for_object_lambda
method.
boto3 documentation
# get_access_point_configuration_for_object_lambda method definition
await def get_access_point_configuration_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointConfigurationForObjectLambdaResultTypeDef: # (1)
...
# get_access_point_configuration_for_object_lambda method usage example with argument unpacking
kwargs: GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_configuration_for_object_lambda(**kwargs)
get_access_point_for_object_lambda#
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to GetAccessPointForObjectLambda
: *
CreateAccessPointForObjectLambda
<https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html>...
.
Type annotations and code completion for session.create_client("s3control").get_access_point_for_object_lambda
method.
boto3 documentation
# get_access_point_for_object_lambda method definition
await def get_access_point_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointForObjectLambdaResultTypeDef: # (1)
...
# get_access_point_for_object_lambda method usage example with argument unpacking
kwargs: GetAccessPointForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_for_object_lambda(**kwargs)
get_access_point_policy#
Returns the access point policy associated with the specified access point.
Type annotations and code completion for session.create_client("s3control").get_access_point_policy
method.
boto3 documentation
# get_access_point_policy method definition
await def get_access_point_policy(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointPolicyResultTypeDef: # (1)
...
# get_access_point_policy method usage example with argument unpacking
kwargs: GetAccessPointPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_policy(**kwargs)
get_access_point_policy_for_object_lambda#
Returns the resource policy for an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").get_access_point_policy_for_object_lambda
method.
boto3 documentation
# get_access_point_policy_for_object_lambda method definition
await def get_access_point_policy_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointPolicyForObjectLambdaResultTypeDef: # (1)
...
# get_access_point_policy_for_object_lambda method usage example with argument unpacking
kwargs: GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_policy_for_object_lambda(**kwargs)
get_access_point_policy_status#
Indicates whether the specified access point currently has a policy that allows public access.
Type annotations and code completion for session.create_client("s3control").get_access_point_policy_status
method.
boto3 documentation
# get_access_point_policy_status method definition
await def get_access_point_policy_status(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointPolicyStatusResultTypeDef: # (1)
...
# get_access_point_policy_status method usage example with argument unpacking
kwargs: GetAccessPointPolicyStatusRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_policy_status(**kwargs)
get_access_point_policy_status_for_object_lambda#
Returns the status of the resource policy associated with an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").get_access_point_policy_status_for_object_lambda
method.
boto3 documentation
# get_access_point_policy_status_for_object_lambda method definition
await def get_access_point_policy_status_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
) -> GetAccessPointPolicyStatusForObjectLambdaResultTypeDef: # (1)
...
# get_access_point_policy_status_for_object_lambda method usage example with argument unpacking
kwargs: GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_access_point_policy_status_for_object_lambda(**kwargs)
get_bucket#
Gets an Amazon S3 on Outposts bucket.
Type annotations and code completion for session.create_client("s3control").get_bucket
method.
boto3 documentation
# get_bucket method definition
await def get_bucket(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketResultTypeDef: # (1)
...
# get_bucket method usage example with argument unpacking
kwargs: GetBucketRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket(**kwargs)
get_bucket_lifecycle_configuration#
.
Type annotations and code completion for session.create_client("s3control").get_bucket_lifecycle_configuration
method.
boto3 documentation
# get_bucket_lifecycle_configuration method definition
await def get_bucket_lifecycle_configuration(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketLifecycleConfigurationResultTypeDef: # (1)
...
# get_bucket_lifecycle_configuration method usage example with argument unpacking
kwargs: GetBucketLifecycleConfigurationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket_lifecycle_configuration(**kwargs)
get_bucket_policy#
.
Type annotations and code completion for session.create_client("s3control").get_bucket_policy
method.
boto3 documentation
# get_bucket_policy method definition
await def get_bucket_policy(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketPolicyResultTypeDef: # (1)
...
# get_bucket_policy method usage example with argument unpacking
kwargs: GetBucketPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket_policy(**kwargs)
get_bucket_replication#
.
Type annotations and code completion for session.create_client("s3control").get_bucket_replication
method.
boto3 documentation
# get_bucket_replication method definition
await def get_bucket_replication(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketReplicationResultTypeDef: # (1)
...
# get_bucket_replication method usage example with argument unpacking
kwargs: GetBucketReplicationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket_replication(**kwargs)
get_bucket_tagging#
.
Type annotations and code completion for session.create_client("s3control").get_bucket_tagging
method.
boto3 documentation
# get_bucket_tagging method definition
await def get_bucket_tagging(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketTaggingResultTypeDef: # (1)
...
# get_bucket_tagging method usage example with argument unpacking
kwargs: GetBucketTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket_tagging(**kwargs)
get_bucket_versioning#
.
Type annotations and code completion for session.create_client("s3control").get_bucket_versioning
method.
boto3 documentation
# get_bucket_versioning method definition
await def get_bucket_versioning(
self,
*,
AccountId: str,
Bucket: str,
) -> GetBucketVersioningResultTypeDef: # (1)
...
# get_bucket_versioning method usage example with argument unpacking
kwargs: GetBucketVersioningRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.get_bucket_versioning(**kwargs)
get_job_tagging#
Returns the tags on an S3 Batch Operations job.
Type annotations and code completion for session.create_client("s3control").get_job_tagging
method.
boto3 documentation
# get_job_tagging method definition
await def get_job_tagging(
self,
*,
AccountId: str,
JobId: str,
) -> GetJobTaggingResultTypeDef: # (1)
...
# get_job_tagging method usage example with argument unpacking
kwargs: GetJobTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
}
parent.get_job_tagging(**kwargs)
get_multi_region_access_point#
Returns configuration information about the specified Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").get_multi_region_access_point
method.
boto3 documentation
# get_multi_region_access_point method definition
await def get_multi_region_access_point(
self,
*,
AccountId: str,
Name: str,
) -> GetMultiRegionAccessPointResultTypeDef: # (1)
...
# get_multi_region_access_point method usage example with argument unpacking
kwargs: GetMultiRegionAccessPointRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_multi_region_access_point(**kwargs)
get_multi_region_access_point_policy#
Returns the access control policy of the specified Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").get_multi_region_access_point_policy
method.
boto3 documentation
# get_multi_region_access_point_policy method definition
await def get_multi_region_access_point_policy(
self,
*,
AccountId: str,
Name: str,
) -> GetMultiRegionAccessPointPolicyResultTypeDef: # (1)
...
# get_multi_region_access_point_policy method usage example with argument unpacking
kwargs: GetMultiRegionAccessPointPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_multi_region_access_point_policy(**kwargs)
get_multi_region_access_point_policy_status#
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
Type annotations and code completion for session.create_client("s3control").get_multi_region_access_point_policy_status
method.
boto3 documentation
# get_multi_region_access_point_policy_status method definition
await def get_multi_region_access_point_policy_status(
self,
*,
AccountId: str,
Name: str,
) -> GetMultiRegionAccessPointPolicyStatusResultTypeDef: # (1)
...
# get_multi_region_access_point_policy_status method usage example with argument unpacking
kwargs: GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.get_multi_region_access_point_policy_status(**kwargs)
get_multi_region_access_point_routes#
Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.
Type annotations and code completion for session.create_client("s3control").get_multi_region_access_point_routes
method.
boto3 documentation
# get_multi_region_access_point_routes method definition
await def get_multi_region_access_point_routes(
self,
*,
AccountId: str,
Mrap: str,
) -> GetMultiRegionAccessPointRoutesResultTypeDef: # (1)
...
# get_multi_region_access_point_routes method usage example with argument unpacking
kwargs: GetMultiRegionAccessPointRoutesRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Mrap": ...,
}
parent.get_multi_region_access_point_routes(**kwargs)
get_public_access_block#
Retrieves the PublicAccessBlock
configuration for an Amazon Web Services
account.
Type annotations and code completion for session.create_client("s3control").get_public_access_block
method.
boto3 documentation
# get_public_access_block method definition
await def get_public_access_block(
self,
*,
AccountId: str,
) -> GetPublicAccessBlockOutputTypeDef: # (1)
...
# get_public_access_block method usage example with argument unpacking
kwargs: GetPublicAccessBlockRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.get_public_access_block(**kwargs)
get_storage_lens_configuration#
Gets the Amazon S3 Storage Lens configuration.
Type annotations and code completion for session.create_client("s3control").get_storage_lens_configuration
method.
boto3 documentation
# get_storage_lens_configuration method definition
await def get_storage_lens_configuration(
self,
*,
ConfigId: str,
AccountId: str,
) -> GetStorageLensConfigurationResultTypeDef: # (1)
...
# get_storage_lens_configuration method usage example with argument unpacking
kwargs: GetStorageLensConfigurationRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
}
parent.get_storage_lens_configuration(**kwargs)
get_storage_lens_configuration_tagging#
Gets the tags of Amazon S3 Storage Lens configuration.
Type annotations and code completion for session.create_client("s3control").get_storage_lens_configuration_tagging
method.
boto3 documentation
# get_storage_lens_configuration_tagging method definition
await def get_storage_lens_configuration_tagging(
self,
*,
ConfigId: str,
AccountId: str,
) -> GetStorageLensConfigurationTaggingResultTypeDef: # (1)
...
# get_storage_lens_configuration_tagging method usage example with argument unpacking
kwargs: GetStorageLensConfigurationTaggingRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
}
parent.get_storage_lens_configuration_tagging(**kwargs)
list_access_points#
Returns a list of the access points that are owned by the current account that's associated with the specified bucket.
Type annotations and code completion for session.create_client("s3control").list_access_points
method.
boto3 documentation
# list_access_points method definition
await def list_access_points(
self,
*,
AccountId: str,
Bucket: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAccessPointsResultTypeDef: # (1)
...
# list_access_points method usage example with argument unpacking
kwargs: ListAccessPointsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_access_points(**kwargs)
list_access_points_for_object_lambda#
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
Type annotations and code completion for session.create_client("s3control").list_access_points_for_object_lambda
method.
boto3 documentation
# list_access_points_for_object_lambda method definition
await def list_access_points_for_object_lambda(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAccessPointsForObjectLambdaResultTypeDef: # (1)
...
# list_access_points_for_object_lambda method usage example with argument unpacking
kwargs: ListAccessPointsForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_access_points_for_object_lambda(**kwargs)
list_jobs#
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
Type annotations and code completion for session.create_client("s3control").list_jobs
method.
boto3 documentation
# list_jobs method definition
await def list_jobs(
self,
*,
AccountId: str,
JobStatuses: Sequence[JobStatusType] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListJobsResultTypeDef: # (2)
...
- See JobStatusType
- See ListJobsResultTypeDef
# list_jobs method usage example with argument unpacking
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_jobs(**kwargs)
list_multi_region_access_points#
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
Type annotations and code completion for session.create_client("s3control").list_multi_region_access_points
method.
boto3 documentation
# list_multi_region_access_points method definition
await def list_multi_region_access_points(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListMultiRegionAccessPointsResultTypeDef: # (1)
...
# list_multi_region_access_points method usage example with argument unpacking
kwargs: ListMultiRegionAccessPointsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_multi_region_access_points(**kwargs)
list_regional_buckets#
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
Type annotations and code completion for session.create_client("s3control").list_regional_buckets
method.
boto3 documentation
# list_regional_buckets method definition
await def list_regional_buckets(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
OutpostId: str = ...,
) -> ListRegionalBucketsResultTypeDef: # (1)
...
# list_regional_buckets method usage example with argument unpacking
kwargs: ListRegionalBucketsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_regional_buckets(**kwargs)
list_storage_lens_configurations#
Gets a list of Amazon S3 Storage Lens configurations.
Type annotations and code completion for session.create_client("s3control").list_storage_lens_configurations
method.
boto3 documentation
# list_storage_lens_configurations method definition
await def list_storage_lens_configurations(
self,
*,
AccountId: str,
NextToken: str = ...,
) -> ListStorageLensConfigurationsResultTypeDef: # (1)
...
# list_storage_lens_configurations method usage example with argument unpacking
kwargs: ListStorageLensConfigurationsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_storage_lens_configurations(**kwargs)
put_access_point_configuration_for_object_lambda#
Replaces configuration for an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").put_access_point_configuration_for_object_lambda
method.
boto3 documentation
# put_access_point_configuration_for_object_lambda method definition
await def put_access_point_configuration_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
Configuration: ObjectLambdaConfigurationTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_access_point_configuration_for_object_lambda method usage example with argument unpacking
kwargs: PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
"Configuration": ...,
}
parent.put_access_point_configuration_for_object_lambda(**kwargs)
put_access_point_policy#
Associates an access policy with the specified access point.
Type annotations and code completion for session.create_client("s3control").put_access_point_policy
method.
boto3 documentation
# put_access_point_policy method definition
await def put_access_point_policy(
self,
*,
AccountId: str,
Name: str,
Policy: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_access_point_policy method usage example with argument unpacking
kwargs: PutAccessPointPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
"Policy": ...,
}
parent.put_access_point_policy(**kwargs)
put_access_point_policy_for_object_lambda#
Creates or replaces resource policy for an Object Lambda Access Point.
Type annotations and code completion for session.create_client("s3control").put_access_point_policy_for_object_lambda
method.
boto3 documentation
# put_access_point_policy_for_object_lambda method definition
await def put_access_point_policy_for_object_lambda(
self,
*,
AccountId: str,
Name: str,
Policy: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_access_point_policy_for_object_lambda method usage example with argument unpacking
kwargs: PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
"Policy": ...,
}
parent.put_access_point_policy_for_object_lambda(**kwargs)
put_bucket_lifecycle_configuration#
.
Type annotations and code completion for session.create_client("s3control").put_bucket_lifecycle_configuration
method.
boto3 documentation
# put_bucket_lifecycle_configuration method definition
await def put_bucket_lifecycle_configuration(
self,
*,
AccountId: str,
Bucket: str,
LifecycleConfiguration: LifecycleConfigurationTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_bucket_lifecycle_configuration method usage example with argument unpacking
kwargs: PutBucketLifecycleConfigurationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
}
parent.put_bucket_lifecycle_configuration(**kwargs)
put_bucket_policy#
.
Type annotations and code completion for session.create_client("s3control").put_bucket_policy
method.
boto3 documentation
# put_bucket_policy method definition
await def put_bucket_policy(
self,
*,
AccountId: str,
Bucket: str,
Policy: str,
ConfirmRemoveSelfBucketAccess: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# put_bucket_policy method usage example with argument unpacking
kwargs: PutBucketPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
"Policy": ...,
}
parent.put_bucket_policy(**kwargs)
put_bucket_replication#
.
Type annotations and code completion for session.create_client("s3control").put_bucket_replication
method.
boto3 documentation
# put_bucket_replication method definition
await def put_bucket_replication(
self,
*,
AccountId: str,
Bucket: str,
ReplicationConfiguration: ReplicationConfigurationTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_bucket_replication method usage example with argument unpacking
kwargs: PutBucketReplicationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
"ReplicationConfiguration": ...,
}
parent.put_bucket_replication(**kwargs)
put_bucket_tagging#
.
Type annotations and code completion for session.create_client("s3control").put_bucket_tagging
method.
boto3 documentation
# put_bucket_tagging method definition
await def put_bucket_tagging(
self,
*,
AccountId: str,
Bucket: str,
Tagging: TaggingTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_bucket_tagging method usage example with argument unpacking
kwargs: PutBucketTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
"Tagging": ...,
}
parent.put_bucket_tagging(**kwargs)
put_bucket_versioning#
.
Type annotations and code completion for session.create_client("s3control").put_bucket_versioning
method.
boto3 documentation
# put_bucket_versioning method definition
await def put_bucket_versioning(
self,
*,
AccountId: str,
Bucket: str,
VersioningConfiguration: VersioningConfigurationTypeDef, # (1)
MFA: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_bucket_versioning method usage example with argument unpacking
kwargs: PutBucketVersioningRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Bucket": ...,
"VersioningConfiguration": ...,
}
parent.put_bucket_versioning(**kwargs)
put_job_tagging#
Sets the supplied tag-set on an S3 Batch Operations job.
Type annotations and code completion for session.create_client("s3control").put_job_tagging
method.
boto3 documentation
# put_job_tagging method definition
await def put_job_tagging(
self,
*,
AccountId: str,
JobId: str,
Tags: Sequence[S3TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See S3TagTypeDef
# put_job_tagging method usage example with argument unpacking
kwargs: PutJobTaggingRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
"Tags": ...,
}
parent.put_job_tagging(**kwargs)
put_multi_region_access_point_policy#
Associates an access control policy with the specified Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").put_multi_region_access_point_policy
method.
boto3 documentation
# put_multi_region_access_point_policy method definition
await def put_multi_region_access_point_policy(
self,
*,
AccountId: str,
ClientToken: str,
Details: PutMultiRegionAccessPointPolicyInputTypeDef, # (1)
) -> PutMultiRegionAccessPointPolicyResultTypeDef: # (2)
...
# put_multi_region_access_point_policy method usage example with argument unpacking
kwargs: PutMultiRegionAccessPointPolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ClientToken": ...,
"Details": ...,
}
parent.put_multi_region_access_point_policy(**kwargs)
put_public_access_block#
Creates or modifies the PublicAccessBlock
configuration for an Amazon Web
Services account.
Type annotations and code completion for session.create_client("s3control").put_public_access_block
method.
boto3 documentation
# put_public_access_block method definition
await def put_public_access_block(
self,
*,
PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef, # (1)
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_public_access_block method usage example with argument unpacking
kwargs: PutPublicAccessBlockRequestRequestTypeDef = { # (1)
"PublicAccessBlockConfiguration": ...,
"AccountId": ...,
}
parent.put_public_access_block(**kwargs)
put_storage_lens_configuration#
Puts an Amazon S3 Storage Lens configuration.
Type annotations and code completion for session.create_client("s3control").put_storage_lens_configuration
method.
boto3 documentation
# put_storage_lens_configuration method definition
await def put_storage_lens_configuration(
self,
*,
ConfigId: str,
AccountId: str,
StorageLensConfiguration: StorageLensConfigurationTypeDef, # (1)
Tags: Sequence[StorageLensTagTypeDef] = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
# put_storage_lens_configuration method usage example with argument unpacking
kwargs: PutStorageLensConfigurationRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
"StorageLensConfiguration": ...,
}
parent.put_storage_lens_configuration(**kwargs)
put_storage_lens_configuration_tagging#
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
Type annotations and code completion for session.create_client("s3control").put_storage_lens_configuration_tagging
method.
boto3 documentation
# put_storage_lens_configuration_tagging method definition
await def put_storage_lens_configuration_tagging(
self,
*,
ConfigId: str,
AccountId: str,
Tags: Sequence[StorageLensTagTypeDef], # (1)
) -> Dict[str, Any]:
...
# put_storage_lens_configuration_tagging method usage example with argument unpacking
kwargs: PutStorageLensConfigurationTaggingRequestRequestTypeDef = { # (1)
"ConfigId": ...,
"AccountId": ...,
"Tags": ...,
}
parent.put_storage_lens_configuration_tagging(**kwargs)
submit_multi_region_access_point_routes#
Submits an updated route configuration for a Multi-Region Access Point.
Type annotations and code completion for session.create_client("s3control").submit_multi_region_access_point_routes
method.
boto3 documentation
# submit_multi_region_access_point_routes method definition
await def submit_multi_region_access_point_routes(
self,
*,
AccountId: str,
Mrap: str,
RouteUpdates: Sequence[MultiRegionAccessPointRouteTypeDef], # (1)
) -> Dict[str, Any]:
...
# submit_multi_region_access_point_routes method usage example with argument unpacking
kwargs: SubmitMultiRegionAccessPointRoutesRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Mrap": ...,
"RouteUpdates": ...,
}
parent.submit_multi_region_access_point_routes(**kwargs)
update_job_priority#
Updates an existing S3 Batch Operations job's priority.
Type annotations and code completion for session.create_client("s3control").update_job_priority
method.
boto3 documentation
# update_job_priority method definition
await def update_job_priority(
self,
*,
AccountId: str,
JobId: str,
Priority: int,
) -> UpdateJobPriorityResultTypeDef: # (1)
...
# update_job_priority method usage example with argument unpacking
kwargs: UpdateJobPriorityRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
"Priority": ...,
}
parent.update_job_priority(**kwargs)
update_job_status#
Updates the status for the specified job.
Type annotations and code completion for session.create_client("s3control").update_job_status
method.
boto3 documentation
# update_job_status method definition
await def update_job_status(
self,
*,
AccountId: str,
JobId: str,
RequestedJobStatus: RequestedJobStatusType, # (1)
StatusUpdateReason: str = ...,
) -> UpdateJobStatusResultTypeDef: # (2)
...
# update_job_status method usage example with argument unpacking
kwargs: UpdateJobStatusRequestRequestTypeDef = { # (1)
"AccountId": ...,
"JobId": ...,
"RequestedJobStatus": ...,
}
parent.update_job_status(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("s3control").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> S3ControlClient:
...
__aexit__#
Type annotations and code completion for session.create_client("s3control").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("s3control").get_paginator
method with overloads.
client.get_paginator("list_access_points_for_object_lambda")
-> ListAccessPointsForObjectLambdaPaginator