PutS3AccessPolicy - HealthOmics API Reference

PutS3AccessPolicy

Adds an access policy to the specified store.

Request Syntax

PUT /s3accesspolicy/s3AccessPointArn HTTP/1.1 Content-type: application/json { "s3AccessPolicy": "string" }

URI Request Parameters

The request uses the following URI parameters.

s3AccessPointArn

The S3 access point ARN where you want to put the access policy.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

s3AccessPolicy

The resource policy that controls S3 access to the store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100000.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "s3AccessPointArn": "string", "storeId": "string", "storeType": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

s3AccessPointArn

The S3 access point ARN that now has the access policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*

storeId

The AWS-generated Sequence Store or Reference Store ID.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

storeType

The type of store associated with the access point.

Type: String

Valid Values: SEQUENCE_STORE | REFERENCE_STORE

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

NotSupportedOperationException

The operation is not supported by Amazon Omics, or the API does not exist.

HTTP Status Code: 405

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: