GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::S3Control(3) User Contributed Perl Documentation Paws::S3Control(3)

Paws::S3Control - Perl Interface to AWS AWS S3 Control

  use Paws;
  my $obj = Paws->service('S3Control');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

AWS S3 Control provides access to Amazon S3 control plane actions.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/s3-control-2018-08-20>

[PublicAccessBlockConfiguration => Paws::S3Control::PublicAccessBlockConfiguration]
[VpcConfiguration => Paws::S3Control::VpcConfiguration]

Each argument is described in detail in: Paws::S3Control::CreateAccessPoint

Returns: a Paws::S3Control::CreateAccessPointResult instance

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) section.

The following actions are related to "CreateAccessPoint":

  • GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)
  • DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
  • ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)

Each argument is described in detail in: Paws::S3Control::CreateAccessPointForObjectLambda

Returns: a Paws::S3Control::CreateAccessPointForObjectLambdaResult instance

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) in the Amazon S3 User Guide.

The following actions are related to "CreateAccessPointForObjectLambda":

  • DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
  • GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)
  • ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)

[ACL => Str]
[CreateBucketConfiguration => Paws::S3Control::CreateBucketConfiguration]
[GrantFullControl => Str]
[GrantRead => Str]
[GrantReadACP => Str]
[GrantWrite => Str]
[GrantWriteACP => Str]
[ObjectLockEnabledForBucket => Bool]
[OutpostId => Str]

Each argument is described in detail in: Paws::S3Control::CreateBucket

Returns: a Paws::S3Control::CreateBucketResult instance

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) in the Amazon S3 API Reference.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules).

S3 on Outposts buckets support:

  • Tags
  • LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html).

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and "x-amz-outpost-id" in your API request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples) section.

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

  • PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
  • GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html)
  • DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html)
  • CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
  • PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)

[ConfirmationRequired => Bool]
[Description => Str]
[Tags => ArrayRef[Paws::S3Control::S3Tag]]

Each argument is described in detail in: Paws::S3Control::CreateJob

Returns: a Paws::S3Control::CreateJobResult instance

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

  • DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
  • ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
  • UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
  • UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
  • JobOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html)

Each argument is described in detail in: Paws::S3Control::DeleteAccessPoint

Returns: nothing

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) section.

The following actions are related to "DeleteAccessPoint":

  • CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
  • GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)
  • ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)

Each argument is described in detail in: Paws::S3Control::DeleteAccessPointForObjectLambda

Returns: nothing

Deletes the specified Object Lambda Access Point.

The following actions are related to "DeleteAccessPointForObjectLambda":

  • CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
  • GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)
  • ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::DeleteAccessPointPolicy

Returns: nothing

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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) section.

The following actions are related to "DeleteAccessPointPolicy":

  • PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)
  • GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html)

Each argument is described in detail in: Paws::S3Control::DeleteAccessPointPolicyForObjectLambda

Returns: nothing

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to "DeleteAccessPointPolicyForObjectLambda":

  • GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html)
  • PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::DeleteBucket

Returns: nothing

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) in the Amazon S3 API Reference.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) section.

Related Resources

  • CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html)
  • GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html)
  • DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)

Each argument is described in detail in: Paws::S3Control::DeleteBucketLifecycleConfiguration

Returns: nothing

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) in the Amazon S3 API Reference.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3-outposts: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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) section.

For more information about object expiration, see Elements to Describe Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).

Related actions include:

  • PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html)
  • GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html)

Each argument is described in detail in: Paws::S3Control::DeleteBucketPolicy

Returns: nothing

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html) in the Amazon S3 API Reference.

This implementation of the DELETE action 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 "s3-outposts:DeleteBucketPolicy" permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User 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.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) section.

The following actions are related to "DeleteBucketPolicy":

  • GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html)
  • PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html)

Each argument is described in detail in: Paws::S3Control::DeleteBucketTagging

Returns: nothing

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User Guide.

To use this action, 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) section.

The following actions are related to "DeleteBucketTagging":

  • GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html)
  • PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html)

Each argument is described in detail in: Paws::S3Control::DeleteJobTagging

Returns: a Paws::S3Control::DeleteJobTaggingResult instance

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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html)
  • PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html)

Each argument is described in detail in: Paws::S3Control::DeletePublicAccessBlock

Returns: nothing

Removes the "PublicAccessBlock" configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

  • GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html)
  • PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html)

Each argument is described in detail in: Paws::S3Control::DeleteStorageLensConfiguration

Returns: nothing

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:DeleteStorageLensConfiguration" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::DeleteStorageLensConfigurationTagging

Returns: a Paws::S3Control::DeleteStorageLensConfigurationTaggingResult instance

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:DeleteStorageLensConfigurationTagging" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::DescribeJob

Returns: a Paws::S3Control::DescribeJobResult instance

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
  • UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
  • UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPoint

Returns: a Paws::S3Control::GetAccessPointResult instance

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section.

The following actions are related to "GetAccessPoint":

  • CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
  • DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
  • ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPointConfigurationForObjectLambda

Returns: a Paws::S3Control::GetAccessPointConfigurationForObjectLambdaResult instance

Returns configuration for an Object Lambda Access Point.

The following actions are related to "GetAccessPointConfigurationForObjectLambda":

•
PutAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPointForObjectLambda

Returns: a Paws::S3Control::GetAccessPointForObjectLambdaResult instance

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to "GetAccessPointForObjectLambda":

  • CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
  • DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
  • ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPointPolicy

Returns: a Paws::S3Control::GetAccessPointPolicyResult instance

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

The following actions are related to "GetAccessPointPolicy":

  • PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)
  • DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPointPolicyForObjectLambda

Returns: a Paws::S3Control::GetAccessPointPolicyForObjectLambdaResult instance

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to "GetAccessPointPolicyForObjectLambda":

  • DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html)
  • PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::GetAccessPointPolicyStatus

Returns: a Paws::S3Control::GetAccessPointPolicyStatusResult instance

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::GetAccessPointPolicyStatusForObjectLambda

Returns: a Paws::S3Control::GetAccessPointPolicyStatusForObjectLambdaResult instance

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

Each argument is described in detail in: Paws::S3Control::GetBucket

Returns: a Paws::S3Control::GetBucketResult instance

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User 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 "s3-outposts:GetBucket" permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have "s3-outposts:GetBucket" permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a "403 Access Denied" error.

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

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) section.

  • PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
  • CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html)
  • DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html)

Each argument is described in detail in: Paws::S3Control::GetBucketLifecycleConfiguration

Returns: a Paws::S3Control::GetBucketLifecycleConfigurationResult instance

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) and for information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3-outposts: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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) section.

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

  • PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html)
  • DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html)

Each argument is described in detail in: Paws::S3Control::GetBucketPolicy

Returns: a Paws::S3Control::GetBucketPolicyResult instance

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html) in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User 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 action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have "s3-outposts:GetBucketPolicy" permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a "403 Access Denied" error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) section.

The following actions are related to "GetBucketPolicy":

  • GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
  • PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html)
  • DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html)

Each argument is described in detail in: Paws::S3Control::GetBucketTagging

Returns: a Paws::S3Control::GetBucketTaggingResult instance

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

To use this action, 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) section.

The following actions are related to "GetBucketTagging":

  • PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html)
  • DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html)

Each argument is described in detail in: Paws::S3Control::GetJobTagging

Returns: a Paws::S3Control::GetJobTaggingResult instance

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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html)
  • DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html)

Each argument is described in detail in: Paws::S3Control::GetPublicAccessBlock

Returns: a Paws::S3Control::GetPublicAccessBlockOutput instance

Retrieves the "PublicAccessBlock" configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

  • DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html)
  • PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html)

Each argument is described in detail in: Paws::S3Control::GetStorageLensConfiguration

Returns: a Paws::S3Control::GetStorageLensConfigurationResult instance

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:GetStorageLensConfiguration" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::GetStorageLensConfigurationTagging

Returns: a Paws::S3Control::GetStorageLensConfigurationTaggingResult instance

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:GetStorageLensConfigurationTagging" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

[Bucket => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::S3Control::ListAccessPoints

Returns: a Paws::S3Control::ListAccessPointsResult instance

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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section.

The following actions are related to "ListAccessPoints":

  • CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
  • DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
  • GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::S3Control::ListAccessPointsForObjectLambda

Returns: a Paws::S3Control::ListAccessPointsForObjectLambdaResult instance

Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000 access points per call. If there are 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.

The following actions are related to "ListAccessPointsForObjectLambda":

  • CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
  • DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
  • GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)

[JobStatuses => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::S3Control::ListJobs

Returns: a Paws::S3Control::ListJobsResult instance

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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
  • UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
  • UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)

[MaxResults => Int]
[NextToken => Str]
[OutpostId => Str]

Each argument is described in detail in: Paws::S3Control::ListRegionalBuckets

Returns: a Paws::S3Control::ListRegionalBucketsResult instance

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and "x-amz-outpost-id" in your request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) section.

[NextToken => Str]

Each argument is described in detail in: Paws::S3Control::ListStorageLensConfigurations

Returns: a Paws::S3Control::ListStorageLensConfigurationsResult instance

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:ListStorageLensConfigurations" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::PutAccessPointConfigurationForObjectLambda

Returns: nothing

Replaces configuration for an Object Lambda Access Point.

The following actions are related to "PutAccessPointConfigurationForObjectLambda":

•
GetAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html)

Each argument is described in detail in: Paws::S3Control::PutAccessPointPolicy

Returns: nothing

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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) section.

The following actions are related to "PutAccessPointPolicy":

  • GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html)
  • DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html)

Each argument is described in detail in: Paws::S3Control::PutAccessPointPolicyForObjectLambda

Returns: nothing

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli) in the Amazon S3 User Guide.

The following actions are related to "PutAccessPointPolicyForObjectLambda":

  • DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html)
  • GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html)

[LifecycleConfiguration => Paws::S3Control::LifecycleConfiguration]

Each argument is described in detail in: Paws::S3Control::PutBucketLifecycleConfiguration

Returns: nothing

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) section.

The following actions are related to "PutBucketLifecycleConfiguration":

  • GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html)
  • DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html)

[ConfirmRemoveSelfBucketAccess => Bool]

Each argument is described in detail in: Paws::S3Control::PutBucketPolicy

Returns: nothing

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html) in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User 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 action.

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.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) section.

The following actions are related to "PutBucketPolicy":

  • GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html)
  • DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html)

Each argument is described in detail in: Paws::S3Control::PutBucketTagging

Returns: nothing

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User 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 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html).

To use this action, you must have permissions to perform the "s3-outposts: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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing access permissions to your Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).

"PutBucketTagging" has the following special errors:

•
Error code: "InvalidTagError"
•
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) and AWS-Generated Cost Allocation Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html).
•
Error code: "MalformedXMLError"
•
Description: The XML provided does not match the schema.
•
Error code: "OperationAbortedError"
•
Description: A conflicting conditional action 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 "x-amz-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 "x-amz-outpost-id" derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) section.

The following actions are related to "PutBucketTagging":

  • GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html)
  • DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html)

Each argument is described in detail in: Paws::S3Control::PutJobTagging

Returns: a Paws::S3Control::PutJobTaggingResult instance

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 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html), modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon S3 User Guide.

  • 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 (http://aws.amazon.com/s3/pricing/).
  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) 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 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.

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

Related actions include:

  • CreatJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html)
  • DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html)

Each argument is described in detail in: Paws::S3Control::PutPublicAccessBlock

Returns: nothing

Creates or modifies the "PublicAccessBlock" configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

  • GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html)
  • DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html)

[Tags => ArrayRef[Paws::S3Control::StorageLensTag]]

Each argument is described in detail in: Paws::S3Control::PutStorageLensConfiguration

Returns: nothing

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:PutStorageLensConfiguration" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::PutStorageLensConfigurationTagging

Returns: a Paws::S3Control::PutStorageLensConfigurationTaggingResult instance

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide.

To use this action, you must have permission to perform the "s3:PutStorageLensConfigurationTagging" action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.

Each argument is described in detail in: Paws::S3Control::UpdateJobPriority

Returns: a Paws::S3Control::UpdateJobPriorityResult instance

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
  • DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
  • UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)

[StatusUpdateReason => Str]

Each argument is described in detail in: Paws::S3Control::UpdateJobStatus

Returns: a Paws::S3Control::UpdateJobStatusResult instance

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon S3 User Guide.

Related actions include:

  • CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
  • ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
  • DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
  • UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - ObjectLambdaAccessPointList, passing the object as the first parameter, and the string 'ObjectLambdaAccessPointList' as the second parameter

If not, it will return a a Paws::S3Control::ListAccessPointsForObjectLambdaResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.