AWS API Changes

2024/11/22 - Amazon Omics - 4 new3 updated api methods

Changes This release adds support for resource policy based cross account S3 access to sequence store read sets.

UpdateSequenceStore (new)

Link ¶

Update one or more parameters for the sequence store.

Request Syntax

client.update_sequence_store(
    id='string',
    name='string',
    description='string',
    clientToken='string',
    fallbackLocation='string',
    propagatedSetLevelTags=[
        'string',
    ],
    s3AccessConfig={
        'accessLogLocation': 'string'
    }
)

type id:

string

param id:

[REQUIRED]

The ID of the sequence store.

type name:

string

param name:

A name for the sequence store.

type description:

string

param description:

A description for the sequence store.

type clientToken:

string

param clientToken:

To ensure that requests don't run multiple times, specify a unique token for each request.

This field is autopopulated if not provided.

type fallbackLocation:

string

param fallbackLocation:

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

type propagatedSetLevelTags:

list

param propagatedSetLevelTags:

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

(string) --

type s3AccessConfig:

dict

param s3AccessConfig:

S3 access configuration parameters.

accessLogLocation (string) --

Location of the access logs.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'propagatedSetLevelTags': [
        'string',
    ],
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
    'statusMessage': 'string',
    'fallbackLocation': 'string',
    's3Access': {
        's3Uri': 'string',
        's3AccessPointArn': 'string',
        'accessLogLocation': 'string'
    },
    'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up'
}

Response Structure

(dict) --
- id (string) --
  
  The ID of the sequence store.
- arn (string) --
  
  The ARN of the sequence store.
- name (string) --
  
  The name of the sequence store.
- description (string) --
  
  Description of the sequence store.
- sseConfig (dict) --
  
  Server-side encryption (SSE) settings for a store.
  - type (string) --
    
    The encryption type.
  - keyArn (string) --
    
    An encryption key ARN.
- creationTime (datetime) --
  
  The time when the store was created.
- updateTime (datetime) --
  
  The last-updated time of the Sequence Store.
- propagatedSetLevelTags (list) --
  
  The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
  - (string) --
- status (string) --
  
  The status of the sequence store.
- statusMessage (string) --
  
  The status message of the sequence store.
- fallbackLocation (string) --
  
  The S3 URI of a bucket and folder to store Read Sets that fail to upload.
- s3Access (dict) --
  
  The S3 access metadata of the sequence store.
  - s3Uri (string) --
    
    The S3 URI of the sequence store.
  - s3AccessPointArn (string) --
    
    This is ARN of the access point associated with the S3 bucket storing read sets.
  - accessLogLocation (string) --
    
    Location of the access logs.
- eTagAlgorithmFamily (string) --
  
  The ETag algorithm family to use on ingested read sets.

DeleteS3AccessPolicy (new)

Link ¶

Deletes an access policy for the specified store.

See also: AWS API Documentation

Request Syntax

client.delete_s3_access_policy(
    s3AccessPointArn='string'
)

type s3AccessPointArn:

string

param s3AccessPointArn:

[REQUIRED]

The S3 access point ARN that has the access policy.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

PutS3AccessPolicy (new)

Link ¶

Adds an access policy to the specified store.

See also: AWS API Documentation

Request Syntax

client.put_s3_access_policy(
    s3AccessPointArn='string',
    s3AccessPolicy='string'
)

type s3AccessPointArn:

string

param s3AccessPointArn:

[REQUIRED]

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

type s3AccessPolicy:

string

param s3AccessPolicy:

[REQUIRED]

The resource policy that controls S3 access to the store.

rtype:

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 AWS-generated Sequence Store or Reference Store ID.
- storeType (string) --
  
  The type of store associated with the access point.

GetS3AccessPolicy (new)

Link ¶

Retrieves details about an access policy on a given store.

See also: AWS API Documentation

Request Syntax

client.get_s3_access_policy(
    s3AccessPointArn='string'
)

type s3AccessPointArn:

string

param s3AccessPointArn:

[REQUIRED]

The S3 access point ARN that has the access policy.

rtype:

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 AWS-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.

CreateSequenceStore (updated)

Link ¶
Changes (request, response)
Request

{'propagatedSetLevelTags': ['string'],
 's3AccessConfig': {'accessLogLocation': 'string'}}

Response

{'propagatedSetLevelTags': ['string'],
 's3Access': {'accessLogLocation': 'string',
              's3AccessPointArn': 'string',
              's3Uri': 'string'},
 'status': 'CREATING | ACTIVE | UPDATING | DELETING | FAILED',
 'statusMessage': 'string'}

Creates a sequence store.

See also: AWS API Documentation

Request Syntax

client.create_sequence_store(
    name='string',
    description='string',
    sseConfig={
        'type': 'KMS',
        'keyArn': 'string'
    },
    tags={
        'string': 'string'
    },
    clientToken='string',
    fallbackLocation='string',
    eTagAlgorithmFamily='MD5up'|'SHA256up'|'SHA512up',
    propagatedSetLevelTags=[
        'string',
    ],
    s3AccessConfig={
        'accessLogLocation': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

A name for the store.

type description:

string

param description:

A description for the store.

type sseConfig:

dict

param sseConfig:

Server-side encryption (SSE) settings for the store.

type (string) -- [REQUIRED]

The encryption type.
keyArn (string) --

An encryption key ARN.

type tags:

dict

param tags:

Tags for the store.

(string) --
- (string) --

type clientToken:

string

param clientToken:

To ensure that requests don't run multiple times, specify a unique token for each request.

This field is autopopulated if not provided.

type fallbackLocation:

string

param fallbackLocation:

An S3 location that is used to store files that have failed a direct upload.

type eTagAlgorithmFamily:

string

param eTagAlgorithmFamily:

The ETag algorithm family to use for ingested read sets.

type propagatedSetLevelTags:

list

param propagatedSetLevelTags:

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

(string) --

type s3AccessConfig:

dict

param s3AccessConfig:

S3 access configuration parameters

accessLogLocation (string) --

Location of the access logs.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'fallbackLocation': 'string',
    'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
    'statusMessage': 'string',
    'propagatedSetLevelTags': [
        'string',
    ],
    's3Access': {
        's3Uri': 'string',
        's3AccessPointArn': 'string',
        'accessLogLocation': 'string'
    }
}

Response Structure

(dict) --
- id (string) --
  
  The store's ID.
- arn (string) --
  
  The store's ARN.
- name (string) --
  
  The store's name.
- description (string) --
  
  The store's description.
- sseConfig (dict) --
  
  The store's SSE settings.
  - type (string) --
    
    The encryption type.
  - keyArn (string) --
    
    An encryption key ARN.
- creationTime (datetime) --
  
  When the store was created.
- fallbackLocation (string) --
  
  An S3 location that is used to store files that have failed a direct upload.
- eTagAlgorithmFamily (string) --
  
  The algorithm family of the ETag.
- status (string) --
  
  The status of the sequence store.
- statusMessage (string) --
  
  The status message of the sequence store.
- propagatedSetLevelTags (list) --
  
  The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
  - (string) --
- s3Access (dict) --
  
  The S3 access metadata of the sequence store.
  - s3Uri (string) --
    
    The S3 URI of the sequence store.
  - s3AccessPointArn (string) --
    
    This is ARN of the access point associated with the S3 bucket storing read sets.
  - accessLogLocation (string) --
    
    Location of the access logs.

GetSequenceStore (updated)

Link ¶
Changes (response)

{'propagatedSetLevelTags': ['string'],
 's3Access': {'accessLogLocation': 'string'},
 'status': 'CREATING | ACTIVE | UPDATING | DELETING | FAILED',
 'statusMessage': 'string',
 'updateTime': 'timestamp'}

Gets information about a sequence store.

See also: AWS API Documentation

Request Syntax

client.get_sequence_store(
    id='string'
)

type id:

string

param id:

[REQUIRED]

The store's ID.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'fallbackLocation': 'string',
    's3Access': {
        's3Uri': 'string',
        's3AccessPointArn': 'string',
        'accessLogLocation': 'string'
    },
    'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
    'statusMessage': 'string',
    'propagatedSetLevelTags': [
        'string',
    ],
    'updateTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- id (string) --
  
  The store's ID.
- arn (string) --
  
  The store's ARN.
- name (string) --
  
  The store's name.
- description (string) --
  
  The store's description.
- sseConfig (dict) --
  
  The store's server-side encryption (SSE) settings.
  - type (string) --
    
    The encryption type.
  - keyArn (string) --
    
    An encryption key ARN.
- creationTime (datetime) --
  
  When the store was created.
- fallbackLocation (string) --
  
  An S3 location that is used to store files that have failed a direct upload.
- s3Access (dict) --
  
  The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.
  - s3Uri (string) --
    
    The S3 URI of the sequence store.
  - s3AccessPointArn (string) --
    
    This is ARN of the access point associated with the S3 bucket storing read sets.
  - accessLogLocation (string) --
    
    Location of the access logs.
- eTagAlgorithmFamily (string) --
  
  The algorithm family of the ETag.
- status (string) --
  
  The status of the sequence store.
- statusMessage (string) --
  
  The status message of the sequence store.
- propagatedSetLevelTags (list) --
  
  The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
  - (string) --
- updateTime (datetime) --
  
  The last-updated time of the sequence store.

ListSequenceStores (updated)

Link ¶
Changes (request, response)
Request

{'filter': {'status': 'CREATING | ACTIVE | UPDATING | DELETING | FAILED',
            'updatedAfter': 'timestamp',
            'updatedBefore': 'timestamp'}}

Response

{'sequenceStores': {'status': 'CREATING | ACTIVE | UPDATING | DELETING | '
                              'FAILED',
                    'statusMessage': 'string',
                    'updateTime': 'timestamp'}}

Retrieves a list of sequence stores.

See also: AWS API Documentation

Request Syntax

client.list_sequence_stores(
    maxResults=123,
    nextToken='string',
    filter={
        'name': 'string',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'updatedAfter': datetime(2015, 1, 1),
        'updatedBefore': datetime(2015, 1, 1)
    }
)

type maxResults:

integer

param maxResults:

The maximum number of stores to return in one page of results.

type nextToken:

string

param nextToken:

Specify the pagination token from a previous request to retrieve the next page of results.

type filter:

dict

param filter:

A filter to apply to the list.

name (string) --

A name to filter on.
createdAfter (datetime) --

The filter's start date.
createdBefore (datetime) --

The filter's end date.
status (string) --

Filter results based on status.
updatedAfter (datetime) --

Filter results based on stores updated after the specified time.
updatedBefore (datetime) --

Filter results based on stores updated before the specified time.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'sequenceStores': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'sseConfig': {
                'type': 'KMS',
                'keyArn': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'fallbackLocation': 'string',
            'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
            'statusMessage': 'string',
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A pagination token that's included if more results are available.
- sequenceStores (list) --
  
  A list of sequence stores.
  - (dict) --
    
    Details about a sequence store.
    - arn (string) --
      
      The store's ARN.
    - id (string) --
      
      The store's ID.
    - name (string) --
      
      The store's name.
    - description (string) --
      
      The store's description.
    - sseConfig (dict) --
      
      The store's server-side encryption (SSE) settings.
      - type (string) --
        
        The encryption type.
      - keyArn (string) --
        
        An encryption key ARN.
    - creationTime (datetime) --
      
      When the store was created.
    - fallbackLocation (string) --
      
      An S3 location that is used to store files that have failed a direct upload.
    - eTagAlgorithmFamily (string) --
      
      The algorithm family of the ETag.
    - status (string) --
      
      Status of the sequence store.
    - statusMessage (string) --
      
      The status message of the sequence store.
    - updateTime (datetime) --
      
      The last-updated time of the Sequence Store.