S3Control

Client

class S3Control.Client

A low-level client representing AWS S3 Control:

client = session.create_client('s3control')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_access_point(**kwargs)

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide .

Using this action with Amazon S3 on Outposts

This action:

  • Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
  • Does not support ACL on S3 on Outposts buckets.
  • Does not support Public Access on S3 on Outposts buckets.
  • Does not support object lock for S3 on Outposts buckets.

For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to CreateAccessPoint :

See also: AWS API Documentation

Request Syntax

response = client.create_access_point(
    AccountId='string',
    Name='string',
    Bucket='string',
    VpcConfiguration={
        'VpcId': 'string'
    },
    PublicAccessBlockConfiguration={
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID for the owner of the bucket for which you want to create an access point.

  • Name (string) --

    [REQUIRED]

    The name you want to assign to this access point.

  • Bucket (string) --

    [REQUIRED]

    The name of the bucket that you want to associate this access point with.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

  • VpcConfiguration (dict) --

    If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

    Note

    This is required for creating an access point for Amazon S3 on Outposts buckets.

    • VpcId (string) -- [REQUIRED]

      If this field is specified, this access point will only allow connections from the specified VPC ID.

  • PublicAccessBlockConfiguration (dict) --

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide .

    This is not supported for Amazon S3 on Outposts.

    • BlockPublicAcls (boolean) --

      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
      • PUT Object calls fail if the request includes a public ACL.
      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn't affect existing policies or ACLs.

      This is not supported for Amazon S3 on Outposts.

    • IgnorePublicAcls (boolean) --

      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      This is not supported for Amazon S3 on Outposts.

    • BlockPublicPolicy (boolean) --

      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

      Enabling this setting doesn't affect existing bucket policies.

      This is not supported for Amazon S3 on Outposts.

    • RestrictPublicBuckets (boolean) --

      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account.

      Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

      This is not supported for Amazon S3 on Outposts.

Return type

dict

Returns

Response Syntax

{
    'AccessPointArn': 'string'
}

Response Structure

  • (dict) --

    • AccessPointArn (string) --

      The ARN of the access point.

create_bucket(**kwargs)

Note

This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API .

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide .

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets .

S3 on Outposts buckets do not support

  • ACLs. Instead, configure access point policies to manage access to buckets.
  • Public access.
  • Object Lock
  • Bucket Location constraint

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

See also: AWS API Documentation

Request Syntax

response = client.create_bucket(
    ACL='private'|'public-read'|'public-read-write'|'authenticated-read',
    Bucket='string',
    CreateBucketConfiguration={
        'LocationConstraint': 'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
    },
    GrantFullControl='string',
    GrantRead='string',
    GrantReadACP='string',
    GrantWrite='string',
    GrantWriteACP='string',
    ObjectLockEnabledForBucket=True|False,
    OutpostId='string'
)
Parameters
  • ACL (string) --

    The canned ACL to apply to the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • Bucket (string) --

    [REQUIRED]

    The name of the bucket.

  • CreateBucketConfiguration (dict) --

    The configuration information for the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

    • LocationConstraint (string) --

      Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

      Note

      This is not supported by Amazon S3 on Outposts buckets.

  • GrantFullControl (string) --

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantRead (string) --

    Allows grantee to list the objects in the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantReadACP (string) --

    Allows grantee to read the bucket ACL.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantWrite (string) --

    Allows grantee to create, overwrite, and delete any object in the bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • GrantWriteACP (string) --

    Allows grantee to write the ACL for the applicable bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • ObjectLockEnabledForBucket (boolean) --

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • OutpostId (string) --

    The ID of the Outposts where the bucket is being created.

    Note

    This is required by Amazon S3 on Outposts buckets.

Return type

dict

Returns

Response Syntax

{
    'Location': 'string',
    'BucketArn': 'string'
}

Response Structure

  • (dict) --

    • Location (string) --

      The location of the bucket.

    • BucketArn (string) --

      The Amazon Resource Name (ARN) of the bucket.

      For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Exceptions

create_job(**kwargs)

S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

This operation creates a S3 Batch Operations job.

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.create_job(
    AccountId='string',
    ConfirmationRequired=True|False,
    Operation={
        'LambdaInvoke': {
            'FunctionArn': 'string'
        },
        'S3PutObjectCopy': {
            'TargetResource': 'string',
            'CannedAccessControlList': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
            'AccessControlGrants': [
                {
                    'Grantee': {
                        'TypeIdentifier': 'id'|'emailAddress'|'uri',
                        'Identifier': 'string',
                        'DisplayName': 'string'
                    },
                    'Permission': 'FULL_CONTROL'|'READ'|'WRITE'|'READ_ACP'|'WRITE_ACP'
                },
            ],
            'MetadataDirective': 'COPY'|'REPLACE',
            'ModifiedSinceConstraint': datetime(2015, 1, 1),
            'NewObjectMetadata': {
                'CacheControl': 'string',
                'ContentDisposition': 'string',
                'ContentEncoding': 'string',
                'ContentLanguage': 'string',
                'UserMetadata': {
                    'string': 'string'
                },
                'ContentLength': 123,
                'ContentMD5': 'string',
                'ContentType': 'string',
                'HttpExpiresDate': datetime(2015, 1, 1),
                'RequesterCharged': True|False,
                'SSEAlgorithm': 'AES256'|'KMS'
            },
            'NewObjectTagging': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'RedirectLocation': 'string',
            'RequesterPays': True|False,
            'StorageClass': 'STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'GLACIER'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE',
            'UnModifiedSinceConstraint': datetime(2015, 1, 1),
            'SSEAwsKmsKeyId': 'string',
            'TargetKeyPrefix': 'string',
            'ObjectLockLegalHoldStatus': 'OFF'|'ON',
            'ObjectLockMode': 'COMPLIANCE'|'GOVERNANCE',
            'ObjectLockRetainUntilDate': datetime(2015, 1, 1)
        },
        'S3PutObjectAcl': {
            'AccessControlPolicy': {
                'AccessControlList': {
                    'Owner': {
                        'ID': 'string',
                        'DisplayName': 'string'
                    },
                    'Grants': [
                        {
                            'Grantee': {
                                'TypeIdentifier': 'id'|'emailAddress'|'uri',
                                'Identifier': 'string',
                                'DisplayName': 'string'
                            },
                            'Permission': 'FULL_CONTROL'|'READ'|'WRITE'|'READ_ACP'|'WRITE_ACP'
                        },
                    ]
                },
                'CannedAccessControlList': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'
            }
        },
        'S3PutObjectTagging': {
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'S3InitiateRestoreObject': {
            'ExpirationInDays': 123,
            'GlacierJobTier': 'BULK'|'STANDARD'
        },
        'S3PutObjectLegalHold': {
            'LegalHold': {
                'Status': 'OFF'|'ON'
            }
        },
        'S3PutObjectRetention': {
            'BypassGovernanceRetention': True|False,
            'Retention': {
                'RetainUntilDate': datetime(2015, 1, 1),
                'Mode': 'COMPLIANCE'|'GOVERNANCE'
            }
        }
    },
    Report={
        'Bucket': 'string',
        'Format': 'Report_CSV_20180820',
        'Enabled': True|False,
        'Prefix': 'string',
        'ReportScope': 'AllTasks'|'FailedTasksOnly'
    },
    ClientRequestToken='string',
    Manifest={
        'Spec': {
            'Format': 'S3BatchOperations_CSV_20180820'|'S3InventoryReport_CSV_20161130',
            'Fields': [
                'Ignore'|'Bucket'|'Key'|'VersionId',
            ]
        },
        'Location': {
            'ObjectArn': 'string',
            'ObjectVersionId': 'string',
            'ETag': 'string'
        }
    },
    Description='string',
    Priority=123,
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID that creates the job.

  • ConfirmationRequired (boolean) -- Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
  • Operation (dict) --

    [REQUIRED]

    The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer Guide .

    • LambdaInvoke (dict) --

      Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

      • FunctionArn (string) --

        The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.

    • S3PutObjectCopy (dict) --

      Directs the specified job to run a PUT Copy object call on each object in the manifest.

      • TargetResource (string) --
      • CannedAccessControlList (string) --
      • AccessControlGrants (list) --
        • (dict) --
          • Grantee (dict) --
            • TypeIdentifier (string) --
            • Identifier (string) --
            • DisplayName (string) --
          • Permission (string) --
      • MetadataDirective (string) --
      • ModifiedSinceConstraint (datetime) --
      • NewObjectMetadata (dict) --
        • CacheControl (string) --
        • ContentDisposition (string) --
        • ContentEncoding (string) --
        • ContentLanguage (string) --
        • UserMetadata (dict) --
          • (string) --
            • (string) --
        • ContentLength (integer) --
        • ContentMD5 (string) --
        • ContentType (string) --
        • HttpExpiresDate (datetime) --
        • RequesterCharged (boolean) --
        • SSEAlgorithm (string) --
      • NewObjectTagging (list) --
        • (dict) --
          • Key (string) -- [REQUIRED]
          • Value (string) -- [REQUIRED]
      • RedirectLocation (string) --
      • RequesterPays (boolean) --
      • StorageClass (string) --
      • UnModifiedSinceConstraint (datetime) --
      • SSEAwsKmsKeyId (string) --
      • TargetKeyPrefix (string) --
      • ObjectLockLegalHoldStatus (string) --

        The legal hold status to be applied to all objects in the Batch Operations job.

      • ObjectLockMode (string) --

        The retention mode to be applied to all objects in the Batch Operations job.

      • ObjectLockRetainUntilDate (datetime) --

        The date when the applied object retention configuration expires on all objects in the Batch Operations job.

    • S3PutObjectAcl (dict) --

      Directs the specified job to run a PUT Object acl call on each object in the manifest.

      • AccessControlPolicy (dict) --
        • AccessControlList (dict) --
          • Owner (dict) -- [REQUIRED]
            • ID (string) --
            • DisplayName (string) --
          • Grants (list) --
            • (dict) --
              • Grantee (dict) --
                • TypeIdentifier (string) --
                • Identifier (string) --
                • DisplayName (string) --
              • Permission (string) --
        • CannedAccessControlList (string) --
    • S3PutObjectTagging (dict) --

      Directs the specified job to run a PUT Object tagging call on each object in the manifest.

      • TagSet (list) --
        • (dict) --
          • Key (string) -- [REQUIRED]
          • Value (string) -- [REQUIRED]
    • S3InitiateRestoreObject (dict) --

      Directs the specified job to run an Initiate Glacier Restore call on each object in the manifest.

      • ExpirationInDays (integer) --
      • GlacierJobTier (string) --
    • S3PutObjectLegalHold (dict) --

      Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes each object through to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

      • LegalHold (dict) -- [REQUIRED]

        Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

        • Status (string) -- [REQUIRED]

          The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

    • S3PutObjectRetention (dict) --

      Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes each value through to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

      • BypassGovernanceRetention (boolean) --

        Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

      • Retention (dict) -- [REQUIRED]

        Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

        • RetainUntilDate (datetime) --

          The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

        • Mode (string) --

          The Object Lock retention mode to be applied to all objects in the Batch Operations job.

  • Report (dict) --

    [REQUIRED]

    Configuration parameters for the optional job-completion report.

    • Bucket (string) --

      The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

    • Format (string) --

      The format of the specified job-completion report.

    • Enabled (boolean) -- [REQUIRED]

      Indicates whether the specified job will generate a job-completion report.

    • Prefix (string) --

      An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json .

    • ReportScope (string) --

      Indicates whether the job-completion report will include details of all tasks or only failed tasks.

  • ClientRequestToken (string) --

    [REQUIRED]

    An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

    This field is autopopulated if not provided.

  • Manifest (dict) --

    [REQUIRED]

    Configuration parameters for the manifest.

    • Spec (dict) -- [REQUIRED]

      Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

      • Format (string) -- [REQUIRED]

        Indicates which of the available formats the specified manifest uses.

      • Fields (list) --

        If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

        • (string) --
    • Location (dict) -- [REQUIRED]

      Contains the information required to locate the specified job's manifest.

      • ObjectArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) for a manifest object.

      • ObjectVersionId (string) --

        The optional version ID to identify a specific version of the manifest object.

      • ETag (string) -- [REQUIRED]

        The ETag for the specified manifest object.

  • Description (string) -- A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
  • Priority (integer) --

    [REQUIRED]

    The numerical priority for this job. Higher numbers indicate higher priority.

  • RoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on each object in the manifest.

  • Tags (list) --

    A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

    • (dict) --
      • Key (string) -- [REQUIRED]
      • Value (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) --

    • JobId (string) --

      The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

Exceptions

delete_access_point(**kwargs)

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the Example section below.

The following actions are related to DeleteAccessPoint :

See also: AWS API Documentation

Request Syntax

response = client.delete_access_point(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point you want to delete.

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap . The value must be URL encoded.

Returns

None

delete_access_point_policy(**kwargs)

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to DeleteAccessPointPolicy :

See also: AWS API Documentation

Request Syntax

response = client.delete_access_point_policy(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point whose policy you want to delete.

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap . The value must be URL encoded.

Returns

None

delete_bucket(**kwargs)

Note

This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API .

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

Related Resources

See also: AWS API Documentation

Request Syntax

response = client.delete_bucket(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID that owns the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    Specifies the bucket being deleted.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Returns

None

delete_bucket_lifecycle_configuration(**kwargs)

Note

This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API .

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide .

To use this operation, you must have permission to perform the s3outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

For more information about object expiration, see Elements to Describe Lifecycle Actions .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.delete_bucket_lifecycle_configuration(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID of the lifecycle configuration to delete.

  • Bucket (string) --

    [REQUIRED]

    The bucket ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Returns

None

delete_bucket_policy(**kwargs)

Note

This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API .

This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the s3outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide .

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

Warning

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see `Using Bucket Policies and User Policies < https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html>`__ .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to DeleteBucketPolicy :

See also: AWS API Documentation

Request Syntax

response = client.delete_bucket_policy(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Returns

None

delete_bucket_tagging(**kwargs)

Note

This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API .

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide .

To use this operation, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to DeleteBucketTagging :

See also: AWS API Documentation

Request Syntax

response = client.delete_bucket_tagging(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket tag set to be removed.

  • Bucket (string) --

    [REQUIRED]

    The bucket ARN that has the tag set to be removed.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Returns

None

delete_job_tagging(**kwargs)

Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.delete_job_tagging(
    AccountId='string',
    JobId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID associated with the S3 Batch Operations job.

  • JobId (string) --

    [REQUIRED]

    The ID for the S3 Batch Operations job whose tags you want to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_public_access_block(**kwargs)

Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.delete_public_access_block(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The account ID for the AWS account whose PublicAccessBlock configuration you want to remove.

Returns
None
describe_job(**kwargs)

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.describe_job(
    AccountId='string',
    JobId='string'
)
Parameters
  • AccountId (string) -- [REQUIRED]
  • JobId (string) --

    [REQUIRED]

    The ID for the job whose information you want to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Job': {
        'JobId': 'string',
        'ConfirmationRequired': True|False,
        'Description': 'string',
        'JobArn': 'string',
        'Status': 'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
        'Manifest': {
            'Spec': {
                'Format': 'S3BatchOperations_CSV_20180820'|'S3InventoryReport_CSV_20161130',
                'Fields': [
                    'Ignore'|'Bucket'|'Key'|'VersionId',
                ]
            },
            'Location': {
                'ObjectArn': 'string',
                'ObjectVersionId': 'string',
                'ETag': 'string'
            }
        },
        'Operation': {
            'LambdaInvoke': {
                'FunctionArn': 'string'
            },
            'S3PutObjectCopy': {
                'TargetResource': 'string',
                'CannedAccessControlList': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control',
                'AccessControlGrants': [
                    {
                        'Grantee': {
                            'TypeIdentifier': 'id'|'emailAddress'|'uri',
                            'Identifier': 'string',
                            'DisplayName': 'string'
                        },
                        'Permission': 'FULL_CONTROL'|'READ'|'WRITE'|'READ_ACP'|'WRITE_ACP'
                    },
                ],
                'MetadataDirective': 'COPY'|'REPLACE',
                'ModifiedSinceConstraint': datetime(2015, 1, 1),
                'NewObjectMetadata': {
                    'CacheControl': 'string',
                    'ContentDisposition': 'string',
                    'ContentEncoding': 'string',
                    'ContentLanguage': 'string',
                    'UserMetadata': {
                        'string': 'string'
                    },
                    'ContentLength': 123,
                    'ContentMD5': 'string',
                    'ContentType': 'string',
                    'HttpExpiresDate': datetime(2015, 1, 1),
                    'RequesterCharged': True|False,
                    'SSEAlgorithm': 'AES256'|'KMS'
                },
                'NewObjectTagging': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'RedirectLocation': 'string',
                'RequesterPays': True|False,
                'StorageClass': 'STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'GLACIER'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE',
                'UnModifiedSinceConstraint': datetime(2015, 1, 1),
                'SSEAwsKmsKeyId': 'string',
                'TargetKeyPrefix': 'string',
                'ObjectLockLegalHoldStatus': 'OFF'|'ON',
                'ObjectLockMode': 'COMPLIANCE'|'GOVERNANCE',
                'ObjectLockRetainUntilDate': datetime(2015, 1, 1)
            },
            'S3PutObjectAcl': {
                'AccessControlPolicy': {
                    'AccessControlList': {
                        'Owner': {
                            'ID': 'string',
                            'DisplayName': 'string'
                        },
                        'Grants': [
                            {
                                'Grantee': {
                                    'TypeIdentifier': 'id'|'emailAddress'|'uri',
                                    'Identifier': 'string',
                                    'DisplayName': 'string'
                                },
                                'Permission': 'FULL_CONTROL'|'READ'|'WRITE'|'READ_ACP'|'WRITE_ACP'
                            },
                        ]
                    },
                    'CannedAccessControlList': 'private'|'public-read'|'public-read-write'|'aws-exec-read'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'
                }
            },
            'S3PutObjectTagging': {
                'TagSet': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'S3InitiateRestoreObject': {
                'ExpirationInDays': 123,
                'GlacierJobTier': 'BULK'|'STANDARD'
            },
            'S3PutObjectLegalHold': {
                'LegalHold': {
                    'Status': 'OFF'|'ON'
                }
            },
            'S3PutObjectRetention': {
                'BypassGovernanceRetention': True|False,
                'Retention': {
                    'RetainUntilDate': datetime(2015, 1, 1),
                    'Mode': 'COMPLIANCE'|'GOVERNANCE'
                }
            }
        },
        'Priority': 123,
        'ProgressSummary': {
            'TotalNumberOfTasks': 123,
            'NumberOfTasksSucceeded': 123,
            'NumberOfTasksFailed': 123
        },
        'StatusUpdateReason': 'string',
        'FailureReasons': [
            {
                'FailureCode': 'string',
                'FailureReason': 'string'
            },
        ],
        'Report': {
            'Bucket': 'string',
            'Format': 'Report_CSV_20180820',
            'Enabled': True|False,
            'Prefix': 'string',
            'ReportScope': 'AllTasks'|'FailedTasksOnly'
        },
        'CreationTime': datetime(2015, 1, 1),
        'TerminationDate': datetime(2015, 1, 1),
        'RoleArn': 'string',
        'SuspendedDate': datetime(2015, 1, 1),
        'SuspendedCause': 'string'
    }
}

Response Structure

  • (dict) --

    • Job (dict) --

      Contains the configuration parameters and status for the job specified in the Describe Job request.

      • JobId (string) --

        The ID for the specified job.

      • ConfirmationRequired (boolean) --

        Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

      • Description (string) --

        The description for this job, if one was provided in this job's Create Job request.

      • JobArn (string) --

        The Amazon Resource Name (ARN) for this job.

      • Status (string) --

        The current status of the specified job.

      • Manifest (dict) --

        The configuration information for the specified job's manifest object.

        • Spec (dict) --

          Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

          • Format (string) --

            Indicates which of the available formats the specified manifest uses.

          • Fields (list) --

            If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

            • (string) --
        • Location (dict) --

          Contains the information required to locate the specified job's manifest.

          • ObjectArn (string) --

            The Amazon Resource Name (ARN) for a manifest object.

          • ObjectVersionId (string) --

            The optional version ID to identify a specific version of the manifest object.

          • ETag (string) --

            The ETag for the specified manifest object.

      • Operation (dict) --

        The operation that the specified job is configured to run on the objects listed in the manifest.

        • LambdaInvoke (dict) --

          Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

          • FunctionArn (string) --

            The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.

        • S3PutObjectCopy (dict) --

          Directs the specified job to run a PUT Copy object call on each object in the manifest.

          • TargetResource (string) --

          • CannedAccessControlList (string) --

          • AccessControlGrants (list) --

            • (dict) --
              • Grantee (dict) --
                • TypeIdentifier (string) --
                • Identifier (string) --
                • DisplayName (string) --
              • Permission (string) --
          • MetadataDirective (string) --

          • ModifiedSinceConstraint (datetime) --

          • NewObjectMetadata (dict) --

            • CacheControl (string) --
            • ContentDisposition (string) --
            • ContentEncoding (string) --
            • ContentLanguage (string) --
            • UserMetadata (dict) --
              • (string) --
                • (string) --
            • ContentLength (integer) --
            • ContentMD5 (string) --
            • ContentType (string) --
            • HttpExpiresDate (datetime) --
            • RequesterCharged (boolean) --
            • SSEAlgorithm (string) --
          • NewObjectTagging (list) --

            • (dict) --
              • Key (string) --
              • Value (string) --
          • RedirectLocation (string) --

          • RequesterPays (boolean) --

          • StorageClass (string) --

          • UnModifiedSinceConstraint (datetime) --

          • SSEAwsKmsKeyId (string) --

          • TargetKeyPrefix (string) --

          • ObjectLockLegalHoldStatus (string) --

            The legal hold status to be applied to all objects in the Batch Operations job.

          • ObjectLockMode (string) --

            The retention mode to be applied to all objects in the Batch Operations job.

          • ObjectLockRetainUntilDate (datetime) --

            The date when the applied object retention configuration expires on all objects in the Batch Operations job.

        • S3PutObjectAcl (dict) --

          Directs the specified job to run a PUT Object acl call on each object in the manifest.

          • AccessControlPolicy (dict) --
            • AccessControlList (dict) --
              • Owner (dict) --
                • ID (string) --
                • DisplayName (string) --
              • Grants (list) --
                • (dict) --
                  • Grantee (dict) --
                    • TypeIdentifier (string) --
                    • Identifier (string) --
                    • DisplayName (string) --
                  • Permission (string) --
            • CannedAccessControlList (string) --
        • S3PutObjectTagging (dict) --

          Directs the specified job to run a PUT Object tagging call on each object in the manifest.

          • TagSet (list) --
            • (dict) --
              • Key (string) --
              • Value (string) --
        • S3InitiateRestoreObject (dict) --

          Directs the specified job to run an Initiate Glacier Restore call on each object in the manifest.

          • ExpirationInDays (integer) --
          • GlacierJobTier (string) --
        • S3PutObjectLegalHold (dict) --

          Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes each object through to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

          • LegalHold (dict) --

            Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

            • Status (string) --

              The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

        • S3PutObjectRetention (dict) --

          Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes each value through to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

          • BypassGovernanceRetention (boolean) --

            Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

          • Retention (dict) --

            Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

            • RetainUntilDate (datetime) --

              The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

            • Mode (string) --

              The Object Lock retention mode to be applied to all objects in the Batch Operations job.

      • Priority (integer) --

        The priority of the specified job.

      • ProgressSummary (dict) --

        Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

        • TotalNumberOfTasks (integer) --
        • NumberOfTasksSucceeded (integer) --
        • NumberOfTasksFailed (integer) --
      • StatusUpdateReason (string) --

        The reason for updating the job.

      • FailureReasons (list) --

        If the specified job failed, this field contains information describing the failure.

        • (dict) --

          If this job failed, this element indicates why the job failed.

          • FailureCode (string) --

            The failure code, if any, for the specified job.

          • FailureReason (string) --

            The failure reason, if any, for the specified job.

      • Report (dict) --

        Contains the configuration information for the job-completion report if you requested one in the Create Job request.

        • Bucket (string) --

          The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

        • Format (string) --

          The format of the specified job-completion report.

        • Enabled (boolean) --

          Indicates whether the specified job will generate a job-completion report.

        • Prefix (string) --

          An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json .

        • ReportScope (string) --

          Indicates whether the job-completion report will include details of all tasks or only failed tasks.

      • CreationTime (datetime) --

        A timestamp indicating when this job was created.

      • TerminationDate (datetime) --

        A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

      • SuspendedDate (datetime) --

        The timestamp when this job was suspended, if it has been suspended.

      • SuspendedCause (string) --

        The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_access_point(**kwargs)

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to GetAccessPoint :

See also: AWS API Documentation

Request Syntax

response = client.get_access_point(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point whose configuration information you want to retrieve.

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'Bucket': 'string',
    'NetworkOrigin': 'Internet'|'VPC',
    'VpcConfiguration': {
        'VpcId': 'string'
    },
    'PublicAccessBlockConfiguration': {
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    },
    'CreationDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the specified access point.

    • Bucket (string) --

      The name of the bucket associated with the specified access point.

    • NetworkOrigin (string) --

      Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet , and the access point allows access from the public internet, subject to the access point and bucket access policies.

      This will always be true for an Amazon S3 on Outposts access point

    • VpcConfiguration (dict) --

      Contains the virtual private cloud (VPC) configuration for the specified access point.

      • VpcId (string) --

        If this field is specified, this access point will only allow connections from the specified VPC ID.

    • PublicAccessBlockConfiguration (dict) --

      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide .

      This is not supported for Amazon S3 on Outposts.

      • BlockPublicAcls (boolean) --

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
        • PUT Object calls fail if the request includes a public ACL.
        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls (boolean) --

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy (boolean) --

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn't affect existing bucket policies.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets (boolean) --

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account.

        Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

        This is not supported for Amazon S3 on Outposts.

    • CreationDate (datetime) --

      The date and time when the specified access point was created.

get_access_point_policy(**kwargs)

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

The following actions are related to GetAccessPointPolicy :

See also: AWS API Documentation

Request Syntax

response = client.get_access_point_policy(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point whose policy you want to retrieve.

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) --

    • Policy (string) --

      The access point policy associated with the specified access point.

get_access_point_policy_status(**kwargs)

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_access_point_policy_status(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point whose policy status you want to retrieve.

Return type

dict

Returns

Response Syntax

{
    'PolicyStatus': {
        'IsPublic': True|False
    }
}

Response Structure

  • (dict) --

    • PolicyStatus (dict) --

      Indicates the current policy status of the specified access point.

      • IsPublic (boolean) --

get_bucket(**kwargs)

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

The following actions are related to GetBucket for Amazon S3 on Outposts:

See also: AWS API Documentation

Request Syntax

response = client.get_bucket(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'Bucket': 'string',
    'PublicAccessBlockEnabled': True|False,
    'CreationDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • Bucket (string) --

      The Outposts bucket requested.

    • PublicAccessBlockEnabled (boolean) --

    • CreationDate (datetime) --

      The creation date of the Outposts bucket.

get_bucket_lifecycle_configuration(**kwargs)

Note

This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API .

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon Simple Storage Service Developer Guide .

To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

GetBucketLifecycleConfiguration has the following special error:
  • Error code: NoSuchLifecycleConfiguration
    • Description: The lifecycle configuration does not exist.
    • HTTP Status Code: 404 Not Found
    • SOAP Fault Code Prefix: Client

The following actions are related to GetBucketLifecycleConfiguration :

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_lifecycle_configuration(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'Rules': [
        {
            'Expiration': {
                'Date': datetime(2015, 1, 1),
                'Days': 123,
                'ExpiredObjectDeleteMarker': True|False
            },
            'ID': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': {
                    'Key': 'string',
                    'Value': 'string'
                },
                'And': {
                    'Prefix': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                }
            },
            'Status': 'Enabled'|'Disabled',
            'Transitions': [
                {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'
                },
            ],
            'NoncurrentVersionTransitions': [
                {
                    'NoncurrentDays': 123,
                    'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'
                },
            ],
            'NoncurrentVersionExpiration': {
                'NoncurrentDays': 123
            },
            'AbortIncompleteMultipartUpload': {
                'DaysAfterInitiation': 123
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Rules (list) --

      Container for the lifecycle rule of the Outposts bucket.

      • (dict) --

        The container for the Outposts bucket lifecycle rule.

        • Expiration (dict) --

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date (datetime) --

            Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.

          • Days (integer) --

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker (boolean) --

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID (string) --

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Filter (dict) --

          The container for the filter of lifecycle rule.

          • Prefix (string) --

            Prefix identifying one or more objects to which the rule applies.

          • Tag (dict) --

            • Key (string) --
            • Value (string) --
          • And (dict) --

            The container for the AND condition for the lifecycle rule.

            • Prefix (string) --

              Prefix identifying one or more objects to which the rule applies.

            • Tags (list) --

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • (dict) --
                • Key (string) --
                • Value (string) --
        • Status (string) --

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

        • Transitions (list) --

          Specifies when an Amazon S3 object transitions to a specified storage class.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • (dict) --

            Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide .

            • Date (datetime) --

              Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

            • Days (integer) --

              Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

            • StorageClass (string) --

              The storage class to which you want the object to transition.

        • NoncurrentVersionTransitions (list) --

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • (dict) --

            The container for the noncurrent version transition.

            • NoncurrentDays (integer) --

              Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide .

            • StorageClass (string) --

              The class of storage used to store the object.

        • NoncurrentVersionExpiration (dict) --

          The noncurrent version expiration of the lifecycle rule.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • NoncurrentDays (integer) --

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide .

        • AbortIncompleteMultipartUpload (dict) --

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide .

          • DaysAfterInitiation (integer) --

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

get_bucket_policy(**kwargs)

Note

This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon Simple Storage Service API .

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

Warning

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to GetBucketPolicy :

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_policy(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) --

    • Policy (string) --

      The policy of the Outposts bucket.

get_bucket_tagging(**kwargs)

Note

This API operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API .

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

To use this operation, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:
  • Error code: NoSuchTagSetError
    • Description: There is no tag set associated with the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to GetBucketTagging :

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_tagging(
    AccountId='string',
    Bucket='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

Return type

dict

Returns

Response Syntax

{
    'TagSet': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • TagSet (list) --

      The tags set of the Outposts bucket.

      • (dict) --
        • Key (string) --
        • Value (string) --

get_job_tagging(**kwargs)

Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.get_job_tagging(
    AccountId='string',
    JobId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID associated with the S3 Batch Operations job.

  • JobId (string) --

    [REQUIRED]

    The ID for the S3 Batch Operations job whose tags you want to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Tags (list) --

      The set of tags associated with the S3 Batch Operations job.

      • (dict) --
        • Key (string) --
        • Value (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_public_access_block(**kwargs)

Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.get_public_access_block(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The account ID for the AWS account whose PublicAccessBlock configuration you want to retrieve.

Return type
dict
Returns
Response Syntax
{
    'PublicAccessBlockConfiguration': {
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    }
}

Response Structure

  • (dict) --
    • PublicAccessBlockConfiguration (dict) --

      The PublicAccessBlock configuration currently in effect for this AWS account.

      • BlockPublicAcls (boolean) --

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
        • PUT Object calls fail if the request includes a public ACL.
        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls (boolean) --

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy (boolean) --

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn't affect existing bucket policies.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets (boolean) --

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account.

        Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

        This is not supported for Amazon S3 on Outposts.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_access_points(**kwargs)

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults , whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to ListAccessPoints :

See also: AWS API Documentation

Request Syntax

response = client.list_access_points(
    AccountId='string',
    Bucket='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID for owner of the bucket whose access points you want to list.

  • Bucket (string) --

    The name of the bucket whose associated access points you want to list.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

  • NextToken (string) -- A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.
Return type

dict

Returns

Response Syntax

{
    'AccessPointList': [
        {
            'Name': 'string',
            'NetworkOrigin': 'Internet'|'VPC',
            'VpcConfiguration': {
                'VpcId': 'string'
            },
            'Bucket': 'string',
            'AccessPointArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccessPointList (list) --

      Contains identification and configuration information for one or more access points associated with the specified bucket.

      • (dict) --

        An access point used to access a bucket.

        • Name (string) --

          The name of this access point.

        • NetworkOrigin (string) --

          Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet , and the access point allows access from the public internet, subject to the access point and bucket access policies.

        • VpcConfiguration (dict) --

          The virtual private cloud (VPC) configuration for this access point, if one exists.

          • VpcId (string) --

            If this field is specified, this access point will only allow connections from the specified VPC ID.

        • Bucket (string) --

          The name of the bucket associated with this access point.

        • AccessPointArn (string) --

          The ARN for the access point.

    • NextToken (string) --

      If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

list_jobs(**kwargs)

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    AccountId='string',
    JobStatuses=[
        'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • AccountId (string) -- [REQUIRED]
  • JobStatuses (list) --

    The List Jobs request returns jobs that match the statuses listed in this element.

    • (string) --
  • NextToken (string) -- A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.
  • MaxResults (integer) -- The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Jobs': [
        {
            'JobId': 'string',
            'Description': 'string',
            'Operation': 'LambdaInvoke'|'S3PutObjectCopy'|'S3PutObjectAcl'|'S3PutObjectTagging'|'S3InitiateRestoreObject'|'S3PutObjectLegalHold'|'S3PutObjectRetention',
            'Priority': 123,
            'Status': 'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
            'CreationTime': datetime(2015, 1, 1),
            'TerminationDate': datetime(2015, 1, 1),
            'ProgressSummary': {
                'TotalNumberOfTasks': 123,
                'NumberOfTasksSucceeded': 123,
                'NumberOfTasksFailed': 123
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

    • Jobs (list) --

      The list of current jobs and jobs that have ended within the last 30 days.

      • (dict) --

        Contains the configuration and status information for a single job retrieved as part of a job list.

        • JobId (string) --

          The ID for the specified job.

        • Description (string) --

          The user-specified description that was included in the specified job's Create Job request.

        • Operation (string) --

          The operation that the specified job is configured to run on each object listed in the manifest.

        • Priority (integer) --

          The current priority for the specified job.

        • Status (string) --

          The specified job's current status.

        • CreationTime (datetime) --

          A timestamp indicating when the specified job was created.

        • TerminationDate (datetime) --

          A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

        • ProgressSummary (dict) --

          Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

          • TotalNumberOfTasks (integer) --
          • NumberOfTasksSucceeded (integer) --
          • NumberOfTasksFailed (integer) --

Exceptions

list_regional_buckets(**kwargs)

Returns a list of all Outposts buckets in an Outposts that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example section below.

See also: AWS API Documentation

Request Syntax

response = client.list_regional_buckets(
    AccountId='string',
    NextToken='string',
    MaxResults=123,
    OutpostId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • NextToken (string) --
  • MaxResults (integer) --
  • OutpostId (string) --

    The ID of the AWS Outposts.

    Note

    This is required by Amazon S3 on Outposts buckets.

Return type

dict

Returns

Response Syntax

{
    'RegionalBucketList': [
        {
            'Bucket': 'string',
            'BucketArn': 'string',
            'PublicAccessBlockEnabled': True|False,
            'CreationDate': datetime(2015, 1, 1),
            'OutpostId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RegionalBucketList (list) --

      • (dict) --

        The container for the regional bucket.

        • Bucket (string) --

        • BucketArn (string) --

          The Amazon Resource Name (ARN) for the regional bucket.

        • PublicAccessBlockEnabled (boolean) --

        • CreationDate (datetime) --

          The creation date of the regional bucket

        • OutpostId (string) --

          The AWS Outposts ID of the regional bucket.

    • NextToken (string) --

      NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken . NextToken is obfuscated and is not a real key.

put_access_point_policy(**kwargs)

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to PutAccessPointPolicy :

See also: AWS API Documentation

Request Syntax

response = client.put_access_point_policy(
    AccountId='string',
    Name='string',
    Policy='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID for owner of the bucket associated with the specified access point.

  • Name (string) --

    [REQUIRED]

    The name of the access point that you want to associate with the specified policy.

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap . The value must be URL encoded.

  • Policy (string) --

    [REQUIRED]

    The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide .

Returns

None

put_bucket_lifecycle_configuration(**kwargs)

Note

This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API .

Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to PutBucketLifecycleConfiguration :

See also: AWS API Documentation

Request Syntax

response = client.put_bucket_lifecycle_configuration(
    AccountId='string',
    Bucket='string',
    LifecycleConfiguration={
        'Rules': [
            {
                'Expiration': {
                    'Date': datetime(2015, 1, 1),
                    'Days': 123,
                    'ExpiredObjectDeleteMarker': True|False
                },
                'ID': 'string',
                'Filter': {
                    'Prefix': 'string',
                    'Tag': {
                        'Key': 'string',
                        'Value': 'string'
                    },
                    'And': {
                        'Prefix': 'string',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ]
                    }
                },
                'Status': 'Enabled'|'Disabled',
                'Transitions': [
                    {
                        'Date': datetime(2015, 1, 1),
                        'Days': 123,
                        'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'
                    },
                ],
                'NoncurrentVersionTransitions': [
                    {
                        'NoncurrentDays': 123,
                        'StorageClass': 'GLACIER'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'
                    },
                ],
                'NoncurrentVersionExpiration': {
                    'NoncurrentDays': 123
                },
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 123
                }
            },
        ]
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The name of the bucket for which to set the configuration.

  • LifecycleConfiguration (dict) --

    Container for lifecycle rules. You can add as many as 1,000 rules.

    • Rules (list) --

      A lifecycle rule for individual objects in an Outposts bucket.

      • (dict) --

        The container for the Outposts bucket lifecycle rule.

        • Expiration (dict) --

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date (datetime) --

            Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.

          • Days (integer) --

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker (boolean) --

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID (string) --

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Filter (dict) --

          The container for the filter of lifecycle rule.

          • Prefix (string) --

            Prefix identifying one or more objects to which the rule applies.

          • Tag (dict) --
            • Key (string) -- [REQUIRED]
            • Value (string) -- [REQUIRED]
          • And (dict) --

            The container for the AND condition for the lifecycle rule.

            • Prefix (string) --

              Prefix identifying one or more objects to which the rule applies.

            • Tags (list) --

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • (dict) --
                • Key (string) -- [REQUIRED]
                • Value (string) -- [REQUIRED]
        • Status (string) -- [REQUIRED]

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

        • Transitions (list) --

          Specifies when an Amazon S3 object transitions to a specified storage class.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • (dict) --

            Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide .

            • Date (datetime) --

              Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

            • Days (integer) --

              Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

            • StorageClass (string) --

              The storage class to which you want the object to transition.

        • NoncurrentVersionTransitions (list) --

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • (dict) --

            The container for the noncurrent version transition.

            • NoncurrentDays (integer) --

              Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide .

            • StorageClass (string) --

              The class of storage used to store the object.

        • NoncurrentVersionExpiration (dict) --

          The noncurrent version expiration of the lifecycle rule.

          Note

          This is not supported by Amazon S3 on Outposts buckets.

          • NoncurrentDays (integer) --

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide .

        • AbortIncompleteMultipartUpload (dict) --

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide .

          • DaysAfterInitiation (integer) --

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

Returns

None

put_bucket_policy(**kwargs)

Note

This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon Simple Storage Service API .

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

Warning

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to PutBucketPolicy :

See also: AWS API Documentation

Request Syntax

response = client.put_bucket_policy(
    AccountId='string',
    Bucket='string',
    ConfirmRemoveSelfBucketAccess=True|False,
    Policy='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The ARN of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

  • ConfirmRemoveSelfBucketAccess (boolean) --

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    Note

    This is not supported by Amazon S3 on Outposts buckets.

  • Policy (string) --

    [REQUIRED]

    The bucket policy as a JSON document.

Returns

None

put_bucket_tagging(**kwargs)

Note

This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API .

Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging .

Note

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags .

To use this operation, you must have permissions to perform the s3outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources .

PutBucketTagging has the following special errors:
  • Error code: InvalidTagError
  • Error code: MalformedXMLError
    • Description: The XML provided does not match the schema.
  • Error code: OperationAbortedError
    • Description: A conflicting conditional operation is currently in progress against this resource. Try again.
  • Error code: InternalError
    • Description: The service was unable to apply the provided tag to the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example section below.

The following actions are related to PutBucketTagging :

See also: AWS API Documentation

Request Syntax

response = client.put_bucket_tagging(
    AccountId='string',
    Bucket='string',
    Tagging={
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID of the Outposts bucket.

  • Bucket (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the bucket.

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2 , use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . The value must be URL encoded.

  • Tagging (dict) --

    [REQUIRED]

    • TagSet (list) -- [REQUIRED]

      A collection for a set of tags.

      • (dict) --
        • Key (string) -- [REQUIRED]
        • Value (string) -- [REQUIRED]
Returns

None

put_job_tagging(**kwargs)

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging , modify that tag set, and use this API action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide .

Note

  • If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing .
  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
  • A few things to consider about using tags:
    • Amazon S3 limits the maximum number of tags to 50 tags per job.
    • You can associate up to 50 tags with a job as long as they have unique tag keys.
    • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
    • The key and values are case sensitive.
    • For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .

To use this operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.put_job_tagging(
    AccountId='string',
    JobId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The AWS account ID associated with the S3 Batch Operations job.

  • JobId (string) --

    [REQUIRED]

    The ID for the S3 Batch Operations job whose tags you want to replace.

  • Tags (list) --

    [REQUIRED]

    The set of tags to associate with the S3 Batch Operations job.

    • (dict) --
      • Key (string) -- [REQUIRED]
      • Value (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

put_public_access_block(**kwargs)

Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.put_public_access_block(
    PublicAccessBlockConfiguration={
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    },
    AccountId='string'
)
Parameters
  • PublicAccessBlockConfiguration (dict) --

    [REQUIRED]

    The PublicAccessBlock configuration that you want to apply to the specified AWS account.

    • BlockPublicAcls (boolean) --

      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
      • PUT Object calls fail if the request includes a public ACL.
      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn't affect existing policies or ACLs.

      This is not supported for Amazon S3 on Outposts.

    • IgnorePublicAcls (boolean) --

      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      This is not supported for Amazon S3 on Outposts.

    • BlockPublicPolicy (boolean) --

      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

      Enabling this setting doesn't affect existing bucket policies.

      This is not supported for Amazon S3 on Outposts.

    • RestrictPublicBuckets (boolean) --

      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account.

      Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

      This is not supported for Amazon S3 on Outposts.

  • AccountId (string) --

    [REQUIRED]

    The account ID for the AWS account whose PublicAccessBlock configuration you want to set.

Returns

None

update_job_priority(**kwargs)

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.update_job_priority(
    AccountId='string',
    JobId='string',
    Priority=123
)
Parameters
  • AccountId (string) -- [REQUIRED]
  • JobId (string) --

    [REQUIRED]

    The ID for the job whose priority you want to update.

  • Priority (integer) --

    [REQUIRED]

    The priority you want to assign to this job.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string',
    'Priority': 123
}

Response Structure

  • (dict) --

    • JobId (string) --

      The ID for the job whose priority Amazon S3 updated.

    • Priority (integer) --

      The new priority assigned to the specified job.

Exceptions

update_job_status(**kwargs)

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide .

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.update_job_status(
    AccountId='string',
    JobId='string',
    RequestedJobStatus='Cancelled'|'Ready',
    StatusUpdateReason='string'
)
Parameters
  • AccountId (string) -- [REQUIRED]
  • JobId (string) --

    [REQUIRED]

    The ID of the job whose status you want to update.

  • RequestedJobStatus (string) --

    [REQUIRED]

    The status that you want to move the specified job to.

  • StatusUpdateReason (string) -- A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.
Return type

dict

Returns

Response Syntax

{
    'JobId': 'string',
    'Status': 'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
    'StatusUpdateReason': 'string'
}

Response Structure

  • (dict) --

    • JobId (string) --

      The ID for the job whose status was updated.

    • Status (string) --

      The current status for the specified job.

    • StatusUpdateReason (string) --

      The reason that the specified job's status was updated.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class S3Control.Client.exceptions.BadRequestException

Example

try:
  ...
except client.exceptions.BadRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.BucketAlreadyExists

The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the AWS Outposts in this Region. Select a different name and try again.

Example

try:
  ...
except client.exceptions.BucketAlreadyExists as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the AWS Outposts in this Region. Select a different name and try again.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.BucketAlreadyOwnedByYou

The Outposts bucket you tried to create already exists, and you own it.

Example

try:
  ...
except client.exceptions.BucketAlreadyOwnedByYou as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The Outposts bucket you tried to create already exists, and you own it.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.IdempotencyException

Example

try:
  ...
except client.exceptions.IdempotencyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.InternalServiceException

Example

try:
  ...
except client.exceptions.InternalServiceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.InvalidNextTokenException

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.InvalidRequestException

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.JobStatusException

Example

try:
  ...
except client.exceptions.JobStatusException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.NoSuchPublicAccessBlockConfiguration

Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

Example

try:
  ...
except client.exceptions.NoSuchPublicAccessBlockConfiguration as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.NotFoundException

Example

try:
  ...
except client.exceptions.NotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.TooManyRequestsException

Example

try:
  ...
except client.exceptions.TooManyRequestsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class S3Control.Client.exceptions.TooManyTagsException

Amazon S3 throws this exception if you have too many tags in your tag set.

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Amazon S3 throws this exception if you have too many tags in your tag set.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: