Omics / Client / get_s3_access_policy

get_s3_access_policy

Omics.Client.get_s3_access_policy(**kwargs)

Retrieves details about an access policy on a given store.

See also: AWS API Documentation

Request Syntax

response = client.get_s3_access_policy(
    s3AccessPointArn='string'
)
Parameters:

s3AccessPointArn (string) –

[REQUIRED]

The S3 access point ARN that has the access policy.

Return type:

dict

Returns:

Response Syntax

{
    's3AccessPointArn': 'string',
    'storeId': 'string',
    'storeType': 'SEQUENCE_STORE'|'REFERENCE_STORE',
    'updateTime': datetime(2015, 1, 1),
    's3AccessPolicy': 'string'
}

Response Structure

  • (dict) –

    • s3AccessPointArn (string) –

      The S3 access point ARN that 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.

    • updateTime (datetime) –

      The time when the policy was last updated.

    • s3AccessPolicy (string) –

      The current resource policy that controls S3 access on the store.

Exceptions