Omics / Client / create_sequence_store

create_sequence_store#

Omics.Client.create_sequence_store(**kwargs)#

Creates a sequence store.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    A name for the store.

  • description (string) – A description for the store.

  • sseConfig (dict) –

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

    • type (string) – [REQUIRED]

      The encryption type.

    • keyArn (string) –

      An encryption key ARN.

  • tags (dict) –

    Tags for the store.

    • (string) –

      • (string) –

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • fallbackLocation (string) – An S3 location that is used to store files that have failed a direct upload.

  • eTagAlgorithmFamily (string) – The ETag algorithm family to use for ingested read sets.

  • propagatedSetLevelTags (list) –

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

    • (string) –

  • s3AccessConfig (dict) –

    S3 access configuration parameters

    • accessLogLocation (string) –

      Location of the access logs.

Return type:

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.

Exceptions