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

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.

Usage example

client = boto3.client("s3control")

try:
    do_something(client)
except (
    client.BadRequestException,
    client.BucketAlreadyExists,
    client.BucketAlreadyOwnedByYou,
    client.ClientError,
    client.IdempotencyException,
    client.InternalServiceException,
    client.InvalidNextTokenException,
    client.InvalidRequestException,
    client.JobStatusException,
    client.NoSuchPublicAccessBlockConfiguration,
    client.NotFoundException,
    client.TooManyRequestsException,
    client.TooManyTagsException,
) as e:
    print(e)

Type checking example

from mypy_boto3_s3control.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

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

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

Method definition

def close(
    self,
) -> None:
    ...

create_access_point

Creates an access point and associates it with the specified bucket.

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

Method definition

def create_access_point(
    self,
    *,
    AccountId: str,
    Name: str,
    Bucket: str,
    VpcConfiguration: VpcConfigurationTypeDef = ...,  # (1)
    PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef = ...,  # (2)
    BucketAccountId: str = ...,
) -> CreateAccessPointResultTypeDef:  # (3)
    ...

1. See VpcConfigurationTypeDef
2. See PublicAccessBlockConfigurationTypeDef
3. See CreateAccessPointResultTypeDef

Usage example with kwargs

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

parent.create_access_point(**kwargs)

1. See CreateAccessPointRequestRequestTypeDef

create_access_point_for_object_lambda

Creates an Object Lambda Access Point.

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

Method definition

def create_access_point_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
    Configuration: ObjectLambdaConfigurationTypeDef,  # (1)
) -> CreateAccessPointForObjectLambdaResultTypeDef:  # (2)
    ...

1. See ObjectLambdaConfigurationTypeDef
2. See CreateAccessPointForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.create_access_point_for_object_lambda(**kwargs)

1. See CreateAccessPointForObjectLambdaRequestRequestTypeDef

create_bucket

.

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

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

Usage example with kwargs

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

parent.create_bucket(**kwargs)

1. See CreateBucketRequestRequestTypeDef

create_job

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.

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

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

1. See JobOperationTypeDef
2. See JobReportTypeDef
3. See JobManifestTypeDef
4. See S3TagTypeDef
5. See JobManifestGeneratorTypeDef
6. See CreateJobResultTypeDef

Usage example with kwargs

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

parent.create_job(**kwargs)

1. See CreateJobRequestRequestTypeDef

create_multi_region_access_point

Creates a Multi-Region Access Point and associates it with the specified buckets.

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

Method definition

def create_multi_region_access_point(
    self,
    *,
    AccountId: str,
    ClientToken: str,
    Details: CreateMultiRegionAccessPointInputTypeDef,  # (1)
) -> CreateMultiRegionAccessPointResultTypeDef:  # (2)
    ...

1. See CreateMultiRegionAccessPointInputTypeDef
2. See CreateMultiRegionAccessPointResultTypeDef

Usage example with kwargs

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

parent.create_multi_region_access_point(**kwargs)

1. See CreateMultiRegionAccessPointRequestRequestTypeDef

delete_access_point

Deletes the specified access point.

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

Method definition

def delete_access_point(
    self,
    *,
    AccountId: str,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_access_point(**kwargs)

1. See DeleteAccessPointRequestRequestTypeDef

delete_access_point_for_object_lambda

Deletes the specified Object Lambda Access Point.

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

Method definition

def delete_access_point_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_access_point_for_object_lambda(**kwargs)

1. See DeleteAccessPointForObjectLambdaRequestRequestTypeDef

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

Method definition

def delete_access_point_policy(
    self,
    *,
    AccountId: str,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_access_point_policy(**kwargs)

1. See DeleteAccessPointPolicyRequestRequestTypeDef

delete_access_point_policy_for_object_lambda

Removes the resource policy for an Object Lambda Access Point.

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

Method definition

def delete_access_point_policy_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_access_point_policy_for_object_lambda(**kwargs)

1. See DeleteAccessPointPolicyForObjectLambdaRequestRequestTypeDef

delete_bucket

.

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

Method definition

def delete_bucket(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_bucket(**kwargs)

1. See DeleteBucketRequestRequestTypeDef

delete_bucket_lifecycle_configuration

.

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

Method definition

def delete_bucket_lifecycle_configuration(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_bucket_lifecycle_configuration(**kwargs)

1. See DeleteBucketLifecycleConfigurationRequestRequestTypeDef

delete_bucket_policy

.

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

Method definition

def delete_bucket_policy(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_bucket_policy(**kwargs)

1. See DeleteBucketPolicyRequestRequestTypeDef

delete_bucket_tagging

.

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

Method definition

def delete_bucket_tagging(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_bucket_tagging(**kwargs)

1. See DeleteBucketTaggingRequestRequestTypeDef

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

Method definition

def delete_job_tagging(
    self,
    *,
    AccountId: str,
    JobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_job_tagging(**kwargs)

1. See DeleteJobTaggingRequestRequestTypeDef

delete_multi_region_access_point

Deletes a Multi-Region Access Point.

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

Method definition

def delete_multi_region_access_point(
    self,
    *,
    AccountId: str,
    ClientToken: str,
    Details: DeleteMultiRegionAccessPointInputTypeDef,  # (1)
) -> DeleteMultiRegionAccessPointResultTypeDef:  # (2)
    ...

1. See DeleteMultiRegionAccessPointInputTypeDef
2. See DeleteMultiRegionAccessPointResultTypeDef

Usage example with kwargs

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

parent.delete_multi_region_access_point(**kwargs)

1. See DeleteMultiRegionAccessPointRequestRequestTypeDef

delete_public_access_block

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

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

Method definition

def delete_public_access_block(
    self,
    *,
    AccountId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_public_access_block(**kwargs)

1. See DeletePublicAccessBlockRequestRequestTypeDef

delete_storage_lens_configuration

Deletes the Amazon S3 Storage Lens configuration.

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

Method definition

def delete_storage_lens_configuration(
    self,
    *,
    ConfigId: str,
    AccountId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_storage_lens_configuration(**kwargs)

1. See DeleteStorageLensConfigurationRequestRequestTypeDef

delete_storage_lens_configuration_tagging

Deletes the Amazon S3 Storage Lens configuration tags.

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

Method definition

def delete_storage_lens_configuration_tagging(
    self,
    *,
    ConfigId: str,
    AccountId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_storage_lens_configuration_tagging(**kwargs)

1. See DeleteStorageLensConfigurationTaggingRequestRequestTypeDef

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

Method definition

def describe_job(
    self,
    *,
    AccountId: str,
    JobId: str,
) -> DescribeJobResultTypeDef:  # (1)
    ...

1. See DescribeJobResultTypeDef

Usage example with kwargs

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

parent.describe_job(**kwargs)

1. See DescribeJobRequestRequestTypeDef

describe_multi_region_access_point_operation

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.

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

Method definition

def describe_multi_region_access_point_operation(
    self,
    *,
    AccountId: str,
    RequestTokenARN: str,
) -> DescribeMultiRegionAccessPointOperationResultTypeDef:  # (1)
    ...

1. See DescribeMultiRegionAccessPointOperationResultTypeDef

Usage example with kwargs

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

parent.describe_multi_region_access_point_operation(**kwargs)

1. See DescribeMultiRegionAccessPointOperationRequestRequestTypeDef

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_access_point

Returns configuration information about the specified access point.

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

Method definition

def get_access_point(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointResultTypeDef:  # (1)
    ...

1. See GetAccessPointResultTypeDef

Usage example with kwargs

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

parent.get_access_point(**kwargs)

1. See GetAccessPointRequestRequestTypeDef

get_access_point_configuration_for_object_lambda

Returns configuration for an Object Lambda Access Point.

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

Method definition

def get_access_point_configuration_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointConfigurationForObjectLambdaResultTypeDef:  # (1)
    ...

1. See GetAccessPointConfigurationForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.get_access_point_configuration_for_object_lambda(**kwargs)

1. See GetAccessPointConfigurationForObjectLambdaRequestRequestTypeDef

get_access_point_for_object_lambda

Returns configuration information about the specified Object Lambda Access Point The following actions are related to GetAccessPointForObjectLambda * CreateAccessPointForObjectLambda <https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.htm....

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

Method definition

def get_access_point_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointForObjectLambdaResultTypeDef:  # (1)
    ...

1. See GetAccessPointForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.get_access_point_for_object_lambda(**kwargs)

1. See GetAccessPointForObjectLambdaRequestRequestTypeDef

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

Method definition

def get_access_point_policy(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointPolicyResultTypeDef:  # (1)
    ...

1. See GetAccessPointPolicyResultTypeDef

Usage example with kwargs

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

parent.get_access_point_policy(**kwargs)

1. See GetAccessPointPolicyRequestRequestTypeDef

get_access_point_policy_for_object_lambda

Returns the resource policy for an Object Lambda Access Point.

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

Method definition

def get_access_point_policy_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointPolicyForObjectLambdaResultTypeDef:  # (1)
    ...

1. See GetAccessPointPolicyForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.get_access_point_policy_for_object_lambda(**kwargs)

1. See GetAccessPointPolicyForObjectLambdaRequestRequestTypeDef

get_access_point_policy_status

Indicates whether the specified access point currently has a policy that allows public access.

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

Method definition

def get_access_point_policy_status(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointPolicyStatusResultTypeDef:  # (1)
    ...

1. See GetAccessPointPolicyStatusResultTypeDef

Usage example with kwargs

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

parent.get_access_point_policy_status(**kwargs)

1. See GetAccessPointPolicyStatusRequestRequestTypeDef

get_access_point_policy_status_for_object_lambda

Returns the status of the resource policy associated with an Object Lambda Access Point.

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

Method definition

def get_access_point_policy_status_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetAccessPointPolicyStatusForObjectLambdaResultTypeDef:  # (1)
    ...

1. See GetAccessPointPolicyStatusForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.get_access_point_policy_status_for_object_lambda(**kwargs)

1. See GetAccessPointPolicyStatusForObjectLambdaRequestRequestTypeDef

get_bucket

Gets an Amazon S3 on Outposts bucket.

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

Method definition

def get_bucket(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> GetBucketResultTypeDef:  # (1)
    ...

1. See GetBucketResultTypeDef

Usage example with kwargs

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

parent.get_bucket(**kwargs)

1. See GetBucketRequestRequestTypeDef

get_bucket_lifecycle_configuration

.

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

Method definition

def get_bucket_lifecycle_configuration(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> GetBucketLifecycleConfigurationResultTypeDef:  # (1)
    ...

1. See GetBucketLifecycleConfigurationResultTypeDef

Usage example with kwargs

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

parent.get_bucket_lifecycle_configuration(**kwargs)

1. See GetBucketLifecycleConfigurationRequestRequestTypeDef

get_bucket_policy

.

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

Method definition

def get_bucket_policy(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> GetBucketPolicyResultTypeDef:  # (1)
    ...

1. See GetBucketPolicyResultTypeDef

Usage example with kwargs

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

parent.get_bucket_policy(**kwargs)

1. See GetBucketPolicyRequestRequestTypeDef

get_bucket_tagging

.

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

Method definition

def get_bucket_tagging(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> GetBucketTaggingResultTypeDef:  # (1)
    ...

1. See GetBucketTaggingResultTypeDef

Usage example with kwargs

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

parent.get_bucket_tagging(**kwargs)

1. See GetBucketTaggingRequestRequestTypeDef

get_bucket_versioning

.

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

Method definition

def get_bucket_versioning(
    self,
    *,
    AccountId: str,
    Bucket: str,
) -> GetBucketVersioningResultTypeDef:  # (1)
    ...

1. See GetBucketVersioningResultTypeDef

Usage example with kwargs

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

parent.get_bucket_versioning(**kwargs)

1. See GetBucketVersioningRequestRequestTypeDef

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

Method definition

def get_job_tagging(
    self,
    *,
    AccountId: str,
    JobId: str,
) -> GetJobTaggingResultTypeDef:  # (1)
    ...

1. See GetJobTaggingResultTypeDef

Usage example with kwargs

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

parent.get_job_tagging(**kwargs)

1. See GetJobTaggingRequestRequestTypeDef

get_multi_region_access_point

Returns configuration information about the specified Multi-Region Access Point.

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

Method definition

def get_multi_region_access_point(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetMultiRegionAccessPointResultTypeDef:  # (1)
    ...

1. See GetMultiRegionAccessPointResultTypeDef

Usage example with kwargs

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

parent.get_multi_region_access_point(**kwargs)

1. See GetMultiRegionAccessPointRequestRequestTypeDef

get_multi_region_access_point_policy

Returns the access control policy of the specified Multi-Region Access Point.

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

Method definition

def get_multi_region_access_point_policy(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetMultiRegionAccessPointPolicyResultTypeDef:  # (1)
    ...

1. See GetMultiRegionAccessPointPolicyResultTypeDef

Usage example with kwargs

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

parent.get_multi_region_access_point_policy(**kwargs)

1. See GetMultiRegionAccessPointPolicyRequestRequestTypeDef

get_multi_region_access_point_policy_status

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

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

Method definition

def get_multi_region_access_point_policy_status(
    self,
    *,
    AccountId: str,
    Name: str,
) -> GetMultiRegionAccessPointPolicyStatusResultTypeDef:  # (1)
    ...

1. See GetMultiRegionAccessPointPolicyStatusResultTypeDef

Usage example with kwargs

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

parent.get_multi_region_access_point_policy_status(**kwargs)

1. See GetMultiRegionAccessPointPolicyStatusRequestRequestTypeDef

get_multi_region_access_point_routes

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

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

Method definition

def get_multi_region_access_point_routes(
    self,
    *,
    AccountId: str,
    Mrap: str,
) -> GetMultiRegionAccessPointRoutesResultTypeDef:  # (1)
    ...

1. See GetMultiRegionAccessPointRoutesResultTypeDef

Usage example with kwargs

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

parent.get_multi_region_access_point_routes(**kwargs)

1. See GetMultiRegionAccessPointRoutesRequestRequestTypeDef

get_public_access_block

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

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

Method definition

def get_public_access_block(
    self,
    *,
    AccountId: str,
) -> GetPublicAccessBlockOutputTypeDef:  # (1)
    ...

1. See GetPublicAccessBlockOutputTypeDef

Usage example with kwargs

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

parent.get_public_access_block(**kwargs)

1. See GetPublicAccessBlockRequestRequestTypeDef

get_storage_lens_configuration

Gets the Amazon S3 Storage Lens configuration.

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

Method definition

def get_storage_lens_configuration(
    self,
    *,
    ConfigId: str,
    AccountId: str,
) -> GetStorageLensConfigurationResultTypeDef:  # (1)
    ...

1. See GetStorageLensConfigurationResultTypeDef

Usage example with kwargs

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

parent.get_storage_lens_configuration(**kwargs)

1. See GetStorageLensConfigurationRequestRequestTypeDef

get_storage_lens_configuration_tagging

Gets the tags of Amazon S3 Storage Lens configuration.

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

Method definition

def get_storage_lens_configuration_tagging(
    self,
    *,
    ConfigId: str,
    AccountId: str,
) -> GetStorageLensConfigurationTaggingResultTypeDef:  # (1)
    ...

1. See GetStorageLensConfigurationTaggingResultTypeDef

Usage example with kwargs

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

parent.get_storage_lens_configuration_tagging(**kwargs)

1. See GetStorageLensConfigurationTaggingRequestRequestTypeDef

list_access_points

Returns a list of the access points owned by the current account associated with the specified bucket.

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

Method definition

def list_access_points(
    self,
    *,
    AccountId: str,
    Bucket: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccessPointsResultTypeDef:  # (1)
    ...

1. See ListAccessPointsResultTypeDef

Usage example with kwargs

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

parent.list_access_points(**kwargs)

1. See ListAccessPointsRequestRequestTypeDef

list_access_points_for_object_lambda

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.

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

Method definition

def list_access_points_for_object_lambda(
    self,
    *,
    AccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccessPointsForObjectLambdaResultTypeDef:  # (1)
    ...

1. See ListAccessPointsForObjectLambdaResultTypeDef

Usage example with kwargs

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

parent.list_access_points_for_object_lambda(**kwargs)

1. See ListAccessPointsForObjectLambdaRequestRequestTypeDef

list_jobs

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.

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

Method definition

def list_jobs(
    self,
    *,
    AccountId: str,
    JobStatuses: Sequence[JobStatusType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListJobsResultTypeDef:  # (2)
    ...

1. See JobStatusType
2. See ListJobsResultTypeDef

Usage example with kwargs

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

parent.list_jobs(**kwargs)

1. See ListJobsRequestRequestTypeDef

list_multi_region_access_points

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.

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

Method definition

def list_multi_region_access_points(
    self,
    *,
    AccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMultiRegionAccessPointsResultTypeDef:  # (1)
    ...

1. See ListMultiRegionAccessPointsResultTypeDef

Usage example with kwargs

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

parent.list_multi_region_access_points(**kwargs)

1. See ListMultiRegionAccessPointsRequestRequestTypeDef

list_regional_buckets

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.

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

Method definition

def list_regional_buckets(
    self,
    *,
    AccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    OutpostId: str = ...,
) -> ListRegionalBucketsResultTypeDef:  # (1)
    ...

1. See ListRegionalBucketsResultTypeDef

Usage example with kwargs

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

parent.list_regional_buckets(**kwargs)

1. See ListRegionalBucketsRequestRequestTypeDef

list_storage_lens_configurations

Gets a list of Amazon S3 Storage Lens configurations.

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

Method definition

def list_storage_lens_configurations(
    self,
    *,
    AccountId: str,
    NextToken: str = ...,
) -> ListStorageLensConfigurationsResultTypeDef:  # (1)
    ...

1. See ListStorageLensConfigurationsResultTypeDef

Usage example with kwargs

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

parent.list_storage_lens_configurations(**kwargs)

1. See ListStorageLensConfigurationsRequestRequestTypeDef

put_access_point_configuration_for_object_lambda

Replaces configuration for an Object Lambda Access Point.

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

Method definition

def put_access_point_configuration_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
    Configuration: ObjectLambdaConfigurationTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ObjectLambdaConfigurationTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_access_point_configuration_for_object_lambda(**kwargs)

1. See PutAccessPointConfigurationForObjectLambdaRequestRequestTypeDef

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

Method definition

def put_access_point_policy(
    self,
    *,
    AccountId: str,
    Name: str,
    Policy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_access_point_policy(**kwargs)

1. See PutAccessPointPolicyRequestRequestTypeDef

put_access_point_policy_for_object_lambda

Creates or replaces resource policy for an Object Lambda Access Point.

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

Method definition

def put_access_point_policy_for_object_lambda(
    self,
    *,
    AccountId: str,
    Name: str,
    Policy: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_access_point_policy_for_object_lambda(**kwargs)

1. See PutAccessPointPolicyForObjectLambdaRequestRequestTypeDef

put_bucket_lifecycle_configuration

.

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

Method definition

def put_bucket_lifecycle_configuration(
    self,
    *,
    AccountId: str,
    Bucket: str,
    LifecycleConfiguration: LifecycleConfigurationTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See LifecycleConfigurationTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_bucket_lifecycle_configuration(**kwargs)

1. See PutBucketLifecycleConfigurationRequestRequestTypeDef

put_bucket_policy

.

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

Method definition

def put_bucket_policy(
    self,
    *,
    AccountId: str,
    Bucket: str,
    Policy: str,
    ConfirmRemoveSelfBucketAccess: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_bucket_policy(**kwargs)

1. See PutBucketPolicyRequestRequestTypeDef

put_bucket_tagging

.

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

Method definition

def put_bucket_tagging(
    self,
    *,
    AccountId: str,
    Bucket: str,
    Tagging: TaggingTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TaggingTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_bucket_tagging(**kwargs)

1. See PutBucketTaggingRequestRequestTypeDef

put_bucket_versioning

.

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

Method definition

def put_bucket_versioning(
    self,
    *,
    AccountId: str,
    Bucket: str,
    VersioningConfiguration: VersioningConfigurationTypeDef,  # (1)
    MFA: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See VersioningConfigurationTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_bucket_versioning(**kwargs)

1. See PutBucketVersioningRequestRequestTypeDef

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

Method definition

def put_job_tagging(
    self,
    *,
    AccountId: str,
    JobId: str,
    Tags: Sequence[S3TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See S3TagTypeDef

Usage example with kwargs

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

parent.put_job_tagging(**kwargs)

1. See PutJobTaggingRequestRequestTypeDef

put_multi_region_access_point_policy

Associates an access control policy with the specified Multi-Region Access Point.

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

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

Usage example with kwargs

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

parent.put_multi_region_access_point_policy(**kwargs)

1. See PutMultiRegionAccessPointPolicyRequestRequestTypeDef

put_public_access_block

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.

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

Method definition

def put_public_access_block(
    self,
    *,
    PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef,  # (1)
    AccountId: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See PublicAccessBlockConfigurationTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_public_access_block(**kwargs)

1. See PutPublicAccessBlockRequestRequestTypeDef

put_storage_lens_configuration

Puts an Amazon S3 Storage Lens configuration.

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

Method definition

def put_storage_lens_configuration(
    self,
    *,
    ConfigId: str,
    AccountId: str,
    StorageLensConfiguration: StorageLensConfigurationTypeDef,  # (1)
    Tags: Sequence[StorageLensTagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See StorageLensConfigurationTypeDef
2. See StorageLensTagTypeDef
3. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.put_storage_lens_configuration(**kwargs)

1. See PutStorageLensConfigurationRequestRequestTypeDef

put_storage_lens_configuration_tagging

Put or replace tags on an existing Amazon S3 Storage Lens configuration.

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

Method definition

def put_storage_lens_configuration_tagging(
    self,
    *,
    ConfigId: str,
    AccountId: str,
    Tags: Sequence[StorageLensTagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See StorageLensTagTypeDef

Usage example with kwargs

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

parent.put_storage_lens_configuration_tagging(**kwargs)

1. See PutStorageLensConfigurationTaggingRequestRequestTypeDef

submit_multi_region_access_point_routes

Submits an updated route configuration for a Multi-Region Access Point.

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

Method definition

def submit_multi_region_access_point_routes(
    self,
    *,
    AccountId: str,
    Mrap: str,
    RouteUpdates: Sequence[MultiRegionAccessPointRouteTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See MultiRegionAccessPointRouteTypeDef

Usage example with kwargs

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

parent.submit_multi_region_access_point_routes(**kwargs)

1. See SubmitMultiRegionAccessPointRoutesRequestRequestTypeDef

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

Method definition

def update_job_priority(
    self,
    *,
    AccountId: str,
    JobId: str,
    Priority: int,
) -> UpdateJobPriorityResultTypeDef:  # (1)
    ...

1. See UpdateJobPriorityResultTypeDef

Usage example with kwargs

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

parent.update_job_priority(**kwargs)

1. See UpdateJobPriorityRequestRequestTypeDef

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

Method definition

def update_job_status(
    self,
    *,
    AccountId: str,
    JobId: str,
    RequestedJobStatus: RequestedJobStatusType,  # (1)
    StatusUpdateReason: str = ...,
) -> UpdateJobStatusResultTypeDef:  # (2)
    ...

1. See RequestedJobStatusType
2. See UpdateJobStatusResultTypeDef

Usage example with kwargs

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

parent.update_job_status(**kwargs)

1. See UpdateJobStatusRequestRequestTypeDef

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") -> ListAccessPointsForObjectLambdaPaginator