S3ControlClient#
Auto-generated documentation for S3Control type annotations stubs module mypy-boto3-s3control.
S3ControlClient#
Type annotations and code completion for boto3.client("s3control")
.
boto3 documentation
# S3ControlClient usage example
from boto3.session import Session
from mypy_boto3_s3control.client import S3ControlClient
def get_s3control_client() -> S3ControlClient:
return Session().client("s3control")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("s3control").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("s3control")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.BucketAlreadyExists,
client.exceptions.BucketAlreadyOwnedByYou,
client.exceptions.ClientError,
client.exceptions.IdempotencyException,
client.exceptions.InternalServiceException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidRequestException,
client.exceptions.JobStatusException,
client.exceptions.NoSuchPublicAccessBlockConfiguration,
client.exceptions.NotFoundException,
client.exceptions.TooManyRequestsException,
client.exceptions.TooManyTagsException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_s3control.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods#
associate_access_grants_identity_center#
Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance.
Type annotations and code completion for boto3.client("s3control").associate_access_grants_identity_center
method.
boto3 documentation
# associate_access_grants_identity_center method definition
def associate_access_grants_identity_center(
self,
*,
AccountId: str,
IdentityCenterArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# associate_access_grants_identity_center method usage example with argument unpacking
kwargs: AssociateAccessGrantsIdentityCenterRequestRequestTypeDef = { # (1)
"AccountId": ...,
"IdentityCenterArn": ...,
}
parent.associate_access_grants_identity_center(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.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 boto3.client("s3control").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_access_grant#
Creates an access grant that gives a grantee access to your S3 data.
Type annotations and code completion for boto3.client("s3control").create_access_grant
method.
boto3 documentation
# create_access_grant method definition
def create_access_grant(
self,
*,
AccountId: str,
AccessGrantsLocationId: str,
Grantee: GranteeTypeDef, # (1)
Permission: PermissionType, # (2)
AccessGrantsLocationConfiguration: AccessGrantsLocationConfigurationTypeDef = ..., # (3)
ApplicationArn: str = ...,
S3PrefixType: S3PrefixTypeType = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateAccessGrantResultTypeDef: # (6)
...
- See GranteeTypeDef
- See PermissionType
- See AccessGrantsLocationConfigurationTypeDef
- See S3PrefixTypeType
- See TagTypeDef
- See CreateAccessGrantResultTypeDef
# create_access_grant method usage example with argument unpacking
kwargs: CreateAccessGrantRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantsLocationId": ...,
"Grantee": ...,
"Permission": ...,
}
parent.create_access_grant(**kwargs)
create_access_grants_instance#
Creates an S3 Access Grants instance, which serves as a logical grouping for access grants.
Type annotations and code completion for boto3.client("s3control").create_access_grants_instance
method.
boto3 documentation
# create_access_grants_instance method definition
def create_access_grants_instance(
self,
*,
AccountId: str,
IdentityCenterArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAccessGrantsInstanceResultTypeDef: # (2)
...
# create_access_grants_instance method usage example with argument unpacking
kwargs: CreateAccessGrantsInstanceRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.create_access_grants_instance(**kwargs)
create_access_grants_location#
The S3 data location that you would like to register in your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").create_access_grants_location
method.
boto3 documentation
# create_access_grants_location method definition
def create_access_grants_location(
self,
*,
AccountId: str,
LocationScope: str,
IAMRoleArn: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAccessGrantsLocationResultTypeDef: # (2)
...
# create_access_grants_location method usage example with argument unpacking
kwargs: CreateAccessGrantsLocationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"LocationScope": ...,
"IAMRoleArn": ...,
}
parent.create_access_grants_location(**kwargs)
create_access_point#
.
Type annotations and code completion for boto3.client("s3control").create_access_point
method.
boto3 documentation
# create_access_point method definition
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#
.
Type annotations and code completion for boto3.client("s3control").create_access_point_for_object_lambda
method.
boto3 documentation
# create_access_point_for_object_lambda method definition
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 boto3.client("s3control").create_bucket
method.
boto3 documentation
# create_bucket method definition
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#
This operation creates an S3 Batch Operations job.
Type annotations and code completion for boto3.client("s3control").create_job
method.
boto3 documentation
# create_job method definition
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#
.
Type annotations and code completion for boto3.client("s3control").create_multi_region_access_point
method.
boto3 documentation
# create_multi_region_access_point method definition
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)
create_storage_lens_group#
Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID.
Type annotations and code completion for boto3.client("s3control").create_storage_lens_group
method.
boto3 documentation
# create_storage_lens_group method definition
def create_storage_lens_group(
self,
*,
AccountId: str,
StorageLensGroup: StorageLensGroupTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
# create_storage_lens_group method usage example with argument unpacking
kwargs: CreateStorageLensGroupRequestRequestTypeDef = { # (1)
"AccountId": ...,
"StorageLensGroup": ...,
}
parent.create_storage_lens_group(**kwargs)
delete_access_grant#
Deletes the access grant from the S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").delete_access_grant
method.
boto3 documentation
# delete_access_grant method definition
def delete_access_grant(
self,
*,
AccountId: str,
AccessGrantId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_grant method usage example with argument unpacking
kwargs: DeleteAccessGrantRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantId": ...,
}
parent.delete_access_grant(**kwargs)
delete_access_grants_instance#
Deletes your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").delete_access_grants_instance
method.
boto3 documentation
# delete_access_grants_instance method definition
def delete_access_grants_instance(
self,
*,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_grants_instance method usage example with argument unpacking
kwargs: DeleteAccessGrantsInstanceRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.delete_access_grants_instance(**kwargs)
delete_access_grants_instance_resource_policy#
Deletes the resource policy of the S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").delete_access_grants_instance_resource_policy
method.
boto3 documentation
# delete_access_grants_instance_resource_policy method definition
def delete_access_grants_instance_resource_policy(
self,
*,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_grants_instance_resource_policy method usage example with argument unpacking
kwargs: DeleteAccessGrantsInstanceResourcePolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.delete_access_grants_instance_resource_policy(**kwargs)
delete_access_grants_location#
Deregisters a location from your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").delete_access_grants_location
method.
boto3 documentation
# delete_access_grants_location method definition
def delete_access_grants_location(
self,
*,
AccountId: str,
AccessGrantsLocationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_grants_location method usage example with argument unpacking
kwargs: DeleteAccessGrantsLocationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantsLocationId": ...,
}
parent.delete_access_grants_location(**kwargs)
delete_access_point#
.
Type annotations and code completion for boto3.client("s3control").delete_access_point
method.
boto3 documentation
# delete_access_point method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_access_point_for_object_lambda
method.
boto3 documentation
# delete_access_point_for_object_lambda method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_access_point_policy
method.
boto3 documentation
# delete_access_point_policy method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_access_point_policy_for_object_lambda
method.
boto3 documentation
# delete_access_point_policy_for_object_lambda method definition
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 boto3.client("s3control").delete_bucket
method.
boto3 documentation
# delete_bucket method definition
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 boto3.client("s3control").delete_bucket_lifecycle_configuration
method.
boto3 documentation
# delete_bucket_lifecycle_configuration method definition
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 boto3.client("s3control").delete_bucket_policy
method.
boto3 documentation
# delete_bucket_policy method definition
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 boto3.client("s3control").delete_bucket_replication
method.
boto3 documentation
# delete_bucket_replication method definition
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 boto3.client("s3control").delete_bucket_tagging
method.
boto3 documentation
# delete_bucket_tagging method definition
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 boto3.client("s3control").delete_job_tagging
method.
boto3 documentation
# delete_job_tagging method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_multi_region_access_point
method.
boto3 documentation
# delete_multi_region_access_point method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_public_access_block
method.
boto3 documentation
# delete_public_access_block method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_storage_lens_configuration
method.
boto3 documentation
# delete_storage_lens_configuration method definition
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#
.
Type annotations and code completion for boto3.client("s3control").delete_storage_lens_configuration_tagging
method.
boto3 documentation
# delete_storage_lens_configuration_tagging method definition
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)
delete_storage_lens_group#
Deletes an existing S3 Storage Lens group.
Type annotations and code completion for boto3.client("s3control").delete_storage_lens_group
method.
boto3 documentation
# delete_storage_lens_group method definition
def delete_storage_lens_group(
self,
*,
Name: str,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_storage_lens_group method usage example with argument unpacking
kwargs: DeleteStorageLensGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"AccountId": ...,
}
parent.delete_storage_lens_group(**kwargs)
describe_job#
Retrieves the configuration parameters and status for a Batch Operations job.
Type annotations and code completion for boto3.client("s3control").describe_job
method.
boto3 documentation
# describe_job method definition
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#
.
Type annotations and code completion for boto3.client("s3control").describe_multi_region_access_point_operation
method.
boto3 documentation
# describe_multi_region_access_point_operation method definition
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)
dissociate_access_grants_identity_center#
Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").dissociate_access_grants_identity_center
method.
boto3 documentation
# dissociate_access_grants_identity_center method definition
def dissociate_access_grants_identity_center(
self,
*,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# dissociate_access_grants_identity_center method usage example with argument unpacking
kwargs: DissociateAccessGrantsIdentityCenterRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.dissociate_access_grants_identity_center(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("s3control").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_access_grant#
Get the details of an access grant from your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").get_access_grant
method.
boto3 documentation
# get_access_grant method definition
def get_access_grant(
self,
*,
AccountId: str,
AccessGrantId: str,
) -> GetAccessGrantResultTypeDef: # (1)
...
# get_access_grant method usage example with argument unpacking
kwargs: GetAccessGrantRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantId": ...,
}
parent.get_access_grant(**kwargs)
get_access_grants_instance#
Retrieves the S3 Access Grants instance for a Region in your account.
Type annotations and code completion for boto3.client("s3control").get_access_grants_instance
method.
boto3 documentation
# get_access_grants_instance method definition
def get_access_grants_instance(
self,
*,
AccountId: str,
) -> GetAccessGrantsInstanceResultTypeDef: # (1)
...
# get_access_grants_instance method usage example with argument unpacking
kwargs: GetAccessGrantsInstanceRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.get_access_grants_instance(**kwargs)
get_access_grants_instance_for_prefix#
Retrieve the S3 Access Grants instance that contains a particular prefix.
Type annotations and code completion for boto3.client("s3control").get_access_grants_instance_for_prefix
method.
boto3 documentation
# get_access_grants_instance_for_prefix method definition
def get_access_grants_instance_for_prefix(
self,
*,
AccountId: str,
S3Prefix: str,
) -> GetAccessGrantsInstanceForPrefixResultTypeDef: # (1)
...
# get_access_grants_instance_for_prefix method usage example with argument unpacking
kwargs: GetAccessGrantsInstanceForPrefixRequestRequestTypeDef = { # (1)
"AccountId": ...,
"S3Prefix": ...,
}
parent.get_access_grants_instance_for_prefix(**kwargs)
get_access_grants_instance_resource_policy#
Returns the resource policy of the S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").get_access_grants_instance_resource_policy
method.
boto3 documentation
# get_access_grants_instance_resource_policy method definition
def get_access_grants_instance_resource_policy(
self,
*,
AccountId: str,
) -> GetAccessGrantsInstanceResourcePolicyResultTypeDef: # (1)
...
# get_access_grants_instance_resource_policy method usage example with argument unpacking
kwargs: GetAccessGrantsInstanceResourcePolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.get_access_grants_instance_resource_policy(**kwargs)
get_access_grants_location#
Retrieves the details of a particular location registered in your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").get_access_grants_location
method.
boto3 documentation
# get_access_grants_location method definition
def get_access_grants_location(
self,
*,
AccountId: str,
AccessGrantsLocationId: str,
) -> GetAccessGrantsLocationResultTypeDef: # (1)
...
# get_access_grants_location method usage example with argument unpacking
kwargs: GetAccessGrantsLocationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantsLocationId": ...,
}
parent.get_access_grants_location(**kwargs)
get_access_point#
.
Type annotations and code completion for boto3.client("s3control").get_access_point
method.
boto3 documentation
# get_access_point method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_configuration_for_object_lambda
method.
boto3 documentation
# get_access_point_configuration_for_object_lambda method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_for_object_lambda
method.
boto3 documentation
# get_access_point_for_object_lambda method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_policy
method.
boto3 documentation
# get_access_point_policy method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_policy_for_object_lambda
method.
boto3 documentation
# get_access_point_policy_for_object_lambda method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_policy_status
method.
boto3 documentation
# get_access_point_policy_status method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_access_point_policy_status_for_object_lambda
method.
boto3 documentation
# get_access_point_policy_status_for_object_lambda method definition
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 boto3.client("s3control").get_bucket
method.
boto3 documentation
# get_bucket method definition
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 boto3.client("s3control").get_bucket_lifecycle_configuration
method.
boto3 documentation
# get_bucket_lifecycle_configuration method definition
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 boto3.client("s3control").get_bucket_policy
method.
boto3 documentation
# get_bucket_policy method definition
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 boto3.client("s3control").get_bucket_replication
method.
boto3 documentation
# get_bucket_replication method definition
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 boto3.client("s3control").get_bucket_tagging
method.
boto3 documentation
# get_bucket_tagging method definition
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 boto3.client("s3control").get_bucket_versioning
method.
boto3 documentation
# get_bucket_versioning method definition
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_data_access#
Returns a temporary access credential from S3 Access Grants to the grantee or client application.
Type annotations and code completion for boto3.client("s3control").get_data_access
method.
boto3 documentation
# get_data_access method definition
def get_data_access(
self,
*,
AccountId: str,
Target: str,
Permission: PermissionType, # (1)
DurationSeconds: int = ...,
Privilege: PrivilegeType = ..., # (2)
TargetType: S3PrefixTypeType = ..., # (3)
) -> GetDataAccessResultTypeDef: # (4)
...
- See PermissionType
- See PrivilegeType
- See S3PrefixTypeType
- See GetDataAccessResultTypeDef
# get_data_access method usage example with argument unpacking
kwargs: GetDataAccessRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Target": ...,
"Permission": ...,
}
parent.get_data_access(**kwargs)
get_job_tagging#
Returns the tags on an S3 Batch Operations job.
Type annotations and code completion for boto3.client("s3control").get_job_tagging
method.
boto3 documentation
# get_job_tagging method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_multi_region_access_point
method.
boto3 documentation
# get_multi_region_access_point method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_multi_region_access_point_policy
method.
boto3 documentation
# get_multi_region_access_point_policy method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_multi_region_access_point_policy_status
method.
boto3 documentation
# get_multi_region_access_point_policy_status method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_multi_region_access_point_routes
method.
boto3 documentation
# get_multi_region_access_point_routes method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_public_access_block
method.
boto3 documentation
# get_public_access_block method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_storage_lens_configuration
method.
boto3 documentation
# get_storage_lens_configuration method definition
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#
.
Type annotations and code completion for boto3.client("s3control").get_storage_lens_configuration_tagging
method.
boto3 documentation
# get_storage_lens_configuration_tagging method definition
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)
get_storage_lens_group#
Retrieves the Storage Lens group configuration details.
Type annotations and code completion for boto3.client("s3control").get_storage_lens_group
method.
boto3 documentation
# get_storage_lens_group method definition
def get_storage_lens_group(
self,
*,
Name: str,
AccountId: str,
) -> GetStorageLensGroupResultTypeDef: # (1)
...
# get_storage_lens_group method usage example with argument unpacking
kwargs: GetStorageLensGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"AccountId": ...,
}
parent.get_storage_lens_group(**kwargs)
list_access_grants#
Returns the list of access grants in your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").list_access_grants
method.
boto3 documentation
# list_access_grants method definition
def list_access_grants(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
GranteeType: GranteeTypeType = ..., # (1)
GranteeIdentifier: str = ...,
Permission: PermissionType = ..., # (2)
GrantScope: str = ...,
ApplicationArn: str = ...,
) -> ListAccessGrantsResultTypeDef: # (3)
...
# list_access_grants method usage example with argument unpacking
kwargs: ListAccessGrantsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_access_grants(**kwargs)
list_access_grants_instances#
Returns a list of S3 Access Grants instances.
Type annotations and code completion for boto3.client("s3control").list_access_grants_instances
method.
boto3 documentation
# list_access_grants_instances method definition
def list_access_grants_instances(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAccessGrantsInstancesResultTypeDef: # (1)
...
# list_access_grants_instances method usage example with argument unpacking
kwargs: ListAccessGrantsInstancesRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_access_grants_instances(**kwargs)
list_access_grants_locations#
Returns a list of the locations registered in your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").list_access_grants_locations
method.
boto3 documentation
# list_access_grants_locations method definition
def list_access_grants_locations(
self,
*,
AccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
LocationScope: str = ...,
) -> ListAccessGrantsLocationsResultTypeDef: # (1)
...
# list_access_grants_locations method usage example with argument unpacking
kwargs: ListAccessGrantsLocationsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_access_grants_locations(**kwargs)
list_access_points#
.
Type annotations and code completion for boto3.client("s3control").list_access_points
method.
boto3 documentation
# list_access_points method definition
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#
.
Type annotations and code completion for boto3.client("s3control").list_access_points_for_object_lambda
method.
boto3 documentation
# list_access_points_for_object_lambda method definition
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_caller_access_grants#
Returns a list of the access grants that were given to the caller using S3 Access Grants and that allow the caller to access the S3 data of the Amazon Web Services account specified in the request.
Type annotations and code completion for boto3.client("s3control").list_caller_access_grants
method.
boto3 documentation
# list_caller_access_grants method definition
def list_caller_access_grants(
self,
*,
AccountId: str,
GrantScope: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
AllowedByApplication: bool = ...,
) -> ListCallerAccessGrantsResultTypeDef: # (1)
...
# list_caller_access_grants method usage example with argument unpacking
kwargs: ListCallerAccessGrantsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_caller_access_grants(**kwargs)
list_jobs#
Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request.
Type annotations and code completion for boto3.client("s3control").list_jobs
method.
boto3 documentation
# list_jobs method definition
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#
.
Type annotations and code completion for boto3.client("s3control").list_multi_region_access_points
method.
boto3 documentation
# list_multi_region_access_points method definition
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#
.
Type annotations and code completion for boto3.client("s3control").list_regional_buckets
method.
boto3 documentation
# list_regional_buckets method definition
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#
.
Type annotations and code completion for boto3.client("s3control").list_storage_lens_configurations
method.
boto3 documentation
# list_storage_lens_configurations method definition
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)
list_storage_lens_groups#
Lists all the Storage Lens groups in the specified home Region.
Type annotations and code completion for boto3.client("s3control").list_storage_lens_groups
method.
boto3 documentation
# list_storage_lens_groups method definition
def list_storage_lens_groups(
self,
*,
AccountId: str,
NextToken: str = ...,
) -> ListStorageLensGroupsResultTypeDef: # (1)
...
# list_storage_lens_groups method usage example with argument unpacking
kwargs: ListStorageLensGroupsRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.list_storage_lens_groups(**kwargs)
list_tags_for_resource#
This operation allows you to list all the Amazon Web Services resource tags for a specified resource.
Type annotations and code completion for boto3.client("s3control").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
AccountId: str,
ResourceArn: str,
) -> ListTagsForResourceResultTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_access_grants_instance_resource_policy#
Updates the resource policy of the S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").put_access_grants_instance_resource_policy
method.
boto3 documentation
# put_access_grants_instance_resource_policy method definition
def put_access_grants_instance_resource_policy(
self,
*,
AccountId: str,
Policy: str,
Organization: str = ...,
) -> PutAccessGrantsInstanceResourcePolicyResultTypeDef: # (1)
...
# put_access_grants_instance_resource_policy method usage example with argument unpacking
kwargs: PutAccessGrantsInstanceResourcePolicyRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Policy": ...,
}
parent.put_access_grants_instance_resource_policy(**kwargs)
put_access_point_configuration_for_object_lambda#
.
Type annotations and code completion for boto3.client("s3control").put_access_point_configuration_for_object_lambda
method.
boto3 documentation
# put_access_point_configuration_for_object_lambda method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_access_point_policy
method.
boto3 documentation
# put_access_point_policy method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_access_point_policy_for_object_lambda
method.
boto3 documentation
# put_access_point_policy_for_object_lambda method definition
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 boto3.client("s3control").put_bucket_lifecycle_configuration
method.
boto3 documentation
# put_bucket_lifecycle_configuration method definition
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 boto3.client("s3control").put_bucket_policy
method.
boto3 documentation
# put_bucket_policy method definition
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 boto3.client("s3control").put_bucket_replication
method.
boto3 documentation
# put_bucket_replication method definition
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 boto3.client("s3control").put_bucket_tagging
method.
boto3 documentation
# put_bucket_tagging method definition
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 boto3.client("s3control").put_bucket_versioning
method.
boto3 documentation
# put_bucket_versioning method definition
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 boto3.client("s3control").put_job_tagging
method.
boto3 documentation
# put_job_tagging method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_multi_region_access_point_policy
method.
boto3 documentation
# put_multi_region_access_point_policy method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_public_access_block
method.
boto3 documentation
# put_public_access_block method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_storage_lens_configuration
method.
boto3 documentation
# put_storage_lens_configuration method definition
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#
.
Type annotations and code completion for boto3.client("s3control").put_storage_lens_configuration_tagging
method.
boto3 documentation
# put_storage_lens_configuration_tagging method definition
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#
.
Type annotations and code completion for boto3.client("s3control").submit_multi_region_access_point_routes
method.
boto3 documentation
# submit_multi_region_access_point_routes method definition
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)
tag_resource#
Creates a new Amazon Web Services resource tag or updates an existing resource tag.
Type annotations and code completion for boto3.client("s3control").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
AccountId: str,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
This operation removes the specified Amazon Web Services resource tags from an S3 resource.
Type annotations and code completion for boto3.client("s3control").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
AccountId: str,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"AccountId": ...,
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_access_grants_location#
Updates the IAM role of a registered location in your S3 Access Grants instance.
Type annotations and code completion for boto3.client("s3control").update_access_grants_location
method.
boto3 documentation
# update_access_grants_location method definition
def update_access_grants_location(
self,
*,
AccountId: str,
AccessGrantsLocationId: str,
IAMRoleArn: str,
) -> UpdateAccessGrantsLocationResultTypeDef: # (1)
...
# update_access_grants_location method usage example with argument unpacking
kwargs: UpdateAccessGrantsLocationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"AccessGrantsLocationId": ...,
"IAMRoleArn": ...,
}
parent.update_access_grants_location(**kwargs)
update_job_priority#
Updates an existing S3 Batch Operations job's priority.
Type annotations and code completion for boto3.client("s3control").update_job_priority
method.
boto3 documentation
# update_job_priority method definition
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 boto3.client("s3control").update_job_status
method.
boto3 documentation
# update_job_status method definition
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)
update_storage_lens_group#
Updates the existing Storage Lens group.
Type annotations and code completion for boto3.client("s3control").update_storage_lens_group
method.
boto3 documentation
# update_storage_lens_group method definition
def update_storage_lens_group(
self,
*,
Name: str,
AccountId: str,
StorageLensGroup: StorageLensGroupTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_storage_lens_group method usage example with argument unpacking
kwargs: UpdateStorageLensGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"AccountId": ...,
"StorageLensGroup": ...,
}
parent.update_storage_lens_group(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("s3control").get_paginator
method with overloads.
client.get_paginator("list_access_points_for_object_lambda")
-> ListAccessPointsForObjectLambdaPaginatorclient.get_paginator("list_caller_access_grants")
-> ListCallerAccessGrantsPaginator