Skip to content

S3ControlClient#

Index > S3Control > 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#

can_paginate#

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:
    ...

generate_presigned_url#

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:
    ...

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# associate_access_grants_identity_center method usage example with argument unpacking

kwargs: AssociateAccessGrantsIdentityCenterRequestTypeDef = {  # (1)
    "AccountId": ...,
    "IdentityCenterArn": ...,
}

parent.associate_access_grants_identity_center(**kwargs)
  1. See AssociateAccessGrantsIdentityCenterRequestTypeDef

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)
    ...
  1. See GranteeTypeDef
  2. See PermissionType
  3. See AccessGrantsLocationConfigurationTypeDef
  4. See S3PrefixTypeType
  5. See Sequence[TagTypeDef]
  6. See CreateAccessGrantResultTypeDef
# create_access_grant method usage example with argument unpacking

kwargs: CreateAccessGrantRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantsLocationId": ...,
    "Grantee": ...,
    "Permission": ...,
}

parent.create_access_grant(**kwargs)
  1. See CreateAccessGrantRequestTypeDef

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)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateAccessGrantsInstanceResultTypeDef
# create_access_grants_instance method usage example with argument unpacking

kwargs: CreateAccessGrantsInstanceRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.create_access_grants_instance(**kwargs)
  1. See CreateAccessGrantsInstanceRequestTypeDef

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)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateAccessGrantsLocationResultTypeDef
# create_access_grants_location method usage example with argument unpacking

kwargs: CreateAccessGrantsLocationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "LocationScope": ...,
    "IAMRoleArn": ...,
}

parent.create_access_grants_location(**kwargs)
  1. See CreateAccessGrantsLocationRequestTypeDef

create_access_point#

Creates an access point and associates it to a specified bucket.

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 = ...,
    Scope: ScopeUnionTypeDef = ...,  # (3)
) -> CreateAccessPointResultTypeDef:  # (4)
    ...
  1. See VpcConfigurationTypeDef
  2. See PublicAccessBlockConfigurationTypeDef
  3. See ScopeUnionTypeDef
  4. See CreateAccessPointResultTypeDef
# create_access_point method usage example with argument unpacking

kwargs: CreateAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Bucket": ...,
}

parent.create_access_point(**kwargs)
  1. See CreateAccessPointRequestTypeDef

create_access_point_for_object_lambda#

This operation is not supported by directory buckets.

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: ObjectLambdaConfigurationUnionTypeDef,  # (1)
) -> CreateAccessPointForObjectLambdaResultTypeDef:  # (2)
    ...
  1. See ObjectLambdaConfigurationUnionTypeDef
  2. See CreateAccessPointForObjectLambdaResultTypeDef
# create_access_point_for_object_lambda method usage example with argument unpacking

kwargs: CreateAccessPointForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Configuration": ...,
}

parent.create_access_point_for_object_lambda(**kwargs)
  1. See CreateAccessPointForObjectLambdaRequestTypeDef

create_bucket#

This action creates an Amazon S3 on Outposts 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)
    ...
  1. See BucketCannedACLType
  2. See CreateBucketConfigurationTypeDef
  3. See CreateBucketResultTypeDef
# create_bucket method usage example with argument unpacking

kwargs: CreateBucketRequestTypeDef = {  # (1)
    "Bucket": ...,
}

parent.create_bucket(**kwargs)
  1. See CreateBucketRequestTypeDef

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: JobOperationUnionTypeDef,  # (1)
    Report: JobReportTypeDef,  # (2)
    ClientRequestToken: str,
    Priority: int,
    RoleArn: str,
    ConfirmationRequired: bool = ...,
    Manifest: JobManifestUnionTypeDef = ...,  # (3)
    Description: str = ...,
    Tags: Sequence[S3TagTypeDef] = ...,  # (4)
    ManifestGenerator: JobManifestGeneratorUnionTypeDef = ...,  # (5)
) -> CreateJobResultTypeDef:  # (6)
    ...
  1. See JobOperationUnionTypeDef
  2. See JobReportTypeDef
  3. See JobManifestUnionTypeDef
  4. See Sequence[S3TagTypeDef]
  5. See JobManifestGeneratorUnionTypeDef
  6. See CreateJobResultTypeDef
# create_job method usage example with argument unpacking

kwargs: CreateJobRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Operation": ...,
    "Report": ...,
    "ClientRequestToken": ...,
    "Priority": ...,
    "RoleArn": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobRequestTypeDef

create_multi_region_access_point#

This operation is not supported by directory buckets.

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: CreateMultiRegionAccessPointInputUnionTypeDef,  # (1)
) -> CreateMultiRegionAccessPointResultTypeDef:  # (2)
    ...
  1. See CreateMultiRegionAccessPointInputUnionTypeDef
  2. See CreateMultiRegionAccessPointResultTypeDef
# create_multi_region_access_point method usage example with argument unpacking

kwargs: CreateMultiRegionAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClientToken": ...,
    "Details": ...,
}

parent.create_multi_region_access_point(**kwargs)
  1. See CreateMultiRegionAccessPointRequestTypeDef

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: StorageLensGroupUnionTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See StorageLensGroupUnionTypeDef
  2. See Sequence[TagTypeDef]
  3. See EmptyResponseMetadataTypeDef
# create_storage_lens_group method usage example with argument unpacking

kwargs: CreateStorageLensGroupRequestTypeDef = {  # (1)
    "AccountId": ...,
    "StorageLensGroup": ...,
}

parent.create_storage_lens_group(**kwargs)
  1. See CreateStorageLensGroupRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_grant method usage example with argument unpacking

kwargs: DeleteAccessGrantRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantId": ...,
}

parent.delete_access_grant(**kwargs)
  1. See DeleteAccessGrantRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_grants_instance method usage example with argument unpacking

kwargs: DeleteAccessGrantsInstanceRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_access_grants_instance(**kwargs)
  1. See DeleteAccessGrantsInstanceRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_grants_instance_resource_policy method usage example with argument unpacking

kwargs: DeleteAccessGrantsInstanceResourcePolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_access_grants_instance_resource_policy(**kwargs)
  1. See DeleteAccessGrantsInstanceResourcePolicyRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_grants_location method usage example with argument unpacking

kwargs: DeleteAccessGrantsLocationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantsLocationId": ...,
}

parent.delete_access_grants_location(**kwargs)
  1. See DeleteAccessGrantsLocationRequestTypeDef

delete_access_point#

Deletes the specified 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_point method usage example with argument unpacking

kwargs: DeleteAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.delete_access_point(**kwargs)
  1. See DeleteAccessPointRequestTypeDef

delete_access_point_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_point_for_object_lambda method usage example with argument unpacking

kwargs: DeleteAccessPointForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.delete_access_point_for_object_lambda(**kwargs)
  1. See DeleteAccessPointForObjectLambdaRequestTypeDef

delete_access_point_policy#

Deletes the access point policy for the specified access point.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_point_policy method usage example with argument unpacking

kwargs: DeleteAccessPointPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.delete_access_point_policy(**kwargs)
  1. See DeleteAccessPointPolicyRequestTypeDef

delete_access_point_policy_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_point_policy_for_object_lambda method usage example with argument unpacking

kwargs: DeleteAccessPointPolicyForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.delete_access_point_policy_for_object_lambda(**kwargs)
  1. See DeleteAccessPointPolicyForObjectLambdaRequestTypeDef

delete_access_point_scope#

Deletes an existing access point scope for a directory bucket.

Type annotations and code completion for boto3.client("s3control").delete_access_point_scope method. boto3 documentation

# delete_access_point_scope method definition

def delete_access_point_scope(
    self,
    *,
    AccountId: str,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_access_point_scope method usage example with argument unpacking

kwargs: DeleteAccessPointScopeRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.delete_access_point_scope(**kwargs)
  1. See DeleteAccessPointScopeRequestTypeDef

delete_bucket#

This action deletes an Amazon S3 on Outposts 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_bucket method usage example with argument unpacking

kwargs: DeleteBucketRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.delete_bucket(**kwargs)
  1. See DeleteBucketRequestTypeDef

delete_bucket_lifecycle_configuration#

This action deletes an Amazon S3 on Outposts bucket's 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_bucket_lifecycle_configuration method usage example with argument unpacking

kwargs: DeleteBucketLifecycleConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.delete_bucket_lifecycle_configuration(**kwargs)
  1. See DeleteBucketLifecycleConfigurationRequestTypeDef

delete_bucket_policy#

This action deletes an Amazon S3 on Outposts 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_bucket_policy method usage example with argument unpacking

kwargs: DeleteBucketPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.delete_bucket_policy(**kwargs)
  1. See DeleteBucketPolicyRequestTypeDef

delete_bucket_replication#

This operation deletes an Amazon S3 on Outposts bucket's replication configuration.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_bucket_replication method usage example with argument unpacking

kwargs: DeleteBucketReplicationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.delete_bucket_replication(**kwargs)
  1. See DeleteBucketReplicationRequestTypeDef

delete_bucket_tagging#

This action deletes an Amazon S3 on Outposts bucket's tags.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_bucket_tagging method usage example with argument unpacking

kwargs: DeleteBucketTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.delete_bucket_tagging(**kwargs)
  1. See DeleteBucketTaggingRequestTypeDef

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: DeleteJobTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
}

parent.delete_job_tagging(**kwargs)
  1. See DeleteJobTaggingRequestTypeDef

delete_multi_region_access_point#

This operation is not supported by directory buckets.

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)
    ...
  1. See DeleteMultiRegionAccessPointInputTypeDef
  2. See DeleteMultiRegionAccessPointResultTypeDef
# delete_multi_region_access_point method usage example with argument unpacking

kwargs: DeleteMultiRegionAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClientToken": ...,
    "Details": ...,
}

parent.delete_multi_region_access_point(**kwargs)
  1. See DeleteMultiRegionAccessPointRequestTypeDef

delete_public_access_block#

This operation is not supported by directory buckets.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_public_access_block method usage example with argument unpacking

kwargs: DeletePublicAccessBlockRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_public_access_block(**kwargs)
  1. See DeletePublicAccessBlockRequestTypeDef

delete_storage_lens_configuration#

This operation is not supported by directory buckets.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_storage_lens_configuration method usage example with argument unpacking

kwargs: DeleteStorageLensConfigurationRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
}

parent.delete_storage_lens_configuration(**kwargs)
  1. See DeleteStorageLensConfigurationRequestTypeDef

delete_storage_lens_configuration_tagging#

This operation is not supported by directory buckets.

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: DeleteStorageLensConfigurationTaggingRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
}

parent.delete_storage_lens_configuration_tagging(**kwargs)
  1. See DeleteStorageLensConfigurationTaggingRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_storage_lens_group method usage example with argument unpacking

kwargs: DeleteStorageLensGroupRequestTypeDef = {  # (1)
    "Name": ...,
    "AccountId": ...,
}

parent.delete_storage_lens_group(**kwargs)
  1. See DeleteStorageLensGroupRequestTypeDef

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)
    ...
  1. See DescribeJobResultTypeDef
# describe_job method usage example with argument unpacking

kwargs: DescribeJobRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
}

parent.describe_job(**kwargs)
  1. See DescribeJobRequestTypeDef

describe_multi_region_access_point_operation#

This operation is not supported by directory buckets.

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)
    ...
  1. See DescribeMultiRegionAccessPointOperationResultTypeDef
# describe_multi_region_access_point_operation method usage example with argument unpacking

kwargs: DescribeMultiRegionAccessPointOperationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RequestTokenARN": ...,
}

parent.describe_multi_region_access_point_operation(**kwargs)
  1. See DescribeMultiRegionAccessPointOperationRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# dissociate_access_grants_identity_center method usage example with argument unpacking

kwargs: DissociateAccessGrantsIdentityCenterRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.dissociate_access_grants_identity_center(**kwargs)
  1. See DissociateAccessGrantsIdentityCenterRequestTypeDef

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)
    ...
  1. See GetAccessGrantResultTypeDef
# get_access_grant method usage example with argument unpacking

kwargs: GetAccessGrantRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantId": ...,
}

parent.get_access_grant(**kwargs)
  1. See GetAccessGrantRequestTypeDef

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)
    ...
  1. See GetAccessGrantsInstanceResultTypeDef
# get_access_grants_instance method usage example with argument unpacking

kwargs: GetAccessGrantsInstanceRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_access_grants_instance(**kwargs)
  1. See GetAccessGrantsInstanceRequestTypeDef

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)
    ...
  1. See GetAccessGrantsInstanceForPrefixResultTypeDef
# get_access_grants_instance_for_prefix method usage example with argument unpacking

kwargs: GetAccessGrantsInstanceForPrefixRequestTypeDef = {  # (1)
    "AccountId": ...,
    "S3Prefix": ...,
}

parent.get_access_grants_instance_for_prefix(**kwargs)
  1. See GetAccessGrantsInstanceForPrefixRequestTypeDef

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)
    ...
  1. See GetAccessGrantsInstanceResourcePolicyResultTypeDef
# get_access_grants_instance_resource_policy method usage example with argument unpacking

kwargs: GetAccessGrantsInstanceResourcePolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_access_grants_instance_resource_policy(**kwargs)
  1. See GetAccessGrantsInstanceResourcePolicyRequestTypeDef

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)
    ...
  1. See GetAccessGrantsLocationResultTypeDef
# get_access_grants_location method usage example with argument unpacking

kwargs: GetAccessGrantsLocationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantsLocationId": ...,
}

parent.get_access_grants_location(**kwargs)
  1. See GetAccessGrantsLocationRequestTypeDef

get_access_point#

Returns configuration information about the specified 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)
    ...
  1. See GetAccessPointResultTypeDef
# get_access_point method usage example with argument unpacking

kwargs: GetAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point(**kwargs)
  1. See GetAccessPointRequestTypeDef

get_access_point_configuration_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetAccessPointConfigurationForObjectLambdaResultTypeDef
# get_access_point_configuration_for_object_lambda method usage example with argument unpacking

kwargs: GetAccessPointConfigurationForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_configuration_for_object_lambda(**kwargs)
  1. See GetAccessPointConfigurationForObjectLambdaRequestTypeDef

get_access_point_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetAccessPointForObjectLambdaResultTypeDef
# get_access_point_for_object_lambda method usage example with argument unpacking

kwargs: GetAccessPointForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_for_object_lambda(**kwargs)
  1. See GetAccessPointForObjectLambdaRequestTypeDef

get_access_point_policy#

Returns the access point policy associated with the specified access point.

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)
    ...
  1. See GetAccessPointPolicyResultTypeDef
# get_access_point_policy method usage example with argument unpacking

kwargs: GetAccessPointPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_policy(**kwargs)
  1. See GetAccessPointPolicyRequestTypeDef

get_access_point_policy_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetAccessPointPolicyForObjectLambdaResultTypeDef
# get_access_point_policy_for_object_lambda method usage example with argument unpacking

kwargs: GetAccessPointPolicyForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_policy_for_object_lambda(**kwargs)
  1. See GetAccessPointPolicyForObjectLambdaRequestTypeDef

get_access_point_policy_status#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetAccessPointPolicyStatusResultTypeDef
# get_access_point_policy_status method usage example with argument unpacking

kwargs: GetAccessPointPolicyStatusRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_policy_status(**kwargs)
  1. See GetAccessPointPolicyStatusRequestTypeDef

get_access_point_policy_status_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetAccessPointPolicyStatusForObjectLambdaResultTypeDef
# get_access_point_policy_status_for_object_lambda method usage example with argument unpacking

kwargs: GetAccessPointPolicyStatusForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_policy_status_for_object_lambda(**kwargs)
  1. See GetAccessPointPolicyStatusForObjectLambdaRequestTypeDef

get_access_point_scope#

Returns the access point scope for a directory bucket.

Type annotations and code completion for boto3.client("s3control").get_access_point_scope method. boto3 documentation

# get_access_point_scope method definition

def get_access_point_scope(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointScopeResultTypeDef:  # (1)
    ...
  1. See GetAccessPointScopeResultTypeDef
# get_access_point_scope method usage example with argument unpacking

kwargs: GetAccessPointScopeRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_access_point_scope(**kwargs)
  1. See GetAccessPointScopeRequestTypeDef

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)
    ...
  1. See GetBucketResultTypeDef
# get_bucket method usage example with argument unpacking

kwargs: GetBucketRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket(**kwargs)
  1. See GetBucketRequestTypeDef

get_bucket_lifecycle_configuration#

This action gets an Amazon S3 on Outposts bucket's 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)
    ...
  1. See GetBucketLifecycleConfigurationResultTypeDef
# get_bucket_lifecycle_configuration method usage example with argument unpacking

kwargs: GetBucketLifecycleConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket_lifecycle_configuration(**kwargs)
  1. See GetBucketLifecycleConfigurationRequestTypeDef

get_bucket_policy#

This action gets a bucket policy for an Amazon S3 on Outposts bucket.

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)
    ...
  1. See GetBucketPolicyResultTypeDef
# get_bucket_policy method usage example with argument unpacking

kwargs: GetBucketPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket_policy(**kwargs)
  1. See GetBucketPolicyRequestTypeDef

get_bucket_replication#

This operation gets an Amazon S3 on Outposts bucket's replication configuration.

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)
    ...
  1. See GetBucketReplicationResultTypeDef
# get_bucket_replication method usage example with argument unpacking

kwargs: GetBucketReplicationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket_replication(**kwargs)
  1. See GetBucketReplicationRequestTypeDef

get_bucket_tagging#

This action gets an Amazon S3 on Outposts bucket's tags.

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)
    ...
  1. See GetBucketTaggingResultTypeDef
# get_bucket_tagging method usage example with argument unpacking

kwargs: GetBucketTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket_tagging(**kwargs)
  1. See GetBucketTaggingRequestTypeDef

get_bucket_versioning#

This operation returns the versioning state for S3 on Outposts buckets only.

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)
    ...
  1. See GetBucketVersioningResultTypeDef
# get_bucket_versioning method usage example with argument unpacking

kwargs: GetBucketVersioningRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.get_bucket_versioning(**kwargs)
  1. See GetBucketVersioningRequestTypeDef

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)
    ...
  1. See PermissionType
  2. See PrivilegeType
  3. See S3PrefixTypeType
  4. See GetDataAccessResultTypeDef
# get_data_access method usage example with argument unpacking

kwargs: GetDataAccessRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Target": ...,
    "Permission": ...,
}

parent.get_data_access(**kwargs)
  1. See GetDataAccessRequestTypeDef

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)
    ...
  1. See GetJobTaggingResultTypeDef
# get_job_tagging method usage example with argument unpacking

kwargs: GetJobTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
}

parent.get_job_tagging(**kwargs)
  1. See GetJobTaggingRequestTypeDef

get_multi_region_access_point#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetMultiRegionAccessPointResultTypeDef
# get_multi_region_access_point method usage example with argument unpacking

kwargs: GetMultiRegionAccessPointRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_multi_region_access_point(**kwargs)
  1. See GetMultiRegionAccessPointRequestTypeDef

get_multi_region_access_point_policy#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetMultiRegionAccessPointPolicyResultTypeDef
# get_multi_region_access_point_policy method usage example with argument unpacking

kwargs: GetMultiRegionAccessPointPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_multi_region_access_point_policy(**kwargs)
  1. See GetMultiRegionAccessPointPolicyRequestTypeDef

get_multi_region_access_point_policy_status#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetMultiRegionAccessPointPolicyStatusResultTypeDef
# get_multi_region_access_point_policy_status method usage example with argument unpacking

kwargs: GetMultiRegionAccessPointPolicyStatusRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.get_multi_region_access_point_policy_status(**kwargs)
  1. See GetMultiRegionAccessPointPolicyStatusRequestTypeDef

get_multi_region_access_point_routes#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetMultiRegionAccessPointRoutesResultTypeDef
# get_multi_region_access_point_routes method usage example with argument unpacking

kwargs: GetMultiRegionAccessPointRoutesRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Mrap": ...,
}

parent.get_multi_region_access_point_routes(**kwargs)
  1. See GetMultiRegionAccessPointRoutesRequestTypeDef

get_public_access_block#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetPublicAccessBlockOutputTypeDef
# get_public_access_block method usage example with argument unpacking

kwargs: GetPublicAccessBlockRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_public_access_block(**kwargs)
  1. See GetPublicAccessBlockRequestTypeDef

get_storage_lens_configuration#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetStorageLensConfigurationResultTypeDef
# get_storage_lens_configuration method usage example with argument unpacking

kwargs: GetStorageLensConfigurationRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
}

parent.get_storage_lens_configuration(**kwargs)
  1. See GetStorageLensConfigurationRequestTypeDef

get_storage_lens_configuration_tagging#

This operation is not supported by directory buckets.

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)
    ...
  1. See GetStorageLensConfigurationTaggingResultTypeDef
# get_storage_lens_configuration_tagging method usage example with argument unpacking

kwargs: GetStorageLensConfigurationTaggingRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
}

parent.get_storage_lens_configuration_tagging(**kwargs)
  1. See GetStorageLensConfigurationTaggingRequestTypeDef

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)
    ...
  1. See GetStorageLensGroupResultTypeDef
# get_storage_lens_group method usage example with argument unpacking

kwargs: GetStorageLensGroupRequestTypeDef = {  # (1)
    "Name": ...,
    "AccountId": ...,
}

parent.get_storage_lens_group(**kwargs)
  1. See GetStorageLensGroupRequestTypeDef

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)
    ...
  1. See GranteeTypeType
  2. See PermissionType
  3. See ListAccessGrantsResultTypeDef
# list_access_grants method usage example with argument unpacking

kwargs: ListAccessGrantsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_grants(**kwargs)
  1. See ListAccessGrantsRequestTypeDef

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)
    ...
  1. See ListAccessGrantsInstancesResultTypeDef
# list_access_grants_instances method usage example with argument unpacking

kwargs: ListAccessGrantsInstancesRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_grants_instances(**kwargs)
  1. See ListAccessGrantsInstancesRequestTypeDef

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)
    ...
  1. See ListAccessGrantsLocationsResultTypeDef
# list_access_grants_locations method usage example with argument unpacking

kwargs: ListAccessGrantsLocationsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_grants_locations(**kwargs)
  1. See ListAccessGrantsLocationsRequestTypeDef

list_access_points#

This operation is not supported by directory buckets.

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)
    ...
  1. See ListAccessPointsResultTypeDef
# list_access_points method usage example with argument unpacking

kwargs: ListAccessPointsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_points(**kwargs)
  1. See ListAccessPointsRequestTypeDef

list_access_points_for_directory_buckets#

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

Type annotations and code completion for boto3.client("s3control").list_access_points_for_directory_buckets method. boto3 documentation

# list_access_points_for_directory_buckets method definition

def list_access_points_for_directory_buckets(
    self,
    *,
    AccountId: str,
    DirectoryBucket: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccessPointsForDirectoryBucketsResultTypeDef:  # (1)
    ...
  1. See ListAccessPointsForDirectoryBucketsResultTypeDef
# list_access_points_for_directory_buckets method usage example with argument unpacking

kwargs: ListAccessPointsForDirectoryBucketsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_points_for_directory_buckets(**kwargs)
  1. See ListAccessPointsForDirectoryBucketsRequestTypeDef

list_access_points_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See ListAccessPointsForObjectLambdaResultTypeDef
# list_access_points_for_object_lambda method usage example with argument unpacking

kwargs: ListAccessPointsForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_access_points_for_object_lambda(**kwargs)
  1. See ListAccessPointsForObjectLambdaRequestTypeDef

list_caller_access_grants#

Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants.

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)
    ...
  1. See ListCallerAccessGrantsResultTypeDef
# list_caller_access_grants method usage example with argument unpacking

kwargs: ListCallerAccessGrantsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_caller_access_grants(**kwargs)
  1. See ListCallerAccessGrantsRequestTypeDef

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)
    ...
  1. See Sequence[JobStatusType]
  2. See ListJobsResultTypeDef
# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_jobs(**kwargs)
  1. See ListJobsRequestTypeDef

list_multi_region_access_points#

This operation is not supported by directory buckets.

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)
    ...
  1. See ListMultiRegionAccessPointsResultTypeDef
# list_multi_region_access_points method usage example with argument unpacking

kwargs: ListMultiRegionAccessPointsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_multi_region_access_points(**kwargs)
  1. See ListMultiRegionAccessPointsRequestTypeDef

list_regional_buckets#

This operation is not supported by directory 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)
    ...
  1. See ListRegionalBucketsResultTypeDef
# list_regional_buckets method usage example with argument unpacking

kwargs: ListRegionalBucketsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_regional_buckets(**kwargs)
  1. See ListRegionalBucketsRequestTypeDef

list_storage_lens_configurations#

This operation is not supported by directory buckets.

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)
    ...
  1. See ListStorageLensConfigurationsResultTypeDef
# list_storage_lens_configurations method usage example with argument unpacking

kwargs: ListStorageLensConfigurationsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_storage_lens_configurations(**kwargs)
  1. See ListStorageLensConfigurationsRequestTypeDef

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)
    ...
  1. See ListStorageLensGroupsResultTypeDef
# list_storage_lens_groups method usage example with argument unpacking

kwargs: ListStorageLensGroupsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_storage_lens_groups(**kwargs)
  1. See ListStorageLensGroupsRequestTypeDef

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)
    ...
  1. See ListTagsForResourceResultTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

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)
    ...
  1. See PutAccessGrantsInstanceResourcePolicyResultTypeDef
# put_access_grants_instance_resource_policy method usage example with argument unpacking

kwargs: PutAccessGrantsInstanceResourcePolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Policy": ...,
}

parent.put_access_grants_instance_resource_policy(**kwargs)
  1. See PutAccessGrantsInstanceResourcePolicyRequestTypeDef

put_access_point_configuration_for_object_lambda#

This operation is not supported by directory buckets.

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: ObjectLambdaConfigurationUnionTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ObjectLambdaConfigurationUnionTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_access_point_configuration_for_object_lambda method usage example with argument unpacking

kwargs: PutAccessPointConfigurationForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Configuration": ...,
}

parent.put_access_point_configuration_for_object_lambda(**kwargs)
  1. See PutAccessPointConfigurationForObjectLambdaRequestTypeDef

put_access_point_policy#

Associates an access policy with the specified access point.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_access_point_policy method usage example with argument unpacking

kwargs: PutAccessPointPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Policy": ...,
}

parent.put_access_point_policy(**kwargs)
  1. See PutAccessPointPolicyRequestTypeDef

put_access_point_policy_for_object_lambda#

This operation is not supported by directory buckets.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_access_point_policy_for_object_lambda method usage example with argument unpacking

kwargs: PutAccessPointPolicyForObjectLambdaRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Policy": ...,
}

parent.put_access_point_policy_for_object_lambda(**kwargs)
  1. See PutAccessPointPolicyForObjectLambdaRequestTypeDef

put_access_point_scope#

Creates or replaces the access point scope for a directory bucket.

Type annotations and code completion for boto3.client("s3control").put_access_point_scope method. boto3 documentation

# put_access_point_scope method definition

def put_access_point_scope(
    self,
    *,
    AccountId: str,
    Name: str,
    Scope: ScopeUnionTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ScopeUnionTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_access_point_scope method usage example with argument unpacking

kwargs: PutAccessPointScopeRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
    "Scope": ...,
}

parent.put_access_point_scope(**kwargs)
  1. See PutAccessPointScopeRequestTypeDef

put_bucket_lifecycle_configuration#

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket.

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)
    ...
  1. See LifecycleConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_bucket_lifecycle_configuration method usage example with argument unpacking

kwargs: PutBucketLifecycleConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
}

parent.put_bucket_lifecycle_configuration(**kwargs)
  1. See PutBucketLifecycleConfigurationRequestTypeDef

put_bucket_policy#

This action puts a bucket policy to an Amazon S3 on Outposts bucket.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_bucket_policy method usage example with argument unpacking

kwargs: PutBucketPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
    "Policy": ...,
}

parent.put_bucket_policy(**kwargs)
  1. See PutBucketPolicyRequestTypeDef

put_bucket_replication#

This action creates an Amazon S3 on Outposts bucket's replication configuration.

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: ReplicationConfigurationUnionTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ReplicationConfigurationUnionTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_bucket_replication method usage example with argument unpacking

kwargs: PutBucketReplicationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
    "ReplicationConfiguration": ...,
}

parent.put_bucket_replication(**kwargs)
  1. See PutBucketReplicationRequestTypeDef

put_bucket_tagging#

This action puts tags on an Amazon S3 on Outposts bucket.

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)
    ...
  1. See TaggingTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_bucket_tagging method usage example with argument unpacking

kwargs: PutBucketTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
    "Tagging": ...,
}

parent.put_bucket_tagging(**kwargs)
  1. See PutBucketTaggingRequestTypeDef

put_bucket_versioning#

This operation sets the versioning state for S3 on Outposts buckets only.

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)
    ...
  1. See VersioningConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_bucket_versioning method usage example with argument unpacking

kwargs: PutBucketVersioningRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Bucket": ...,
    "VersioningConfiguration": ...,
}

parent.put_bucket_versioning(**kwargs)
  1. See PutBucketVersioningRequestTypeDef

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]:
    ...
  1. See Sequence[S3TagTypeDef]
# put_job_tagging method usage example with argument unpacking

kwargs: PutJobTaggingRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
    "Tags": ...,
}

parent.put_job_tagging(**kwargs)
  1. See PutJobTaggingRequestTypeDef

put_multi_region_access_point_policy#

This operation is not supported by directory buckets.

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)
    ...
  1. See PutMultiRegionAccessPointPolicyInputTypeDef
  2. See PutMultiRegionAccessPointPolicyResultTypeDef
# put_multi_region_access_point_policy method usage example with argument unpacking

kwargs: PutMultiRegionAccessPointPolicyRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClientToken": ...,
    "Details": ...,
}

parent.put_multi_region_access_point_policy(**kwargs)
  1. See PutMultiRegionAccessPointPolicyRequestTypeDef

put_public_access_block#

This operation is not supported by directory buckets.

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)
    ...
  1. See PublicAccessBlockConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_public_access_block method usage example with argument unpacking

kwargs: PutPublicAccessBlockRequestTypeDef = {  # (1)
    "PublicAccessBlockConfiguration": ...,
    "AccountId": ...,
}

parent.put_public_access_block(**kwargs)
  1. See PutPublicAccessBlockRequestTypeDef

put_storage_lens_configuration#

This operation is not supported by directory buckets.

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: StorageLensConfigurationUnionTypeDef,  # (1)
    Tags: Sequence[StorageLensTagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See StorageLensConfigurationUnionTypeDef
  2. See Sequence[StorageLensTagTypeDef]
  3. See EmptyResponseMetadataTypeDef
# put_storage_lens_configuration method usage example with argument unpacking

kwargs: PutStorageLensConfigurationRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
    "StorageLensConfiguration": ...,
}

parent.put_storage_lens_configuration(**kwargs)
  1. See PutStorageLensConfigurationRequestTypeDef

put_storage_lens_configuration_tagging#

This operation is not supported by directory buckets.

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]:
    ...
  1. See Sequence[StorageLensTagTypeDef]
# put_storage_lens_configuration_tagging method usage example with argument unpacking

kwargs: PutStorageLensConfigurationTaggingRequestTypeDef = {  # (1)
    "ConfigId": ...,
    "AccountId": ...,
    "Tags": ...,
}

parent.put_storage_lens_configuration_tagging(**kwargs)
  1. See PutStorageLensConfigurationTaggingRequestTypeDef

submit_multi_region_access_point_routes#

This operation is not supported by directory buckets.

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]:
    ...
  1. See Sequence[MultiRegionAccessPointRouteTypeDef]
# submit_multi_region_access_point_routes method usage example with argument unpacking

kwargs: SubmitMultiRegionAccessPointRoutesRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Mrap": ...,
    "RouteUpdates": ...,
}

parent.submit_multi_region_access_point_routes(**kwargs)
  1. See SubmitMultiRegionAccessPointRoutesRequestTypeDef

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]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

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)
    ...
  1. See UpdateAccessGrantsLocationResultTypeDef
# update_access_grants_location method usage example with argument unpacking

kwargs: UpdateAccessGrantsLocationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccessGrantsLocationId": ...,
    "IAMRoleArn": ...,
}

parent.update_access_grants_location(**kwargs)
  1. See UpdateAccessGrantsLocationRequestTypeDef

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)
    ...
  1. See UpdateJobPriorityResultTypeDef
# update_job_priority method usage example with argument unpacking

kwargs: UpdateJobPriorityRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
    "Priority": ...,
}

parent.update_job_priority(**kwargs)
  1. See UpdateJobPriorityRequestTypeDef

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)
    ...
  1. See RequestedJobStatusType
  2. See UpdateJobStatusResultTypeDef
# update_job_status method usage example with argument unpacking

kwargs: UpdateJobStatusRequestTypeDef = {  # (1)
    "AccountId": ...,
    "JobId": ...,
    "RequestedJobStatus": ...,
}

parent.update_job_status(**kwargs)
  1. See UpdateJobStatusRequestTypeDef

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: StorageLensGroupUnionTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See StorageLensGroupUnionTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_storage_lens_group method usage example with argument unpacking

kwargs: UpdateStorageLensGroupRequestTypeDef = {  # (1)
    "Name": ...,
    "AccountId": ...,
    "StorageLensGroup": ...,
}

parent.update_storage_lens_group(**kwargs)
  1. See UpdateStorageLensGroupRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("s3control").get_paginator method with overloads.