Omics / Client / put_s3_access_policy

put_s3_access_policy

Omics.Client.put_s3_access_policy(**kwargs)

Adds an access policy to the specified store.

See also: AWS API Documentation

Request Syntax

response = client.put_s3_access_policy(
    s3AccessPointArn='string',
    s3AccessPolicy='string'
)
Parameters:

  • s3AccessPointArn (string) –

    [REQUIRED]

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

  • s3AccessPolicy (string) –

    [REQUIRED]

    The resource policy that controls S3 access to the store.

Return type:

dict

Returns:

Response Syntax

{
    's3AccessPointArn': 'string',
    'storeId': 'string',
    'storeType': 'SEQUENCE_STORE'|'REFERENCE_STORE'
}

Response Structure

  • (dict) –

    • s3AccessPointArn (string) –

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

    • storeId (string) –

      The Amazon Web Services-generated Sequence Store or Reference Store ID.

    • storeType (string) –

      The type of store associated with the access point.

Exceptions