AbortMultipartReadSetUpload

$result = $client->abortMultipartReadSetUpload([/* ... */]);
$promise = $client->abortMultipartReadSetUploadAsync([/* ... */]);

Stops a multipart upload.

Parameter Syntax

$result = $client->abortMultipartReadSetUpload([
    'sequenceStoreId' => '<string>', // REQUIRED
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

NotSupportedOperationException:

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

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

AcceptShare

$result = $client->acceptShare([/* ... */]);
$promise = $client->acceptShareAsync([/* ... */]);

Accept a resource share request.

Parameter Syntax

$result = $client->acceptShare([
    'shareId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'PENDING|ACTIVATING|ACTIVE|DELETING|DELETED|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchDeleteReadSet

$result = $client->batchDeleteReadSet([/* ... */]);
$promise = $client->batchDeleteReadSetAsync([/* ... */]);

Deletes one or more read sets.

Parameter Syntax

$result = $client->batchDeleteReadSet([
    'ids' => ['<string>', ...], // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'id' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CancelAnnotationImportJob

$result = $client->cancelAnnotationImportJob([/* ... */]);
$promise = $client->cancelAnnotationImportJobAsync([/* ... */]);

Cancels an annotation import job.

Parameter Syntax

$result = $client->cancelAnnotationImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CancelRun

$result = $client->cancelRun([/* ... */]);
$promise = $client->cancelRunAsync([/* ... */]);

Cancels a run.

Parameter Syntax

$result = $client->cancelRun([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CancelVariantImportJob

$result = $client->cancelVariantImportJob([/* ... */]);
$promise = $client->cancelVariantImportJobAsync([/* ... */]);

Cancels a variant import job.

Parameter Syntax

$result = $client->cancelVariantImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CompleteMultipartReadSetUpload

$result = $client->completeMultipartReadSetUpload([/* ... */]);
$promise = $client->completeMultipartReadSetUploadAsync([/* ... */]);

Concludes a multipart upload once you have uploaded all the components.

Parameter Syntax

$result = $client->completeMultipartReadSetUpload([
    'parts' => [ // REQUIRED
        [
            'checksum' => '<string>', // REQUIRED
            'partNumber' => <integer>, // REQUIRED
            'partSource' => 'SOURCE1|SOURCE2', // REQUIRED
        ],
        // ...
    ],
    'sequenceStoreId' => '<string>', // REQUIRED
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'readSetId' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

NotSupportedOperationException:

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

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CreateAnnotationStore

$result = $client->createAnnotationStore([/* ... */]);
$promise = $client->createAnnotationStoreAsync([/* ... */]);

Creates an annotation store.

Parameter Syntax

$result = $client->createAnnotationStore([
    'description' => '<string>',
    'name' => '<string>',
    'reference' => [
        'referenceArn' => '<string>',
    ],
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS', // REQUIRED
    ],
    'storeFormat' => 'GFF|TSV|VCF', // REQUIRED
    'storeOptions' => [
        'tsvStoreOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
    'tags' => ['<string>', ...],
    'versionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'name' => '<string>',
    'reference' => [
        'referenceArn' => '<string>',
    ],
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
    'storeFormat' => 'GFF|TSV|VCF',
    'storeOptions' => [
        'tsvStoreOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
    'versionName' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateAnnotationStoreVersion

$result = $client->createAnnotationStoreVersion([/* ... */]);
$promise = $client->createAnnotationStoreVersionAsync([/* ... */]);

Creates a new version of an annotation store.

Parameter Syntax

$result = $client->createAnnotationStoreVersion([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'versionName' => '<string>', // REQUIRED
    'versionOptions' => [
        'tsvVersionOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
    'storeId' => '<string>',
    'versionName' => '<string>',
    'versionOptions' => [
        'tsvVersionOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateMultipartReadSetUpload

$result = $client->createMultipartReadSetUpload([/* ... */]);
$promise = $client->createMultipartReadSetUploadAsync([/* ... */]);

Begins a multipart read set upload.

Parameter Syntax

$result = $client->createMultipartReadSetUpload([
    'clientToken' => '<string>',
    'description' => '<string>',
    'generatedFrom' => '<string>',
    'name' => '<string>', // REQUIRED
    'referenceArn' => '<string>',
    'sampleId' => '<string>', // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
    'sourceFileType' => 'FASTQ|BAM|CRAM|UBAM', // REQUIRED
    'subjectId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'generatedFrom' => '<string>',
    'name' => '<string>',
    'referenceArn' => '<string>',
    'sampleId' => '<string>',
    'sequenceStoreId' => '<string>',
    'sourceFileType' => 'FASTQ|BAM|CRAM|UBAM',
    'subjectId' => '<string>',
    'tags' => ['<string>', ...],
    'uploadId' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

NotSupportedOperationException:

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

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CreateReferenceStore

$result = $client->createReferenceStore([/* ... */]);
$promise = $client->createReferenceStoreAsync([/* ... */]);

Creates a reference store.

Parameter Syntax

$result = $client->createReferenceStore([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CreateRunGroup

$result = $client->createRunGroup([/* ... */]);
$promise = $client->createRunGroupAsync([/* ... */]);

Creates a run group.

Parameter Syntax

$result = $client->createRunGroup([
    'maxCpus' => <integer>,
    'maxDuration' => <integer>,
    'maxGpus' => <integer>,
    'maxRuns' => <integer>,
    'name' => '<string>',
    'requestId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CreateSequenceStore

$result = $client->createSequenceStore([/* ... */]);
$promise = $client->createSequenceStoreAsync([/* ... */]);

Creates a sequence store.

Parameter Syntax

$result = $client->createSequenceStore([
    'clientToken' => '<string>',
    'description' => '<string>',
    'eTagAlgorithmFamily' => 'MD5up|SHA256up|SHA512up',
    'fallbackLocation' => '<string>',
    'name' => '<string>', // REQUIRED
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'eTagAlgorithmFamily' => 'MD5up|SHA256up|SHA512up',
    'fallbackLocation' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

CreateShare

$result = $client->createShare([/* ... */]);
$promise = $client->createShareAsync([/* ... */]);

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

• Healthomics variant stores

• Healthomics annotation stores

• Private workflows

Parameter Syntax

$result = $client->createShare([
    'principalSubscriber' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
    'shareName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'shareId' => '<string>',
    'shareName' => '<string>',
    'status' => 'PENDING|ACTIVATING|ACTIVE|DELETING|DELETED|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateVariantStore

$result = $client->createVariantStore([/* ... */]);
$promise = $client->createVariantStoreAsync([/* ... */]);

Creates a variant store.

Parameter Syntax

$result = $client->createVariantStore([
    'description' => '<string>',
    'name' => '<string>',
    'reference' => [ // REQUIRED
        'referenceArn' => '<string>',
    ],
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'name' => '<string>',
    'reference' => [
        'referenceArn' => '<string>',
    ],
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateWorkflow

$result = $client->createWorkflow([/* ... */]);
$promise = $client->createWorkflowAsync([/* ... */]);

Creates a workflow.

Parameter Syntax

$result = $client->createWorkflow([
    'accelerators' => 'GPU',
    'definitionUri' => '<string>',
    'definitionZip' => <string || resource || Psr\Http\Message\StreamInterface>,
    'description' => '<string>',
    'engine' => 'WDL|NEXTFLOW|CWL',
    'main' => '<string>',
    'name' => '<string>',
    'parameterTemplate' => [
        '<WorkflowParameterName>' => [
            'description' => '<string>',
            'optional' => true || false,
        ],
        // ...
    ],
    'requestId' => '<string>', // REQUIRED
    'storageCapacity' => <integer>,
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATING|ACTIVE|UPDATING|DELETED|FAILED|INACTIVE',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteAnnotationStore

$result = $client->deleteAnnotationStore([/* ... */]);
$promise = $client->deleteAnnotationStoreAsync([/* ... */]);

Deletes an annotation store.

Parameter Syntax

$result = $client->deleteAnnotationStore([
    'force' => true || false,
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteAnnotationStoreVersions

$result = $client->deleteAnnotationStoreVersions([/* ... */]);
$promise = $client->deleteAnnotationStoreVersionsAsync([/* ... */]);

Deletes one or multiple versions of an annotation store.

Parameter Syntax

$result = $client->deleteAnnotationStoreVersions([
    'force' => true || false,
    'name' => '<string>', // REQUIRED
    'versions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'message' => '<string>',
            'versionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteReference

$result = $client->deleteReference([/* ... */]);
$promise = $client->deleteReferenceAsync([/* ... */]);

Deletes a genome reference.

Parameter Syntax

$result = $client->deleteReference([
    'id' => '<string>', // REQUIRED
    'referenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteReferenceStore

$result = $client->deleteReferenceStore([/* ... */]);
$promise = $client->deleteReferenceStoreAsync([/* ... */]);

Deletes a genome reference store.

Parameter Syntax

$result = $client->deleteReferenceStore([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteRun

$result = $client->deleteRun([/* ... */]);
$promise = $client->deleteRunAsync([/* ... */]);

Deletes a workflow run.

Parameter Syntax

$result = $client->deleteRun([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteRunGroup

$result = $client->deleteRunGroup([/* ... */]);
$promise = $client->deleteRunGroupAsync([/* ... */]);

Deletes a workflow run group.

Parameter Syntax

$result = $client->deleteRunGroup([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteSequenceStore

$result = $client->deleteSequenceStore([/* ... */]);
$promise = $client->deleteSequenceStoreAsync([/* ... */]);

Deletes a sequence store.

Parameter Syntax

$result = $client->deleteSequenceStore([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

DeleteShare

$result = $client->deleteShare([/* ... */]);
$promise = $client->deleteShareAsync([/* ... */]);

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

Parameter Syntax

$result = $client->deleteShare([
    'shareId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'PENDING|ACTIVATING|ACTIVE|DELETING|DELETED|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteVariantStore

$result = $client->deleteVariantStore([/* ... */]);
$promise = $client->deleteVariantStoreAsync([/* ... */]);

Deletes a variant store.

Parameter Syntax

$result = $client->deleteVariantStore([
    'force' => true || false,
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteWorkflow

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

Deletes a workflow.

Parameter Syntax

$result = $client->deleteWorkflow([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetAnnotationImportJob

$result = $client->getAnnotationImportJob([/* ... */]);
$promise = $client->getAnnotationImportJobAsync([/* ... */]);

Gets information about an annotation import job.

Parameter Syntax

$result = $client->getAnnotationImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'annotationFields' => ['<string>', ...],
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'destinationName' => '<string>',
    'formatOptions' => [
        'tsvOptions' => [
            'readOptions' => [
                'comment' => '<string>',
                'encoding' => '<string>',
                'escape' => '<string>',
                'escapeQuotes' => true || false,
                'header' => true || false,
                'lineSep' => '<string>',
                'quote' => '<string>',
                'quoteAll' => true || false,
                'sep' => '<string>',
            ],
        ],
        'vcfOptions' => [
            'ignoreFilterField' => true || false,
            'ignoreQualField' => true || false,
        ],
    ],
    'id' => '<string>',
    'items' => [
        [
            'jobStatus' => 'SUBMITTED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
            'source' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'runLeftNormalization' => true || false,
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
    'updateTime' => <DateTime>,
    'versionName' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetAnnotationStore

$result = $client->getAnnotationStore([/* ... */]);
$promise = $client->getAnnotationStoreAsync([/* ... */]);

Gets information about an annotation store.

Parameter Syntax

$result = $client->getAnnotationStore([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'numVersions' => <integer>,
    'reference' => [
        'referenceArn' => '<string>',
    ],
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
    'statusMessage' => '<string>',
    'storeArn' => '<string>',
    'storeFormat' => 'GFF|TSV|VCF',
    'storeOptions' => [
        'tsvStoreOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
    'storeSizeBytes' => <integer>,
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetAnnotationStoreVersion

$result = $client->getAnnotationStoreVersion([/* ... */]);
$promise = $client->getAnnotationStoreVersionAsync([/* ... */]);

Retrieves the metadata for an annotation store version.

Parameter Syntax

$result = $client->getAnnotationStoreVersion([
    'name' => '<string>', // REQUIRED
    'versionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
    'statusMessage' => '<string>',
    'storeId' => '<string>',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
    'versionArn' => '<string>',
    'versionName' => '<string>',
    'versionOptions' => [
        'tsvVersionOptions' => [
            'annotationType' => 'GENERIC|CHR_POS|CHR_POS_REF_ALT|CHR_START_END_ONE_BASE|CHR_START_END_REF_ALT_ONE_BASE|CHR_START_END_ZERO_BASE|CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader' => ['<string>', ...],
            'schema' => [
                ['<string>', ...],
                // ...
            ],
        ],
    ],
    'versionSizeBytes' => <integer>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetReadSet

$result = $client->getReadSet([/* ... */]);
$promise = $client->getReadSetAsync([/* ... */]);

Gets a file from a read set.

Parameter Syntax

$result = $client->getReadSet([
    'file' => 'SOURCE1|SOURCE2|INDEX',
    'id' => '<string>', // REQUIRED
    'partNumber' => <integer>, // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

RangeNotSatisfiableException:

The ranges specified in the request are not valid.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReadSetActivationJob

$result = $client->getReadSetActivationJob([/* ... */]);
$promise = $client->getReadSetActivationJobAsync([/* ... */]);

Gets information about a read set activation job.

Parameter Syntax

$result = $client->getReadSetActivationJob([
    'id' => '<string>', // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'sequenceStoreId' => '<string>',
    'sources' => [
        [
            'readSetId' => '<string>',
            'status' => 'NOT_STARTED|IN_PROGRESS|FINISHED|FAILED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLING|CANCELLED|FAILED|COMPLETED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReadSetExportJob

$result = $client->getReadSetExportJob([/* ... */]);
$promise = $client->getReadSetExportJobAsync([/* ... */]);

Gets information about a read set export job.

Parameter Syntax

$result = $client->getReadSetExportJob([
    'id' => '<string>', // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'destination' => '<string>',
    'id' => '<string>',
    'readSets' => [
        [
            'id' => '<string>',
            'status' => 'NOT_STARTED|IN_PROGRESS|FINISHED|FAILED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'sequenceStoreId' => '<string>',
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLING|CANCELLED|FAILED|COMPLETED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReadSetImportJob

$result = $client->getReadSetImportJob([/* ... */]);
$promise = $client->getReadSetImportJobAsync([/* ... */]);

Gets information about a read set import job.

Parameter Syntax

$result = $client->getReadSetImportJob([
    'id' => '<string>', // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'roleArn' => '<string>',
    'sequenceStoreId' => '<string>',
    'sources' => [
        [
            'description' => '<string>',
            'generatedFrom' => '<string>',
            'name' => '<string>',
            'referenceArn' => '<string>',
            'sampleId' => '<string>',
            'sourceFileType' => 'FASTQ|BAM|CRAM|UBAM',
            'sourceFiles' => [
                'source1' => '<string>',
                'source2' => '<string>',
            ],
            'status' => 'NOT_STARTED|IN_PROGRESS|FINISHED|FAILED',
            'statusMessage' => '<string>',
            'subjectId' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLING|CANCELLED|FAILED|COMPLETED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReadSetMetadata

$result = $client->getReadSetMetadata([/* ... */]);
$promise = $client->getReadSetMetadataAsync([/* ... */]);

Gets details about a read set.

Parameter Syntax

$result = $client->getReadSetMetadata([
    'id' => '<string>', // REQUIRED
    'sequenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'creationType' => 'IMPORT|UPLOAD',
    'description' => '<string>',
    'etag' => [
        'algorithm' => 'FASTQ_MD5up|BAM_MD5up|CRAM_MD5up|FASTQ_SHA256up|BAM_SHA256up|CRAM_SHA256up|FASTQ_SHA512up|BAM_SHA512up|CRAM_SHA512up',
        'source1' => '<string>',
        'source2' => '<string>',
    ],
    'fileType' => 'FASTQ|BAM|CRAM|UBAM',
    'files' => [
        'index' => [
            'contentLength' => <integer>,
            'partSize' => <integer>,
            's3Access' => [
                's3Uri' => '<string>',
            ],
            'totalParts' => <integer>,
        ],
        'source1' => [
            'contentLength' => <integer>,
            'partSize' => <integer>,
            's3Access' => [
                's3Uri' => '<string>',
            ],
            'totalParts' => <integer>,
        ],
        'source2' => [
            'contentLength' => <integer>,
            'partSize' => <integer>,
            's3Access' => [
                's3Uri' => '<string>',
            ],
            'totalParts' => <integer>,
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'referenceArn' => '<string>',
    'sampleId' => '<string>',
    'sequenceInformation' => [
        'alignment' => '<string>',
        'generatedFrom' => '<string>',
        'totalBaseCount' => <integer>,
        'totalReadCount' => <integer>,
    ],
    'sequenceStoreId' => '<string>',
    'status' => 'ARCHIVED|ACTIVATING|ACTIVE|DELETING|DELETED|PROCESSING_UPLOAD|UPLOAD_FAILED',
    'statusMessage' => '<string>',
    'subjectId' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReference

$result = $client->getReference([/* ... */]);
$promise = $client->getReferenceAsync([/* ... */]);

Gets a reference file.

Parameter Syntax

$result = $client->getReference([
    'file' => 'SOURCE|INDEX',
    'id' => '<string>', // REQUIRED
    'partNumber' => <integer>, // REQUIRED
    'range' => '<string>',
    'referenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

RangeNotSatisfiableException:

The ranges specified in the request are not valid.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReferenceImportJob

$result = $client->getReferenceImportJob([/* ... */]);
$promise = $client->getReferenceImportJobAsync([/* ... */]);

Gets information about a reference import job.

Parameter Syntax

$result = $client->getReferenceImportJob([
    'id' => '<string>', // REQUIRED
    'referenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'referenceStoreId' => '<string>',
    'roleArn' => '<string>',
    'sources' => [
        [
            'description' => '<string>',
            'name' => '<string>',
            'sourceFile' => '<string>',
            'status' => 'NOT_STARTED|IN_PROGRESS|FINISHED|FAILED',
            'statusMessage' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLING|CANCELLED|FAILED|COMPLETED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReferenceMetadata

$result = $client->getReferenceMetadata([/* ... */]);
$promise = $client->getReferenceMetadataAsync([/* ... */]);

Gets information about a genome reference's metadata.

Parameter Syntax

$result = $client->getReferenceMetadata([
    'id' => '<string>', // REQUIRED
    'referenceStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'files' => [
        'index' => [
            'contentLength' => <integer>,
            'partSize' => <integer>,
            's3Access' => [
                's3Uri' => '<string>',
            ],
            'totalParts' => <integer>,
        ],
        'source' => [
            'contentLength' => <integer>,
            'partSize' => <integer>,
            's3Access' => [
                's3Uri' => '<string>',
            ],
            'totalParts' => <integer>,
        ],
    ],
    'id' => '<string>',
    'md5' => '<string>',
    'name' => '<string>',
    'referenceStoreId' => '<string>',
    'status' => 'ACTIVE|DELETING|DELETED',
    'updateTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetReferenceStore

$result = $client->getReferenceStore([/* ... */]);
$promise = $client->getReferenceStoreAsync([/* ... */]);

Gets information about a reference store.

Parameter Syntax

$result = $client->getReferenceStore([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetRun

$result = $client->getRun([/* ... */]);
$promise = $client->getRunAsync([/* ... */]);

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

Parameter Syntax

$result = $client->getRun([
    'export' => ['<string>', ...],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accelerators' => 'GPU',
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'definition' => '<string>',
    'digest' => '<string>',
    'failureReason' => '<string>',
    'id' => '<string>',
    'logLevel' => 'OFF|FATAL|ERROR|ALL',
    'logLocation' => [
        'engineLogStream' => '<string>',
        'runLogStream' => '<string>',
    ],
    'name' => '<string>',
    'outputUri' => '<string>',
    'parameters' => [
    ],
    'priority' => <integer>,
    'resourceDigests' => ['<string>', ...],
    'retentionMode' => 'RETAIN|REMOVE',
    'roleArn' => '<string>',
    'runGroupId' => '<string>',
    'runId' => '<string>',
    'runOutputUri' => '<string>',
    'startTime' => <DateTime>,
    'startedBy' => '<string>',
    'status' => 'PENDING|STARTING|RUNNING|STOPPING|COMPLETED|DELETED|CANCELLED|FAILED',
    'statusMessage' => '<string>',
    'stopTime' => <DateTime>,
    'storageCapacity' => <integer>,
    'storageType' => 'STATIC|DYNAMIC',
    'tags' => ['<string>', ...],
    'uuid' => '<string>',
    'workflowId' => '<string>',
    'workflowOwnerId' => '<string>',
    'workflowType' => 'PRIVATE|READY2RUN',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetRunGroup

$result = $client->getRunGroup([/* ... */]);
$promise = $client->getRunGroupAsync([/* ... */]);

Gets information about a workflow run group.

Parameter Syntax

$result = $client->getRunGroup([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'id' => '<string>',
    'maxCpus' => <integer>,
    'maxDuration' => <integer>,
    'maxGpus' => <integer>,
    'maxRuns' => <integer>,
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetRunTask

$result = $client->getRunTask([/* ... */]);
$promise = $client->getRunTaskAsync([/* ... */]);

Gets information about a workflow run task.

Parameter Syntax

$result = $client->getRunTask([
    'id' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cpus' => <integer>,
    'creationTime' => <DateTime>,
    'failureReason' => '<string>',
    'gpus' => <integer>,
    'instanceType' => '<string>',
    'logStream' => '<string>',
    'memory' => <integer>,
    'name' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'PENDING|STARTING|RUNNING|STOPPING|COMPLETED|CANCELLED|FAILED',
    'statusMessage' => '<string>',
    'stopTime' => <DateTime>,
    'taskId' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetSequenceStore

$result = $client->getSequenceStore([/* ... */]);
$promise = $client->getSequenceStoreAsync([/* ... */]);

Gets information about a sequence store.

Parameter Syntax

$result = $client->getSequenceStore([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'eTagAlgorithmFamily' => 'MD5up|SHA256up|SHA512up',
    'fallbackLocation' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    's3Access' => [
        's3AccessPointArn' => '<string>',
        's3Uri' => '<string>',
    ],
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

RequestTimeoutException:

The request timed out.

GetShare

$result = $client->getShare([/* ... */]);
$promise = $client->getShareAsync([/* ... */]);

Retrieves the metadata for the specified resource share.

Parameter Syntax

$result = $client->getShare([
    'shareId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'share' => [
        'creationTime' => <DateTime>,
        'ownerId' => '<string>',
        'principalSubscriber' => '<string>',
        'resourceArn' => '<string>',
        'resourceId' => '<string>',
        'shareId' => '<string>',
        'shareName' => '<string>',
        'status' => 'PENDING|ACTIVATING|ACTIVE|DELETING|DELETED|FAILED',
        'statusMessage' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The request cannot be applied to the target resource in its current state.

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetVariantImportJob

$result = $client->getVariantImportJob([/* ... */]);
$promise = $client->getVariantImportJobAsync([/* ... */]);

Gets information about a variant import job.

Parameter Syntax

$result = $client->getVariantImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'annotationFields' => ['<string>', ...],
    'completionTime' => <DateTime>,
    'creationTime' => <DateTime>,
    'destinationName' => '<string>',
    'id' => '<string>',
    'items' => [
        [
            'jobStatus' => 'SUBMITTED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
            'source' => '<string>',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'runLeftNormalization' => true || false,
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
    'statusMessage' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetVariantStore

$result = $client->getVariantStore([/* ... */]);
$promise = $client->getVariantStoreAsync([/* ... */]);

Gets information about a variant store.

Parameter Syntax

$result = $client->getVariantStore([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'reference' => [
        'referenceArn' => '<string>',
    ],
    'sseConfig' => [
        'keyArn' => '<string>',
        'type' => 'KMS',
    ],
    'status' => 'CREATING|UPDATING|DELETING|ACTIVE|FAILED',
    'statusMessage' => '<string>',
    'storeArn' => '<string>',
    'storeSizeBytes' => <integer>,
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

An unexpected error occurred. Try the request again.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ResourceNotFoundException:

The target resource was not found in the current Region.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetWorkflow

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

Parameter Syntax

$result = $client->getWorkflow([
    'export' => ['<string>', ...],
    'id' => '<string>', // REQUIRED
    'type' => 'PRIVATE|READY2RUN',
    'workflowOwnerId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'accelerators' => 'GPU',
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'definition' => '<string>',
    'description' => '<string>',
    'digest' => '<string>',
    'engine' => 'WDL|NEXTFLOW|CWL',
    'id' => '<string>',
    'main' => '<string>',
    'metadata' => ['<string>', ...],
    'name' => '<string>',
    'parameterTemplate' => [
        '<WorkflowParameterName>' => [
            'description' => '<string>',
            'optional' => true || false,
        ],
        // ...
    ],
    'status' => 'CREATING|ACTIVE|UPDATING|DELETED|FAILED|INACTIVE',
    'statusMessage' => '<string>',
    'storageCapacity' => <integer>,
    'tags' => ['<string>', ...],
    'type' => 'PRIVATE|READY2RUN',
]

Result Details