Amazon Web Services, Inc.

AWS S3 Control

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Endpoints 97

  • POSTAssociate access grants identity center/v20180820/accessgrantsinstance/identitycenterAssociate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for…
  • DELETEDissociate access grants identity center/v20180820/accessgrantsinstance/identitycenterDissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance. Permissions You must have the…
  • POSTCreate access grant/v20180820/accessgrantsinstance/grantCreates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can…
  • GETGet access grants instance/v20180820/accessgrantsinstanceRetrieves the S3 Access Grants instance for a Region in your account. Permissions You must have the s3:GetAccessGrantsInstance permission to use this…
  • POSTCreate access grants instance/v20180820/accessgrantsinstanceCreates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per…
  • DELETEDelete access grants instance/v20180820/accessgrantsinstanceDeletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See…
  • POSTCreate access grants location/v20180820/accessgrantsinstance/locationThe S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants…
  • GETGet access point/v20180820/accesspoint/:NameReturns configuration information about the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional…
  • PUTCreate access point/v20180820/accesspoint/:NameCreates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing…
  • DELETEDelete access point/v20180820/accesspoint/:NameDeletes 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…
  • GETGet access point for object lambda/v20180820/accesspointforobjectlambda/:NameThis operation is not supported by directory buckets. Returns configuration information about the specified Object Lambda Access Point The following actions…
  • PUTCreate access point for object lambda/v20180820/accesspointforobjectlambda/:NameThis operation is not supported by directory buckets. Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda…
  • DELETEDelete access point for object lambda/v20180820/accesspointforobjectlambda/:NameThis operation is not supported by directory buckets. Deletes the specified Object Lambda Access Point. The following actions are related to…
  • GETGet bucket/v20180820/bucket/:BucketGets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide . If you are using an identity other…
  • PUTCreate bucket/v20180820/bucket/:BucketThis action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference . Creates a new Outposts bucket.…
  • DELETEDelete bucket/v20180820/bucket/:BucketThis action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference . Deletes the Amazon S3 on…
  • GETList jobs/v20180820/jobs?jobStatuses=&nextToken=string&maxResults=0Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For…
  • POSTCreate job/v20180820/jobsThis operation creates an S3 Batch Operations job. You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations…
  • POSTCreate multi region access point/v20180820/async-requests/mrap/createThis operation is not supported by directory buckets. Creates a Multi-Region Access Point and associates it with the specified buckets. For more information…
  • GETList storage lens groups/v20180820/storagelensgroup?nextToken=stringLists all the Storage Lens groups in the specified home Region. To use this operation, you must have the permission to perform the s3:ListStorageLensGroups…
  • POSTCreate storage lens group/v20180820/storagelensgroupCreates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of…
  • GETGet access grant/v20180820/accessgrantsinstance/grant/:AccessGrantIdGet the details of an access grant from your S3 Access Grants instance. Permissions You must have the s3:GetAccessGrant permission to use this operation.
  • DELETEDelete access grant/v20180820/accessgrantsinstance/grant/:AccessGrantIdDeletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3…
  • GETGet access grants instance resource policy/v20180820/accessgrantsinstance/resourcepolicyReturns the resource policy of the S3 Access Grants instance. Permissions You must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this…
  • PUTPut access grants instance resource policy/v20180820/accessgrantsinstance/resourcepolicyUpdates the resource policy of the S3 Access Grants instance. Permissions You must have the s3:PutAccessGrantsInstanceResourcePolicy permission to use this…
  • DELETEDelete access grants instance resource policy/v20180820/accessgrantsinstance/resourcepolicyDeletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By…
  • GETGet access grants location/v20180820/accessgrantsinstance/location/:AccessGrantsLocationIdRetrieves the details of a particular location registered in your S3 Access Grants instance. Permissions You must have the s3:GetAccessGrantsLocation…
  • PUTUpdate access grants location/v20180820/accessgrantsinstance/location/:AccessGrantsLocationIdUpdates the IAM role of a registered location in your S3 Access Grants instance. Permissions You must have the s3:UpdateAccessGrantsLocation permission to use…
  • DELETEDelete access grants location/v20180820/accessgrantsinstance/location/:AccessGrantsLocationIdDeregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no…
  • GETGet access point policy/v20180820/accesspoint/:Name/policyReturns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy : PutAccessPointPolicy…
  • PUTPut access point policy/v20180820/accesspoint/:Name/policyAssociates 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…
  • DELETEDelete access point policy/v20180820/accesspoint/:Name/policyDeletes 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…
  • GETGet access point policy for object lambda/v20180820/accesspointforobjectlambda/:Name/policyThis operation is not supported by directory buckets. Returns the resource policy for an Object Lambda Access Point. The following actions are related to…
  • PUTPut access point policy for object lambda/v20180820/accesspointforobjectlambda/:Name/policyThis operation is not supported by directory buckets. Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see…
  • DELETEDelete access point policy for object lambda/v20180820/accesspointforobjectlambda/:Name/policyThis operation is not supported by directory buckets. Removes the resource policy for an Object Lambda Access Point. The following actions are related to…
  • GETGet access point scope/v20180820/accesspoint/:Name/scopeReturns the access point scope for a directory bucket. To use this operation, you must have the permission to perform the s3express:GetAccessPointScope…
  • PUTPut access point scope/v20180820/accesspoint/:Name/scopeCreates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations,…
  • DELETEDelete access point scope/v20180820/accesspoint/:Name/scopeDeletes an existing access point scope for a directory bucket. When you delete the scope of an access point, all prefixes and permissions are deleted. To use…
  • GETGet bucket lifecycle configuration/v20180820/bucket/:Bucket/lifecycleconfigurationThis action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration…
  • PUTPut bucket lifecycle configuration/v20180820/bucket/:Bucket/lifecycleconfigurationThis action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see…
  • DELETEDelete bucket lifecycle configuration/v20180820/bucket/:Bucket/lifecycleconfigurationThis action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in…
  • GETGet bucket policy/v20180820/bucket/:Bucket/policyThis 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 S3 API Reference .…
  • PUTPut bucket policy/v20180820/bucket/:Bucket/policyThis 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 S3 API Reference .…
  • DELETEDelete bucket policy/v20180820/bucket/:Bucket/policyThis action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference . This…
  • GETGet bucket replication/v20180820/bucket/:Bucket/replicationThis operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in…
  • PUTPut bucket replication/v20180820/bucket/:Bucket/replicationThis action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication…
  • DELETEDelete bucket replication/v20180820/bucket/:Bucket/replicationThis operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see…
  • GETGet bucket tagging/v20180820/bucket/:Bucket/taggingThis action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference . Returns the tag set…
  • PUTPut bucket tagging/v20180820/bucket/:Bucket/taggingThis action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference . Sets the tags for…
  • DELETEDelete bucket tagging/v20180820/bucket/:Bucket/taggingThis action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference . Deletes the…
  • GETGet job tagging/v20180820/jobs/:JobId/taggingReturns the tags on an S3 Batch Operations job. Permissions To use the GetJobTagging operation, you must have permission to perform the s3:GetJobTagging…
  • PUTPut job tagging/v20180820/jobs/:JobId/taggingSets 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…
  • DELETEDelete job tagging/v20180820/jobs/:JobId/taggingRemoves the entire tag set from the specified S3 Batch Operations job. Permissions To use the DeleteJobTagging operation, you must have permission to perform…
  • POSTDelete multi region access point/v20180820/async-requests/mrap/deleteThis operation is not supported by directory buckets. Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the…
  • GETGet public access block/v20180820/configuration/publicAccessBlockThis operation is not supported by directory buckets. Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. This operation returns…
  • PUTPut public access block/v20180820/configuration/publicAccessBlockThis operation is not supported by directory buckets. Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. This…
  • DELETEDelete public access block/v20180820/configuration/publicAccessBlockThis operation is not supported by directory buckets. Removes the PublicAccessBlock configuration for an Amazon Web Services account. This operation might be…
  • GETGet storage lens configuration/v20180820/storagelens/:ConfigIdThis operation is not supported by directory buckets. Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity…
  • PUTPut storage lens configuration/v20180820/storagelens/:ConfigIdThis operation is not supported by directory buckets. Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working…
  • DELETEDelete storage lens configuration/v20180820/storagelens/:ConfigIdThis operation is not supported by directory buckets. Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see…
  • GETGet storage lens configuration tagging/v20180820/storagelens/:ConfigId/taggingThis operation is not supported by directory buckets. Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see…
  • PUTPut storage lens configuration tagging/v20180820/storagelens/:ConfigId/taggingThis operation is not supported by directory buckets. Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3…
  • DELETEDelete storage lens configuration tagging/v20180820/storagelens/:ConfigId/taggingThis operation is not supported by directory buckets. Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see…
  • GETGet storage lens group/v20180820/storagelensgroup/:NameRetrieves the Storage Lens group configuration details. To use this operation, you must have the permission to perform the s3:GetStorageLensGroup action. For…
  • PUTUpdate storage lens group/v20180820/storagelensgroup/:NameUpdates the existing Storage Lens group. To use this operation, you must have the permission to perform the s3:UpdateStorageLensGroup action. For more…
  • DELETEDelete storage lens group/v20180820/storagelensgroup/:NameDeletes an existing S3 Storage Lens group. To use this operation, you must have the permission to perform the s3:DeleteStorageLensGroup action. For more…
  • GETDescribe job/v20180820/jobs/:JobIdRetrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide .…
  • GETDescribe multi region access point operation/v20180820/async-requests/mrap/:RequestTokenARNThis operation is not supported by directory buckets. Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more…
  • GETGet access grants instance for prefix/v20180820/accessgrantsinstance/prefix?s3prefix=stringRetrieve the S3 Access Grants instance that contains a particular prefix. Permissions You must have the s3:GetAccessGrantsInstanceForPrefix permission for the…
  • GETGet access point configuration for object lambda/v20180820/accesspointforobjectlambda/:Name/configurationThis operation is not supported by directory buckets. Returns configuration for an Object Lambda Access Point. The following actions are related to…
  • PUTPut access point configuration for object lambda/v20180820/accesspointforobjectlambda/:Name/configurationThis operation is not supported by directory buckets. Replaces configuration for an Object Lambda Access Point. The following actions are related to…
  • GETGet access point policy status/v20180820/accesspoint/:Name/policyStatusThis operation is not supported by directory buckets. Indicates whether the specified access point currently has a policy that allows public access. For more…
  • GETGet access point policy status for object lambda/v20180820/accesspointforobjectlambda/:Name/policyStatusThis operation is not supported by directory buckets. Returns the status of the resource policy associated with an Object Lambda Access Point.
  • GETGet bucket versioning/v20180820/bucket/:Bucket/versioningThis operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the…
  • PUTPut bucket versioning/v20180820/bucket/:Bucket/versioningThis operation sets the versioning state for S3 on Outposts buckets only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon…
  • GETGet data access/v20180820/accessgrantsinstance/dataaccess?target=string&permission=string&durationSeconds=0&privilege=string&targetType=string&auditContext=string&instanceScope=stringReturns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token…
  • GETGet multi region access point/v20180820/mrap/instances/:NameThis operation is not supported by directory buckets. Returns configuration information about the specified Multi-Region Access Point. This action will always…
  • GETGet multi region access point policy/v20180820/mrap/instances/:Name/policyThis operation is not supported by directory buckets. Returns the access control policy of the specified Multi-Region Access Point. This action will always be…
  • GETGet multi region access point policy status/v20180820/mrap/instances/:Name/policystatusThis operation is not supported by directory buckets. Indicates whether the specified Multi-Region Access Point has an access control policy that allows…
  • GETGet multi region access point routes/v20180820/mrap/instances/:Mrap/routesThis operation is not supported by directory buckets. Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active…
  • PATCHSubmit multi region access point routes/v20180820/mrap/instances/:Mrap/routesThis operation is not supported by directory buckets. Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the…
  • GETList access grants/v20180820/accessgrantsinstance/grants?nextToken=string&maxResults=0&granteetype=string&granteeidentifier=string&permission=string&grantscope=string&application_arn=stringReturns the list of access grants in your S3 Access Grants instance. Permissions You must have the s3:ListAccessGrants permission to use this operation.
  • GETList access grants instances/v20180820/accessgrantsinstances?nextToken=string&maxResults=0Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have…
  • GETList access grants locations/v20180820/accessgrantsinstance/locations?nextToken=string&maxResults=0&locationscope=stringReturns a list of the locations registered in your S3 Access Grants instance. Permissions You must have the s3:ListAccessGrantsLocations permission to use…
  • GETList access points/v20180820/accesspoint?bucket=string&nextToken=string&maxResults=0&dataSourceId=string&dataSourceType=stringThis operation is not supported by directory buckets. Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call…
  • GETList access points for directory buckets/v20180820/accesspointfordirectory?directoryBucket=string&nextToken=string&maxResults=0Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket. To list…
  • GETList access points for object lambda/v20180820/accesspointforobjectlambda?nextToken=string&maxResults=0This operation is not supported by directory buckets. Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.…
  • GETList caller access grants/v20180820/accessgrantsinstance/caller/grants?grantscope=string&nextToken=string&maxResults=0&allowedByApplication=true&instanceScope=stringUse this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and…
  • GETList multi region access points/v20180820/mrap/instances?nextToken=string&maxResults=0This operation is not supported by directory buckets. Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web…
  • GETList regional buckets/v20180820/bucket?nextToken=string&maxResults=0This operation is not supported by directory buckets. Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the…
  • GETList storage lens configurations/v20180820/storagelens?nextToken=stringThis operation is not supported by directory buckets. Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see…
  • GETList tags for resource/v20180820/tags/:ResourceArnThis operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize,…
  • POSTTag resource/v20180820/tags/:ResourceArnCreates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help…
  • DELETEUntag resource/v20180820/tags/:ResourceArn?tagKeys=This operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys. This operation is only supported for the…
  • POSTPut multi region access point policy/v20180820/async-requests/mrap/put-policyThis operation is not supported by directory buckets. Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region…
  • POSTUpdate job priority/v20180820/jobs/:JobId/priority?priority=0Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide . Permissions To use the…
  • POSTUpdate job status/v20180820/jobs/:JobId/status?requestedJobStatus=string&statusUpdateReason=stringUpdates 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…

API details

Base URL
https://s3-control.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
97 operations on 52 pathsGET 44DELETE 21PUT 19POST 12PATCH 1
Description format
AWS Smithy model, API version 2018-08-20

How to test the AWS S3 Control in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS S3 Control collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate access grants identity center” (POST /v20180820/accessgrantsinstance/identitycenter), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS S3 Control?

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions. It is listed under Developer tools and has 97 endpoints.

Who publishes the AWS S3 Control?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS S3 Control?

Requests go to https://s3-control.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS S3 Control?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS S3 Control have?

97 operations on 52 paths (44 GET, 21 DELETE, 19 PUT, 12 POST, 1 PATCH).

Is forking the AWS S3 Control free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.