omics

package module
v1.36.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2025 License: Apache-2.0 Imports: 49 Imported by: 6

Documentation

Overview

Package omics provides the API client, operations, and parameter types for Amazon Omics.

Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services.

For an introduction to the service, see What is Amazon Web Services HealthOmics? in the Amazon Web Services HealthOmics User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2022-11-28"
View Source 
const ServiceID = "Omics"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.6.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.15.1 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.15.1 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AbortMultipartReadSetUploadInput added in v1.4.0 

type AbortMultipartReadSetUploadInput struct {

	// The sequence store ID for the store involved in the multipart upload.
	//
	// This member is required.
	SequenceStoreId *string

	// The ID for the multipart upload.
	//
	// This member is required.
	UploadId *string
	// contains filtered or unexported fields
}

type AbortMultipartReadSetUploadOutput added in v1.4.0 

type AbortMultipartReadSetUploadOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AcceptShareInput added in v1.8.0 

type AcceptShareInput struct {

	// The ID of the resource share.
	//
	// This member is required.
	ShareId *string
	// contains filtered or unexported fields
}

type AcceptShareOutput added in v1.8.0 

type AcceptShareOutput struct {

	// The status of the resource share.
	Status types.ShareStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AnnotationImportJobCreatedWaiter 

type AnnotationImportJobCreatedWaiter struct {
	// contains filtered or unexported fields
}

AnnotationImportJobCreatedWaiter defines the waiters for AnnotationImportJobCreated

func NewAnnotationImportJobCreatedWaiter 

func NewAnnotationImportJobCreatedWaiter(client GetAnnotationImportJobAPIClient, optFns ...func(*AnnotationImportJobCreatedWaiterOptions)) *AnnotationImportJobCreatedWaiter

NewAnnotationImportJobCreatedWaiter constructs a AnnotationImportJobCreatedWaiter.

func (*AnnotationImportJobCreatedWaiter) Wait 

func (w *AnnotationImportJobCreatedWaiter) Wait(ctx context.Context, params *GetAnnotationImportJobInput, maxWaitDur time.Duration, optFns ...func(*AnnotationImportJobCreatedWaiterOptions)) error

Wait calls the waiter function for AnnotationImportJobCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AnnotationImportJobCreatedWaiter) WaitForOutput 

func (w *AnnotationImportJobCreatedWaiter) WaitForOutput(ctx context.Context, params *GetAnnotationImportJobInput, maxWaitDur time.Duration, optFns ...func(*AnnotationImportJobCreatedWaiterOptions)) (*GetAnnotationImportJobOutput, error)

WaitForOutput calls the waiter function for AnnotationImportJobCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AnnotationImportJobCreatedWaiterOptions 

type AnnotationImportJobCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AnnotationImportJobCreatedWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AnnotationImportJobCreatedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetAnnotationImportJobInput, *GetAnnotationImportJobOutput, error) (bool, error)
}

AnnotationImportJobCreatedWaiterOptions are waiter options for AnnotationImportJobCreatedWaiter

type AnnotationStoreCreatedWaiter 

type AnnotationStoreCreatedWaiter struct {
	// contains filtered or unexported fields
}

AnnotationStoreCreatedWaiter defines the waiters for AnnotationStoreCreated

func NewAnnotationStoreCreatedWaiter 

func NewAnnotationStoreCreatedWaiter(client GetAnnotationStoreAPIClient, optFns ...func(*AnnotationStoreCreatedWaiterOptions)) *AnnotationStoreCreatedWaiter

NewAnnotationStoreCreatedWaiter constructs a AnnotationStoreCreatedWaiter.

func (*AnnotationStoreCreatedWaiter) Wait 

func (w *AnnotationStoreCreatedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreCreatedWaiterOptions)) error

Wait calls the waiter function for AnnotationStoreCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AnnotationStoreCreatedWaiter) WaitForOutput 

func (w *AnnotationStoreCreatedWaiter) WaitForOutput(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreCreatedWaiterOptions)) (*GetAnnotationStoreOutput, error)

WaitForOutput calls the waiter function for AnnotationStoreCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AnnotationStoreCreatedWaiterOptions 

type AnnotationStoreCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AnnotationStoreCreatedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AnnotationStoreCreatedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetAnnotationStoreInput, *GetAnnotationStoreOutput, error) (bool, error)
}

AnnotationStoreCreatedWaiterOptions are waiter options for AnnotationStoreCreatedWaiter

type AnnotationStoreDeletedWaiter 

type AnnotationStoreDeletedWaiter struct {
	// contains filtered or unexported fields
}

AnnotationStoreDeletedWaiter defines the waiters for AnnotationStoreDeleted

func NewAnnotationStoreDeletedWaiter 

func NewAnnotationStoreDeletedWaiter(client GetAnnotationStoreAPIClient, optFns ...func(*AnnotationStoreDeletedWaiterOptions)) *AnnotationStoreDeletedWaiter

NewAnnotationStoreDeletedWaiter constructs a AnnotationStoreDeletedWaiter.

func (*AnnotationStoreDeletedWaiter) Wait 

func (w *AnnotationStoreDeletedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreDeletedWaiterOptions)) error

Wait calls the waiter function for AnnotationStoreDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AnnotationStoreDeletedWaiter) WaitForOutput 

func (w *AnnotationStoreDeletedWaiter) WaitForOutput(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreDeletedWaiterOptions)) (*GetAnnotationStoreOutput, error)

WaitForOutput calls the waiter function for AnnotationStoreDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AnnotationStoreDeletedWaiterOptions 

type AnnotationStoreDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AnnotationStoreDeletedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AnnotationStoreDeletedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetAnnotationStoreInput, *GetAnnotationStoreOutput, error) (bool, error)
}

AnnotationStoreDeletedWaiterOptions are waiter options for AnnotationStoreDeletedWaiter

type AnnotationStoreVersionCreatedWaiter added in v1.8.0 

type AnnotationStoreVersionCreatedWaiter struct {
	// contains filtered or unexported fields
}

AnnotationStoreVersionCreatedWaiter defines the waiters for AnnotationStoreVersionCreated

func NewAnnotationStoreVersionCreatedWaiter added in v1.8.0 

func NewAnnotationStoreVersionCreatedWaiter(client GetAnnotationStoreVersionAPIClient, optFns ...func(*AnnotationStoreVersionCreatedWaiterOptions)) *AnnotationStoreVersionCreatedWaiter

NewAnnotationStoreVersionCreatedWaiter constructs a AnnotationStoreVersionCreatedWaiter.

func (*AnnotationStoreVersionCreatedWaiter) Wait added in v1.8.0 

func (w *AnnotationStoreVersionCreatedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreVersionInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreVersionCreatedWaiterOptions)) error

Wait calls the waiter function for AnnotationStoreVersionCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AnnotationStoreVersionCreatedWaiter) WaitForOutput added in v1.8.0 

func (w *AnnotationStoreVersionCreatedWaiter) WaitForOutput(ctx context.Context, params *GetAnnotationStoreVersionInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreVersionCreatedWaiterOptions)) (*GetAnnotationStoreVersionOutput, error)

WaitForOutput calls the waiter function for AnnotationStoreVersionCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AnnotationStoreVersionCreatedWaiterOptions added in v1.8.0 

type AnnotationStoreVersionCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AnnotationStoreVersionCreatedWaiter will use default minimum delay of 30
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AnnotationStoreVersionCreatedWaiter will use default max delay of
	// 600 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetAnnotationStoreVersionInput, *GetAnnotationStoreVersionOutput, error) (bool, error)
}

AnnotationStoreVersionCreatedWaiterOptions are waiter options for AnnotationStoreVersionCreatedWaiter

type AnnotationStoreVersionDeletedWaiter added in v1.8.0 

type AnnotationStoreVersionDeletedWaiter struct {
	// contains filtered or unexported fields
}

AnnotationStoreVersionDeletedWaiter defines the waiters for AnnotationStoreVersionDeleted

func NewAnnotationStoreVersionDeletedWaiter added in v1.8.0 

func NewAnnotationStoreVersionDeletedWaiter(client GetAnnotationStoreVersionAPIClient, optFns ...func(*AnnotationStoreVersionDeletedWaiterOptions)) *AnnotationStoreVersionDeletedWaiter

NewAnnotationStoreVersionDeletedWaiter constructs a AnnotationStoreVersionDeletedWaiter.

func (*AnnotationStoreVersionDeletedWaiter) Wait added in v1.8.0 

func (w *AnnotationStoreVersionDeletedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreVersionInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreVersionDeletedWaiterOptions)) error

Wait calls the waiter function for AnnotationStoreVersionDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AnnotationStoreVersionDeletedWaiter) WaitForOutput added in v1.8.0 

func (w *AnnotationStoreVersionDeletedWaiter) WaitForOutput(ctx context.Context, params *GetAnnotationStoreVersionInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreVersionDeletedWaiterOptions)) (*GetAnnotationStoreVersionOutput, error)

WaitForOutput calls the waiter function for AnnotationStoreVersionDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AnnotationStoreVersionDeletedWaiterOptions added in v1.8.0 

type AnnotationStoreVersionDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AnnotationStoreVersionDeletedWaiter will use default minimum delay of 30
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AnnotationStoreVersionDeletedWaiter will use default max delay of
	// 600 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetAnnotationStoreVersionInput, *GetAnnotationStoreVersionOutput, error) (bool, error)
}

AnnotationStoreVersionDeletedWaiterOptions are waiter options for AnnotationStoreVersionDeletedWaiter

type AuthResolverParameters added in v1.15.1 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.15.1 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDeleteReadSetInput 

type BatchDeleteReadSetInput struct {

	// The read sets' IDs.
	//
	// This member is required.
	Ids []string

	// The read sets' sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string
	// contains filtered or unexported fields
}

type BatchDeleteReadSetOutput 

type BatchDeleteReadSetOutput struct {

	// Errors returned by individual delete operations.
	Errors []types.ReadSetBatchError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelAnnotationImportJobInput 

type CancelAnnotationImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type CancelAnnotationImportJobOutput 

type CancelAnnotationImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelRunInput 

type CancelRunInput struct {

	// The run's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type CancelRunOutput 

type CancelRunOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelVariantImportJobInput 

type CancelVariantImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type CancelVariantImportJobOutput 

type CancelVariantImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Omics.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AbortMultipartReadSetUpload added in v1.4.0 

func (c *Client) AbortMultipartReadSetUpload(ctx context.Context, params *AbortMultipartReadSetUploadInput, optFns ...func(*Options)) (*AbortMultipartReadSetUploadOutput, error)

Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the ListMultipartReadSetUploads API operation to view all active multipart read set uploads.

func (*Client) AcceptShare added in v1.8.0 

func (c *Client) AcceptShare(ctx context.Context, params *AcceptShareInput, optFns ...func(*Options)) (*AcceptShareOutput, error)

Accept a resource share request.

func (*Client) BatchDeleteReadSet 

func (c *Client) BatchDeleteReadSet(ctx context.Context, params *BatchDeleteReadSetInput, optFns ...func(*Options)) (*BatchDeleteReadSetOutput, error)

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

func (*Client) CancelAnnotationImportJob 

func (c *Client) CancelAnnotationImportJob(ctx context.Context, params *CancelAnnotationImportJobInput, optFns ...func(*Options)) (*CancelAnnotationImportJobOutput, error)

Cancels an annotation import job.

func (*Client) CancelRun 

func (c *Client) CancelRun(ctx context.Context, params *CancelRunInput, optFns ...func(*Options)) (*CancelRunOutput, error)

Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns API operation to check that it is no longer listed.

func (*Client) CancelVariantImportJob 

func (c *Client) CancelVariantImportJob(ctx context.Context, params *CancelVariantImportJobInput, optFns ...func(*Options)) (*CancelVariantImportJobOutput, error)

Cancels a variant import job.

func (*Client) CompleteMultipartReadSetUpload added in v1.4.0 

func (c *Client) CompleteMultipartReadSetUpload(ctx context.Context, params *CompleteMultipartReadSetUploadInput, optFns ...func(*Options)) (*CompleteMultipartReadSetUploadOutput, error)

Completes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart . You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s).

For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateAnnotationStore 

func (c *Client) CreateAnnotationStore(ctx context.Context, params *CreateAnnotationStoreInput, optFns ...func(*Options)) (*CreateAnnotationStoreOutput, error)

Creates an annotation store.

func (*Client) CreateAnnotationStoreVersion added in v1.8.0 

func (c *Client) CreateAnnotationStoreVersion(ctx context.Context, params *CreateAnnotationStoreVersionInput, optFns ...func(*Options)) (*CreateAnnotationStoreVersionOutput, error)

Creates a new version of an annotation store.

func (*Client) CreateMultipartReadSetUpload added in v1.4.0 

func (c *Client) CreateMultipartReadSetUpload(ctx context.Context, params *CreateMultipartReadSetUploadInput, optFns ...func(*Options)) (*CreateMultipartReadSetUploadOutput, error)

Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store.

To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below:

  • Specify the uploadId obtained from the previous call to CreateMultipartReadSetUpload .

  • Upload parts for that uploadId .

When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response.

To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateReferenceStore 

func (c *Client) CreateReferenceStore(ctx context.Context, params *CreateReferenceStoreInput, optFns ...func(*Options)) (*CreateReferenceStoreOutput, error)

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateRunCache added in v1.27.0 

func (c *Client) CreateRunCache(ctx context.Context, params *CreateRunCacheInput, optFns ...func(*Options)) (*CreateRunCacheOutput, error)

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file.

For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateRunGroup 

func (c *Client) CreateRunGroup(ctx context.Context, params *CreateRunGroupInput, optFns ...func(*Options)) (*CreateRunGroupOutput, error)

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

func (*Client) CreateSequenceStore 

func (c *Client) CreateSequenceStore(ctx context.Context, params *CreateSequenceStoreInput, optFns ...func(*Options)) (*CreateSequenceStoreOutput, error)

Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.

The following are optional parameters you can specify for your sequence store:

  • Use s3AccessConfig to configure your sequence store with S3 access logs (recommended).

  • Use sseConfig to define your own KMS key for encryption.

  • Use eTagAlgorithmFamily to define which algorithm to use for the HealthOmics eTag on objects.

  • Use fallbackLocation to define a backup location for storing files that have failed a direct upload.

  • Use propagatedSetLevelTags to configure tags that propagate to all objects in your store.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateShare added in v1.8.0 

func (c *Client) CreateShare(ctx context.Context, params *CreateShareInput, optFns ...func(*Options)) (*CreateShareOutput, error)

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

func (*Client) CreateVariantStore 

func (c *Client) CreateVariantStore(ctx context.Context, params *CreateVariantStoreInput, optFns ...func(*Options)) (*CreateVariantStoreOutput, error)

Creates a variant store.

func (*Client) CreateWorkflow 

func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput, optFns ...func(*Options)) (*CreateWorkflowOutput, error)

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:

  • Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format.

  • (Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.

  • ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.

  • (Optional) Sentieon licenses: Request a Sentieon license if using the Sentieon software in a private workflow.

For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

func (*Client) CreateWorkflowVersion added in v1.30.0 

func (c *Client) CreateWorkflowVersion(ctx context.Context, params *CreateWorkflowVersionInput, optFns ...func(*Options)) (*CreateWorkflowVersionOutput, error)

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

func (*Client) DeleteAnnotationStore 

func (c *Client) DeleteAnnotationStore(ctx context.Context, params *DeleteAnnotationStoreInput, optFns ...func(*Options)) (*DeleteAnnotationStoreOutput, error)

Deletes an annotation store.

func (*Client) DeleteAnnotationStoreVersions added in v1.8.0 

func (c *Client) DeleteAnnotationStoreVersions(ctx context.Context, params *DeleteAnnotationStoreVersionsInput, optFns ...func(*Options)) (*DeleteAnnotationStoreVersionsOutput, error)

Deletes one or multiple versions of an annotation store.

func (*Client) DeleteReference 

func (c *Client) DeleteReference(ctx context.Context, params *DeleteReferenceInput, optFns ...func(*Options)) (*DeleteReferenceOutput, error)

Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the DeleteReferenceStore API operation.

For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

func (*Client) DeleteReferenceStore 

func (c *Client) DeleteReferenceStore(ctx context.Context, params *DeleteReferenceStoreInput, optFns ...func(*Options)) (*DeleteReferenceStoreOutput, error)

Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference .

For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

func (*Client) DeleteRun 

func (c *Client) DeleteRun(ctx context.Context, params *DeleteRunInput, optFns ...func(*Options)) (*DeleteRunOutput, error)

Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED , FAILED , or CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.

To verify that the workflow is deleted:

  • Use ListRuns to confirm the workflow no longer appears in the list.

  • Use GetRun to verify the workflow cannot be found.

func (*Client) DeleteRunCache added in v1.27.0 

func (c *Client) DeleteRunCache(ctx context.Context, params *DeleteRunCacheInput, optFns ...func(*Options)) (*DeleteRunCacheOutput, error)

Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations.

For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

func (*Client) DeleteRunGroup 

func (c *Client) DeleteRunGroup(ctx context.Context, params *DeleteRunGroupInput, optFns ...func(*Options)) (*DeleteRunGroupOutput, error)

Deletes a run group and returns a response with no body if the operation is successful.

To verify that the run group is deleted:

  • Use ListRunGroups to confirm the workflow no longer appears in the list.

  • Use GetRunGroup to verify the workflow cannot be found.

func (*Client) DeleteS3AccessPolicy added in v1.28.0 

func (c *Client) DeleteS3AccessPolicy(ctx context.Context, params *DeleteS3AccessPolicyInput, optFns ...func(*Options)) (*DeleteS3AccessPolicyOutput, error)

Deletes an access policy for the specified store.

func (*Client) DeleteSequenceStore 

func (c *Client) DeleteSequenceStore(ctx context.Context, params *DeleteSequenceStoreInput, optFns ...func(*Options)) (*DeleteSequenceStoreOutput, error)

Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets.

Use the BatchDeleteReadSet API operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted.

For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

func (*Client) DeleteShare added in v1.8.0 

func (c *Client) DeleteShare(ctx context.Context, params *DeleteShareInput, optFns ...func(*Options)) (*DeleteShareOutput, error)

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.

func (*Client) DeleteVariantStore 

func (c *Client) DeleteVariantStore(ctx context.Context, params *DeleteVariantStoreInput, optFns ...func(*Options)) (*DeleteVariantStoreOutput, error)

Deletes a variant store.

func (*Client) DeleteWorkflow 

func (c *Client) DeleteWorkflow(ctx context.Context, params *DeleteWorkflowInput, optFns ...func(*Options)) (*DeleteWorkflowOutput, error)

Deletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful.

To verify that the workflow is deleted:

  • Use ListWorkflows to confirm the workflow no longer appears in the list.

  • Use GetWorkflow to verify the workflow cannot be found.

func (*Client) DeleteWorkflowVersion added in v1.30.0 

func (c *Client) DeleteWorkflowVersion(ctx context.Context, params *DeleteWorkflowVersionInput, optFns ...func(*Options)) (*DeleteWorkflowVersionOutput, error)

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

func (*Client) GetAnnotationImportJob 

func (c *Client) GetAnnotationImportJob(ctx context.Context, params *GetAnnotationImportJobInput, optFns ...func(*Options)) (*GetAnnotationImportJobOutput, error)

Gets information about an annotation import job.

func (*Client) GetAnnotationStore 

func (c *Client) GetAnnotationStore(ctx context.Context, params *GetAnnotationStoreInput, optFns ...func(*Options)) (*GetAnnotationStoreOutput, error)

Gets information about an annotation store.

func (*Client) GetAnnotationStoreVersion added in v1.8.0 

func (c *Client) GetAnnotationStoreVersion(ctx context.Context, params *GetAnnotationStoreVersionInput, optFns ...func(*Options)) (*GetAnnotationStoreVersionOutput, error)

Retrieves the metadata for an annotation store version.

func (*Client) GetReadSet 

func (c *Client) GetReadSet(ctx context.Context, params *GetReadSetInput, optFns ...func(*Options)) (*GetReadSetOutput, error)

Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

func (*Client) GetReadSetActivationJob 

func (c *Client) GetReadSetActivationJob(ctx context.Context, params *GetReadSetActivationJobInput, optFns ...func(*Options)) (*GetReadSetActivationJobOutput, error)

Returns detailed information about the status of a read set activation job in JSON format.

func (*Client) GetReadSetExportJob 

func (c *Client) GetReadSetExportJob(ctx context.Context, params *GetReadSetExportJobInput, optFns ...func(*Options)) (*GetReadSetExportJobOutput, error)

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

func (*Client) GetReadSetImportJob 

func (c *Client) GetReadSetImportJob(ctx context.Context, params *GetReadSetImportJobInput, optFns ...func(*Options)) (*GetReadSetImportJobOutput, error)

Gets detailed and status information about a read set import job and returns the data in JSON format.

func (*Client) GetReadSetMetadata 

func (c *Client) GetReadSetMetadata(ctx context.Context, params *GetReadSetMetadataInput, optFns ...func(*Options)) (*GetReadSetMetadataOutput, error)

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

func (*Client) GetReference 

func (c *Client) GetReference(ctx context.Context, params *GetReferenceInput, optFns ...func(*Options)) (*GetReferenceOutput, error)

Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

func (*Client) GetReferenceImportJob 

func (c *Client) GetReferenceImportJob(ctx context.Context, params *GetReferenceImportJobInput, optFns ...func(*Options)) (*GetReferenceImportJobOutput, error)

Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.

func (*Client) GetReferenceMetadata 

func (c *Client) GetReferenceMetadata(ctx context.Context, params *GetReferenceMetadataInput, optFns ...func(*Options)) (*GetReferenceMetadataOutput, error)

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

func (*Client) GetReferenceStore 

func (c *Client) GetReferenceStore(ctx context.Context, params *GetReferenceStoreInput, optFns ...func(*Options)) (*GetReferenceStoreOutput, error)

Gets information about a reference store.

func (*Client) GetRun 

func (c *Client) GetRun(ctx context.Context, params *GetRunInput, optFns ...func(*Options)) (*GetRunOutput, error)

Gets detailed information about a specific run using its ID.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logsin the Amazon Web Services HealthOmics User Guide.

func (*Client) GetRunCache added in v1.27.0 

func (c *Client) GetRunCache(ctx context.Context, params *GetRunCacheInput, optFns ...func(*Options)) (*GetRunCacheOutput, error)

Retrieves detailed information about the specified run cache using its ID.

For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

func (*Client) GetRunGroup 

func (c *Client) GetRunGroup(ctx context.Context, params *GetRunGroupInput, optFns ...func(*Options)) (*GetRunGroupOutput, error)

Gets information about a run group and returns its metadata.

func (*Client) GetRunTask 

func (c *Client) GetRunTask(ctx context.Context, params *GetRunTaskInput, optFns ...func(*Options)) (*GetRunTaskOutput, error)

Gets detailed information about a run task using its ID.

func (*Client) GetS3AccessPolicy added in v1.28.0 

func (c *Client) GetS3AccessPolicy(ctx context.Context, params *GetS3AccessPolicyInput, optFns ...func(*Options)) (*GetS3AccessPolicyOutput, error)

Retrieves details about an access policy on a given store.

func (*Client) GetSequenceStore 

func (c *Client) GetSequenceStore(ctx context.Context, params *GetSequenceStoreInput, optFns ...func(*Options)) (*GetSequenceStoreOutput, error)

Retrieves metadata for a sequence store using its ID and returns it in JSON format.

func (*Client) GetShare added in v1.8.0 

func (c *Client) GetShare(ctx context.Context, params *GetShareInput, optFns ...func(*Options)) (*GetShareOutput, error)

Retrieves the metadata for the specified resource share.

func (*Client) GetVariantImportJob 

func (c *Client) GetVariantImportJob(ctx context.Context, params *GetVariantImportJobInput, optFns ...func(*Options)) (*GetVariantImportJobOutput, error)

Gets information about a variant import job.

func (*Client) GetVariantStore 

func (c *Client) GetVariantStore(ctx context.Context, params *GetVariantStoreInput, optFns ...func(*Options)) (*GetVariantStoreOutput, error)

Gets information about a variant store.

func (*Client) GetWorkflow 

func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error)

Gets all information about a workflow using its ID.

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

For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

func (*Client) GetWorkflowVersion added in v1.30.0 

func (c *Client) GetWorkflowVersion(ctx context.Context, params *GetWorkflowVersionInput, optFns ...func(*Options)) (*GetWorkflowVersionOutput, error)

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

func (*Client) ListAnnotationImportJobs 

func (c *Client) ListAnnotationImportJobs(ctx context.Context, params *ListAnnotationImportJobsInput, optFns ...func(*Options)) (*ListAnnotationImportJobsOutput, error)

Retrieves a list of annotation import jobs.

func (*Client) ListAnnotationStoreVersions added in v1.8.0 

func (c *Client) ListAnnotationStoreVersions(ctx context.Context, params *ListAnnotationStoreVersionsInput, optFns ...func(*Options)) (*ListAnnotationStoreVersionsOutput, error)

Lists the versions of an annotation store.

func (*Client) ListAnnotationStores 

func (c *Client) ListAnnotationStores(ctx context.Context, params *ListAnnotationStoresInput, optFns ...func(*Options)) (*ListAnnotationStoresOutput, error)

Retrieves a list of annotation stores.

func (*Client) ListMultipartReadSetUploads added in v1.4.0 

func (c *Client) ListMultipartReadSetUploads(ctx context.Context, params *ListMultipartReadSetUploadsInput, optFns ...func(*Options)) (*ListMultipartReadSetUploadsOutput, error)

Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.

func (*Client) ListReadSetActivationJobs 

func (c *Client) ListReadSetActivationJobs(ctx context.Context, params *ListReadSetActivationJobsInput, optFns ...func(*Options)) (*ListReadSetActivationJobsOutput, error)

Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.

func (*Client) ListReadSetExportJobs 

func (c *Client) ListReadSetExportJobs(ctx context.Context, params *ListReadSetExportJobsInput, optFns ...func(*Options)) (*ListReadSetExportJobsOutput, error)

Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

func (*Client) ListReadSetImportJobs 

func (c *Client) ListReadSetImportJobs(ctx context.Context, params *ListReadSetImportJobsInput, optFns ...func(*Options)) (*ListReadSetImportJobsOutput, error)

Retrieves a list of read set import jobs and returns the data in JSON format.

func (*Client) ListReadSetUploadParts added in v1.4.0 

func (c *Client) ListReadSetUploadParts(ctx context.Context, params *ListReadSetUploadPartsInput, optFns ...func(*Options)) (*ListReadSetUploadPartsOutput, error)

Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.

func (*Client) ListReadSets 

func (c *Client) ListReadSets(ctx context.Context, params *ListReadSetsInput, optFns ...func(*Options)) (*ListReadSetsOutput, error)

Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.

func (*Client) ListReferenceImportJobs 

func (c *Client) ListReferenceImportJobs(ctx context.Context, params *ListReferenceImportJobsInput, optFns ...func(*Options)) (*ListReferenceImportJobsOutput, error)

Retrieves the metadata of one or more reference import jobs for a reference store.

func (*Client) ListReferenceStores 

func (c *Client) ListReferenceStores(ctx context.Context, params *ListReferenceStoresInput, optFns ...func(*Options)) (*ListReferenceStoresOutput, error)

Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

func (*Client) ListReferences 

func (c *Client) ListReferences(ctx context.Context, params *ListReferencesInput, optFns ...func(*Options)) (*ListReferencesOutput, error)

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

func (*Client) ListRunCaches added in v1.27.0 

func (c *Client) ListRunCaches(ctx context.Context, params *ListRunCachesInput, optFns ...func(*Options)) (*ListRunCachesOutput, error)

Retrieves a list of your run caches and the metadata for each cache.

func (*Client) ListRunGroups 

func (c *Client) ListRunGroups(ctx context.Context, params *ListRunGroupsInput, optFns ...func(*Options)) (*ListRunGroupsOutput, error)

Retrieves a list of all run groups and returns the metadata for each run group.

func (*Client) ListRunTasks 

func (c *Client) ListRunTasks(ctx context.Context, params *ListRunTasksInput, optFns ...func(*Options)) (*ListRunTasksOutput, error)

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

func (*Client) ListRuns 

func (c *Client) ListRuns(ctx context.Context, params *ListRunsInput, optFns ...func(*Options)) (*ListRunsOutput, error)

Retrieves a list of runs and returns each run's metadata and status.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logsin the Amazon Web Services HealthOmics User Guide.

func (*Client) ListSequenceStores 

func (c *Client) ListSequenceStores(ctx context.Context, params *ListSequenceStoresInput, optFns ...func(*Options)) (*ListSequenceStoresOutput, error)

Retrieves a list of sequence stores and returns each sequence store's metadata.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

func (*Client) ListShares added in v1.8.0 

func (c *Client) ListShares(ctx context.Context, params *ListSharesInput, optFns ...func(*Options)) (*ListSharesOutput, error)

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Retrieves a list of tags for a resource.

func (*Client) ListVariantImportJobs 

func (c *Client) ListVariantImportJobs(ctx context.Context, params *ListVariantImportJobsInput, optFns ...func(*Options)) (*ListVariantImportJobsOutput, error)

Retrieves a list of variant import jobs.

func (*Client) ListVariantStores 

func (c *Client) ListVariantStores(ctx context.Context, params *ListVariantStoresInput, optFns ...func(*Options)) (*ListVariantStoresOutput, error)

Retrieves a list of variant stores.

func (*Client) ListWorkflowVersions added in v1.30.0 

func (c *Client) ListWorkflowVersions(ctx context.Context, params *ListWorkflowVersionsInput, optFns ...func(*Options)) (*ListWorkflowVersionsOutput, error)

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmicsin the Amazon Web Services HealthOmics User Guide.

func (*Client) ListWorkflows 

func (c *Client) ListWorkflows(ctx context.Context, params *ListWorkflowsInput, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

func (*Client) Options added in v1.16.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutS3AccessPolicy added in v1.28.0 

func (c *Client) PutS3AccessPolicy(ctx context.Context, params *PutS3AccessPolicyInput, optFns ...func(*Options)) (*PutS3AccessPolicyOutput, error)

Adds an access policy to the specified store.

func (*Client) StartAnnotationImportJob 

func (c *Client) StartAnnotationImportJob(ctx context.Context, params *StartAnnotationImportJobInput, optFns ...func(*Options)) (*StartAnnotationImportJobOutput, error)

Starts an annotation import job.

func (*Client) StartReadSetActivationJob 

func (c *Client) StartReadSetActivationJob(ctx context.Context, params *StartReadSetActivationJobInput, optFns ...func(*Options)) (*StartReadSetActivationJobOutput, error)

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation.

To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

func (*Client) StartReadSetExportJob 

func (c *Client) StartReadSetExportJob(ctx context.Context, params *StartReadSetExportJobInput, optFns ...func(*Options)) (*StartReadSetExportJobOutput, error)

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation.

To monitor the status of the export job, use the ListReadSetExportJobs API operation.

func (*Client) StartReadSetImportJob 

func (c *Client) StartReadSetImportJob(ctx context.Context, params *StartReadSetImportJobInput, optFns ...func(*Options)) (*StartReadSetImportJobOutput, error)

Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.

func (*Client) StartReferenceImportJob 

func (c *Client) StartReferenceImportJob(ctx context.Context, params *StartReferenceImportJobInput, optFns ...func(*Options)) (*StartReferenceImportJobOutput, error)

Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the GetReferenceImportJob API operation.

func (*Client) StartRun 

func (c *Client) StartRun(ctx context.Context, params *StartRunInput, optFns ...func(*Options)) (*StartRunOutput, error)

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.

To start a new run, the following inputs are required:

  • A service role ARN ( roleArn ).

  • The run's workflow ID ( workflowId , not the uuid or runId ).

  • An Amazon S3 location ( outputUri ) where the run outputs will be saved.

  • All required workflow parameters ( parameter ), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation.

  • For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage.

StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:

  • A service role ARN ( roleArn ).

  • The ID of the run to duplicate ( runId ).

  • An Amazon S3 location where the run outputs will be saved ( outputUri ).

To learn more about the optional parameters for StartRun , see Starting a run in the Amazon Web Services HealthOmics User Guide.

Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:

  • Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit.

  • The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.

To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.

func (*Client) StartVariantImportJob 

func (c *Client) StartVariantImportJob(ctx context.Context, params *StartVariantImportJobInput, optFns ...func(*Options)) (*StartVariantImportJobOutput, error)

Starts a variant import job.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags a resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a resource.

func (*Client) UpdateAnnotationStore 

func (c *Client) UpdateAnnotationStore(ctx context.Context, params *UpdateAnnotationStoreInput, optFns ...func(*Options)) (*UpdateAnnotationStoreOutput, error)

Updates an annotation store.

func (*Client) UpdateAnnotationStoreVersion added in v1.8.0 

func (c *Client) UpdateAnnotationStoreVersion(ctx context.Context, params *UpdateAnnotationStoreVersionInput, optFns ...func(*Options)) (*UpdateAnnotationStoreVersionOutput, error)

Updates the description of an annotation store version.

func (*Client) UpdateRunCache added in v1.27.0 

func (c *Client) UpdateRunCache(ctx context.Context, params *UpdateRunCacheInput, optFns ...func(*Options)) (*UpdateRunCacheOutput, error)

Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS . To confirm that your run cache settings have been properly updated, use the GetRunCache API operation.

For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.

func (*Client) UpdateRunGroup 

func (c *Client) UpdateRunGroup(ctx context.Context, params *UpdateRunGroupInput, optFns ...func(*Options)) (*UpdateRunGroupOutput, error)

Updates the settings of a run group and returns a response with no body if the operation is successful.

You can update the following settings with UpdateRunGroup :

  • Maximum number of CPUs

  • Run time (measured in minutes)

  • Number of GPUs

  • Number of concurrent runs

  • Group name

To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.

func (*Client) UpdateSequenceStore added in v1.28.0 

func (c *Client) UpdateSequenceStore(ctx context.Context, params *UpdateSequenceStoreInput, optFns ...func(*Options)) (*UpdateSequenceStoreOutput, error)

Update one or more parameters for the sequence store.

func (*Client) UpdateVariantStore 

func (c *Client) UpdateVariantStore(ctx context.Context, params *UpdateVariantStoreInput, optFns ...func(*Options)) (*UpdateVariantStoreOutput, error)

Updates a variant store.

func (*Client) UpdateWorkflow 

func (c *Client) UpdateWorkflow(ctx context.Context, params *UpdateWorkflowInput, optFns ...func(*Options)) (*UpdateWorkflowOutput, error)

Updates information about a workflow.

You can update the following workflow information:

  • Name

  • Description

  • Default storage type

  • Default storage capacity (with workflow ID)

This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the GetWorkflow API operation.

For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

func (*Client) UpdateWorkflowVersion added in v1.30.0 

func (c *Client) UpdateWorkflowVersion(ctx context.Context, params *UpdateWorkflowVersionInput, optFns ...func(*Options)) (*UpdateWorkflowVersionOutput, error)

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

func (*Client) UploadReadSetPart added in v1.4.0 

func (c *Client) UploadReadSetPart(ctx context.Context, params *UploadReadSetPartInput, optFns ...func(*Options)) (*UploadReadSetPartOutput, error)

Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.

For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

type CompleteMultipartReadSetUploadInput added in v1.4.0 

type CompleteMultipartReadSetUploadInput struct {

	// The individual uploads or parts of a multipart upload.
	//
	// This member is required.
	Parts []types.CompleteReadSetUploadPartListItem

	// The sequence store ID for the store involved in the multipart upload.
	//
	// This member is required.
	SequenceStoreId *string

	// The ID for the multipart upload.
	//
	// This member is required.
	UploadId *string
	// contains filtered or unexported fields
}

type CompleteMultipartReadSetUploadOutput added in v1.4.0 

type CompleteMultipartReadSetUploadOutput struct {

	// The read set ID created for an uploaded read set.
	//
	// This member is required.
	ReadSetId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAnnotationStoreInput 

type CreateAnnotationStoreInput struct {

	// The annotation file format of the store.
	//
	// This member is required.
	StoreFormat types.StoreFormat

	// A description for the store.
	Description *string

	// A name for the store.
	Name *string

	// The genome reference for the store's annotations.
	Reference types.ReferenceItem

	// Server-side encryption (SSE) settings for the store.
	SseConfig *types.SseConfig

	// File parsing options for the annotation store.
	StoreOptions types.StoreOptions

	// Tags for the store.
	Tags map[string]string

	//  The name given to an annotation store version to distinguish it from other
	// versions.
	VersionName *string
	// contains filtered or unexported fields
}

type CreateAnnotationStoreOutput 

type CreateAnnotationStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	//  The name given to an annotation store version to distinguish it from other
	// versions.
	//
	// This member is required.
	VersionName *string

	// The store's genome reference. Required for all stores except TSV format with
	// generic annotations.
	Reference types.ReferenceItem

	// The annotation file format of the store.
	StoreFormat types.StoreFormat

	// The store's file parsing options.
	StoreOptions types.StoreOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAnnotationStoreVersionInput added in v1.8.0 

type CreateAnnotationStoreVersionInput struct {

	//  The name of an annotation store version from which versions are being created.
	//
	// This member is required.
	Name *string

	//  The name given to an annotation store version to distinguish it from other
	// versions.
	//
	// This member is required.
	VersionName *string

	//  The description of an annotation store version.
	Description *string

	//  Any tags added to annotation store version.
	Tags map[string]string

	//  The options for an annotation store version.
	VersionOptions types.VersionOptions
	// contains filtered or unexported fields
}

type CreateAnnotationStoreVersionOutput added in v1.8.0 

type CreateAnnotationStoreVersionOutput struct {

	//  The time stamp for the creation of an annotation store version.
	//
	// This member is required.
	CreationTime *time.Time

	//  A generated ID for the annotation store
	//
	// This member is required.
	Id *string

	//  The name given to an annotation store version to distinguish it from other
	// versions.
	//
	// This member is required.
	Name *string

	//  The status of a annotation store version.
	//
	// This member is required.
	Status types.VersionStatus

	//  The ID for the annotation store from which new versions are being created.
	//
	// This member is required.
	StoreId *string

	//  The name given to an annotation store version to distinguish it from other
	// versions.
	//
	// This member is required.
	VersionName *string

	//  The options for an annotation store version.
	VersionOptions types.VersionOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMultipartReadSetUploadInput added in v1.4.0 

type CreateMultipartReadSetUploadInput struct {

	// The name of the read set.
	//
	// This member is required.
	Name *string

	// The source's sample ID.
	//
	// This member is required.
	SampleId *string

	// The sequence store ID for the store that is the destination of the multipart
	// uploads.
	//
	// This member is required.
	SequenceStoreId *string

	// The type of file being uploaded.
	//
	// This member is required.
	SourceFileType types.FileType

	// The source's subject ID.
	//
	// This member is required.
	SubjectId *string

	// An idempotency token that can be used to avoid triggering multiple multipart
	// uploads.
	ClientToken *string

	// The description of the read set.
	Description *string

	// Where the source originated.
	GeneratedFrom *string

	// The ARN of the reference.
	ReferenceArn *string

	// Any tags to add to the read set.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMultipartReadSetUploadOutput added in v1.4.0 

type CreateMultipartReadSetUploadOutput struct {

	// The creation time of the multipart upload.
	//
	// This member is required.
	CreationTime *time.Time

	// The read set source's reference ARN.
	//
	// This member is required.
	ReferenceArn *string

	// The source's sample ID.
	//
	// This member is required.
	SampleId *string

	// The sequence store ID for the store that the read set will be created in.
	//
	// This member is required.
	SequenceStoreId *string

	// The file type of the read set source.
	//
	// This member is required.
	SourceFileType types.FileType

	// The source's subject ID.
	//
	// This member is required.
	SubjectId *string

	// The ID for the initiated multipart upload.
	//
	// This member is required.
	UploadId *string

	// The description of the read set.
	Description *string

	// The source of the read set.
	GeneratedFrom *string

	// The name of the read set.
	Name *string

	// The tags to add to the read set.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateReferenceStoreInput 

type CreateReferenceStoreInput struct {

	// A name for the store.
	//
	// This member is required.
	Name *string

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

	// A description for the store.
	Description *string

	// Server-side encryption (SSE) settings for the store.
	SseConfig *types.SseConfig

	// Tags for the store.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateReferenceStoreOutput 

type CreateReferenceStoreOutput struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The store's name.
	Name *string

	// The store's SSE settings.
	SseConfig *types.SseConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRunCacheInput added in v1.27.0 

type CreateRunCacheInput struct {

	// Specify the S3 location for storing the cached task outputs. This data must be
	// immediately accessible (not in an archived state).
	//
	// This member is required.
	CacheS3Location *string

	// A unique request token, to ensure idempotency. If you don't specify a token,
	// Amazon Web Services HealthOmics automatically generates a universally unique
	// identifier (UUID) for the request.
	//
	// This member is required.
	RequestId *string

	// Default cache behavior for runs that use this cache. Supported values are:
	//
	// CACHE_ON_FAILURE : Caches task outputs from completed tasks for runs that fail.
	// This setting is useful if you're debugging a workflow that fails after several
	// tasks completed successfully. The subsequent run uses the cache outputs for
	// previously-completed tasks if the task definition, inputs, and container in ECR
	// are identical to the prior run.
	//
	// CACHE_ALWAYS : Caches task outputs from completed tasks for all runs. This
	// setting is useful in development mode, but do not use it in a production
	// setting.
	//
	// If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When
	// you start a run that uses this cache, you can override the default cache
	// behavior.
	//
	// For more information, see [Run cache behavior] in the Amazon Web Services HealthOmics User Guide.
	//
	// [Run cache behavior]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
	CacheBehavior types.CacheBehavior

	// The Amazon Web Services account ID of the expected owner of the S3 bucket for
	// the run cache. If not provided, your account ID is set as the owner of the
	// bucket.
	CacheBucketOwnerId *string

	// Enter a description of the run cache.
	Description *string

	// Enter a user-friendly name for the run cache.
	Name *string

	// Specify one or more tags to associate with this run cache.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRunCacheOutput added in v1.27.0 

type CreateRunCacheOutput struct {

	// Unique resource identifier for the run cache.
	Arn *string

	// Identifier for the run cache.
	Id *string

	// Run cache status.
	Status types.RunCacheStatus

	// The tags associated with this run cache.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRunGroupInput 

type CreateRunGroupInput struct {

	// To ensure that requests don't run multiple times, specify a unique ID for each
	// request.
	//
	// This member is required.
	RequestId *string

	// The maximum number of CPUs that can run concurrently across all active runs in
	// the run group.
	MaxCpus *int32

	// The maximum time for each run (in minutes). If a run exceeds the maximum run
	// time, the run fails automatically.
	MaxDuration *int32

	// The maximum number of GPUs that can run concurrently across all active runs in
	// the run group.
	MaxGpus *int32

	// The maximum number of runs that can be running at the same time.
	MaxRuns *int32

	// A name for the group.
	Name *string

	// Tags for the group.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRunGroupOutput 

type CreateRunGroupOutput struct {

	// The group's ARN.
	Arn *string

	// The group's ID.
	Id *string

	// Tags for the run group.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSequenceStoreInput 

type CreateSequenceStoreInput struct {

	// A name for the store.
	//
	// This member is required.
	Name *string

	// An idempotency token used to dedupe retry requests so that duplicate runs are
	// not created.
	ClientToken *string

	// A description for the store.
	Description *string

	// The ETag algorithm family to use for ingested read sets. The default value is
	// MD5up. For more information on ETags, see [ETags and data provenance]in the Amazon Web Services
	// HealthOmics User Guide.
	//
	// [ETags and data provenance]: https://docs.aws.amazon.com/omics/latest/dev/etags-and-provenance.html
	ETagAlgorithmFamily types.ETagAlgorithmFamily

	// An S3 location that is used to store files that have failed a direct upload.
	// You can add or change the fallbackLocation after creating a sequence store.
	// This is not required if you are uploading files from a different S3 bucket.
	FallbackLocation *string

	// The tags keys to propagate to the S3 objects associated with read sets in the
	// sequence store. These tags can be used as input to add metadata to your read
	// sets.
	PropagatedSetLevelTags []string

	// S3 access configuration parameters. This specifies the parameters needed to
	// access logs stored in S3 buckets. The S3 bucket must be in the same region and
	// account as the sequence store.
	S3AccessConfig *types.S3AccessConfig

	// Server-side encryption (SSE) settings for the store.
	SseConfig *types.SseConfig

	// Tags for the store. You can configure up to 50 tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSequenceStoreOutput 

type CreateSequenceStoreOutput struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The algorithm family of the ETag.
	ETagAlgorithmFamily types.ETagAlgorithmFamily

	// An S3 location that is used to store files that have failed a direct upload.
	FallbackLocation *string

	// The store's name.
	Name *string

	// The tags keys to propagate to the S3 objects associated with read sets in the
	// sequence store.
	PropagatedSetLevelTags []string

	// The S3 access metadata of the sequence store.
	S3Access *types.SequenceStoreS3Access

	// Server-side encryption (SSE) settings for the store. This contains the KMS key
	// ARN that is used to encrypt read set objects.
	SseConfig *types.SseConfig

	// The status of the sequence store.
	Status types.SequenceStoreStatus

	// The status message of the sequence store.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateShareInput added in v1.8.0 

type CreateShareInput struct {

	// The principal subscriber is the account being offered shared access to the
	// resource.
	//
	// This member is required.
	PrincipalSubscriber *string

	// The ARN of the resource to be shared.
	//
	// This member is required.
	ResourceArn *string

	// A name that the owner defines for the share.
	ShareName *string
	// contains filtered or unexported fields
}

type CreateShareOutput added in v1.8.0 

type CreateShareOutput struct {

	// The ID that HealthOmics generates for the share.
	ShareId *string

	// The name of the share.
	ShareName *string

	// The status of the share.
	Status types.ShareStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVariantStoreInput 

type CreateVariantStoreInput struct {

	// The genome reference for the store's variants.
	//
	// This member is required.
	Reference types.ReferenceItem

	// A description for the store.
	Description *string

	// A name for the store.
	Name *string

	// Server-side encryption (SSE) settings for the store.
	SseConfig *types.SseConfig

	// Tags for the store.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateVariantStoreOutput 

type CreateVariantStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// The store's genome reference.
	Reference types.ReferenceItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkflowInput 

type CreateWorkflowInput struct {

	// An idempotency token to ensure that duplicate workflows are not created when
	// Amazon Web Services HealthOmics submits retry requests.
	//
	// This member is required.
	RequestId *string

	// The computational accelerator specified to run the workflow.
	Accelerators types.Accelerators

	// (Optional) Use a container registry map to specify mappings between the ECR
	// private repository and one or more upstream registries. For more information,
	// see [Container images]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Container images]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
	ContainerRegistryMap *types.ContainerRegistryMap

	// (Optional) URI of the S3 location for the registry mapping file.
	ContainerRegistryMapUri *string

	// The repository information for the workflow definition. This allows you to
	// source your workflow definition directly from a code repository.
	DefinitionRepository *types.DefinitionRepository

	// The S3 URI of a definition for the workflow. The S3 bucket must be in the same
	// region as the workflow.
	DefinitionUri *string

	// A ZIP archive containing the main workflow definition file and dependencies
	// that it imports for the workflow. You can use a file with a ://fileb prefix
	// instead of the Base64 string. For more information, see [Workflow definition requirements]in the Amazon Web
	// Services HealthOmics User Guide.
	//
	// [Workflow definition requirements]: https://docs.aws.amazon.com/omics/latest/dev/workflow-defn-requirements.html
	DefinitionZip []byte

	// A description for the workflow.
	Description *string

	// The workflow engine for the workflow. This is only required if you have
	// workflow definition files from more than one engine in your zip file. Otherwise,
	// the service can detect the engine automatically from your workflow definition.
	Engine types.WorkflowEngine

	// The path of the main definition file for the workflow. This parameter is not
	// required if the ZIP archive contains only one workflow definition file, or if
	// the main definition file is named “main”. An example path is:
	// workflow-definition/main-file.wdl .
	Main *string

	// Name (optional but highly recommended) for the workflow to locate relevant
	// information in the CloudWatch logs and Amazon Web Services HealthOmics console.
	Name *string

	// A parameter template for the workflow. If this field is blank, Amazon Web
	// Services HealthOmics will automatically parse the parameter template values from
	// your workflow definition file. To override these service generated default
	// values, provide a parameter template. To view an example of a parameter
	// template, see [Parameter template files]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Parameter template files]: https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html
	ParameterTemplate map[string]types.WorkflowParameter

	// The path to the workflow parameter template JSON file within the repository.
	// This file defines the input parameters for runs that use this workflow. If not
	// specified, the workflow will be created without a parameter template.
	ParameterTemplatePath *string

	// The markdown content for the workflow's README file. This provides
	// documentation and usage information for users of the workflow.
	//
	// This value conforms to the media type: text/markdown
	ReadmeMarkdown *string

	// The path to the workflow README markdown file within the repository. This file
	// provides documentation and usage information for the workflow. If not specified,
	// the README.md file from the root directory of the repository will be used.
	ReadmePath *string

	// The S3 URI of the README file for the workflow. This file provides
	// documentation and usage information for the workflow. Requirements include:
	//
	//   - The S3 URI must begin with s3://USER-OWNED-BUCKET/
	//
	//   - The requester must have access to the S3 bucket and object.
	//
	//   - The max README content length is 500 KiB.
	ReadmeUri *string

	// The default static storage capacity (in gibibytes) for runs that use this
	// workflow or workflow version. The storageCapacity can be overwritten at run
	// time. The storage capacity is not required for runs with a DYNAMIC storage type.
	StorageCapacity *int32

	// The default storage type for runs that use this workflow. The storageType can
	// be overridden at run time. DYNAMIC storage dynamically scales the storage up or
	// down, based on file system utilization. STATIC storage allocates a fixed amount
	// of storage. For more information about dynamic and static storage types, see [Run storage types]in
	// the Amazon Web Services HealthOmics User Guide.
	//
	// [Run storage types]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
	StorageType types.StorageType

	// Tags for the workflow. You can define up to 50 tags for the workflow. For more
	// information, see [Adding a tag]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Adding a tag]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
	Tags map[string]string

	// The Amazon Web Services account ID of the expected owner of the S3 bucket that
	// contains the workflow definition. If not specified, the service skips the
	// validation.
	WorkflowBucketOwnerId *string
	// contains filtered or unexported fields
}

type CreateWorkflowOutput 

type CreateWorkflowOutput struct {

	// The workflow's ARN.
	Arn *string

	// The workflow's ID.
	Id *string

	// The workflow's status.
	Status types.WorkflowStatus

	// The workflow's tags.
	Tags map[string]string

	// The universally unique identifier (UUID) value for this workflow.
	Uuid *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkflowVersionInput added in v1.30.0 

type CreateWorkflowVersionInput struct {

	// An idempotency token to ensure that duplicate workflows are not created when
	// Amazon Web Services HealthOmics submits retry requests.
	//
	// This member is required.
	RequestId *string

	// A name for the workflow version. Provide a version name that is unique for this
	// workflow. You cannot change the name after HealthOmics creates the version.
	//
	// The version name must start with a letter or number and it can include
	// upper-case and lower-case letters, numbers, hyphens, periods and underscores.
	// The maximum length is 64 characters. You can use a simple naming scheme, such as
	// version1, version2, version3. You can also match your workflow versions with
	// your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.
	//
	// This member is required.
	VersionName *string

	// The ID of the workflow where you are creating the new version. The workflowId
	// is not the UUID.
	//
	// This member is required.
	WorkflowId *string

	// The computational accelerator for this workflow version.
	Accelerators types.Accelerators

	// (Optional) Use a container registry map to specify mappings between the ECR
	// private repository and one or more upstream registries. For more information,
	// see [Container images]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Container images]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
	ContainerRegistryMap *types.ContainerRegistryMap

	// (Optional) URI of the S3 location for the registry mapping file.
	ContainerRegistryMapUri *string

	// The repository information for the workflow version definition. This allows you
	// to source your workflow version definition directly from a code repository.
	DefinitionRepository *types.DefinitionRepository

	// The S3 URI of a definition for this workflow version. The S3 bucket must be in
	// the same region as this workflow version.
	DefinitionUri *string

	// A ZIP archive containing the main workflow definition file and dependencies
	// that it imports for this workflow version. You can use a file with a ://fileb
	// prefix instead of the Base64 string. For more information, see Workflow
	// definition requirements in the Amazon Web Services HealthOmics User Guide.
	DefinitionZip []byte

	// A description for this workflow version.
	Description *string

	// The workflow engine for this workflow version. This is only required if you
	// have workflow definition files from more than one engine in your zip file.
	// Otherwise, the service can detect the engine automatically from your workflow
	// definition.
	Engine types.WorkflowEngine

	// The path of the main definition file for this workflow version. This parameter
	// is not required if the ZIP archive contains only one workflow definition file,
	// or if the main definition file is named “main”. An example path is:
	// workflow-definition/main-file.wdl .
	Main *string

	// A parameter template for this workflow version. If this field is blank, Amazon
	// Web Services HealthOmics will automatically parse the parameter template values
	// from your workflow definition file. To override these service generated default
	// values, provide a parameter template. To view an example of a parameter
	// template, see [Parameter template files]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Parameter template files]: https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html
	ParameterTemplate map[string]types.WorkflowParameter

	// The path to the workflow version parameter template JSON file within the
	// repository. This file defines the input parameters for runs that use this
	// workflow version. If not specified, the workflow version will be created without
	// a parameter template.
	ParameterTemplatePath *string

	// The markdown content for the workflow version's README file. This provides
	// documentation and usage information for users of this specific workflow version.
	//
	// This value conforms to the media type: text/markdown
	ReadmeMarkdown *string

	// The path to the workflow version README markdown file within the repository.
	// This file provides documentation and usage information for the workflow. If not
	// specified, the README.md file from the root directory of the repository will be
	// used.
	ReadmePath *string

	// The S3 URI of the README file for the workflow version. This file provides
	// documentation and usage information for the workflow version. Requirements
	// include:
	//
	//   - The S3 URI must begin with s3://USER-OWNED-BUCKET/
	//
	//   - The requester must have access to the S3 bucket and object.
	//
	//   - The max README content length is 500 KiB.
	ReadmeUri *string

	// The default static storage capacity (in gibibytes) for runs that use this
	// workflow version. The storageCapacity can be overwritten at run time. The
	// storage capacity is not required for runs with a DYNAMIC storage type.
	StorageCapacity *int32

	// The default storage type for runs that use this workflow version. The
	// storageType can be overridden at run time. DYNAMIC storage dynamically scales
	// the storage up or down, based on file system utilization. STATIC storage
	// allocates a fixed amount of storage. For more information about dynamic and
	// static storage types, see [Run storage types]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Run storage types]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
	StorageType types.StorageType

	// Tags for this workflow version. You can define up to 50 tags for the workflow.
	// For more information, see [Adding a tag]in the Amazon Web Services HealthOmics User Guide.
	//
	// [Adding a tag]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
	Tags map[string]string

	// Amazon Web Services Id of the owner of the S3 bucket that contains the workflow
	// definition. You need to specify this parameter if your account is not the bucket
	// owner.
	WorkflowBucketOwnerId *string
	// contains filtered or unexported fields
}

type CreateWorkflowVersionOutput added in v1.30.0 

type CreateWorkflowVersionOutput struct {

	// ARN of the workflow version.
	Arn *string

	// The workflow version status.
	Status types.WorkflowStatus

	// The workflow version's tags.
	Tags map[string]string

	// The universally unique identifier (UUID) value for this workflow version.
	Uuid *string

	// The workflow version name.
	VersionName *string

	// The workflow's ID.
	WorkflowId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAnnotationStoreInput 

type DeleteAnnotationStoreInput struct {

	// The store's name.
	//
	// This member is required.
	Name *string

	// Whether to force deletion.
	Force bool
	// contains filtered or unexported fields
}

type DeleteAnnotationStoreOutput 

type DeleteAnnotationStoreOutput struct {

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAnnotationStoreVersionsInput added in v1.8.0 

type DeleteAnnotationStoreVersionsInput struct {

	//  The name of the annotation store from which versions are being deleted.
	//
	// This member is required.
	Name *string

	//  The versions of an annotation store to be deleted.
	//
	// This member is required.
	Versions []string

	//  Forces the deletion of an annotation store version when imports are
	// in-progress..
	Force bool
	// contains filtered or unexported fields
}

type DeleteAnnotationStoreVersionsOutput added in v1.8.0 

type DeleteAnnotationStoreVersionsOutput struct {

	//  Any errors that occur when attempting to delete an annotation store version.
	Errors []types.VersionDeleteError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteReferenceInput 

type DeleteReferenceInput struct {

	// The reference's ID.
	//
	// This member is required.
	Id *string

	// The reference's store ID.
	//
	// This member is required.
	ReferenceStoreId *string
	// contains filtered or unexported fields
}

type DeleteReferenceOutput 

type DeleteReferenceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteReferenceStoreInput 

type DeleteReferenceStoreInput struct {

	// The store's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteReferenceStoreOutput 

type DeleteReferenceStoreOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRunCacheInput added in v1.27.0 

type DeleteRunCacheInput struct {

	// Run cache identifier for the cache you want to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteRunCacheOutput added in v1.27.0 

type DeleteRunCacheOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRunGroupInput 

type DeleteRunGroupInput struct {

	// The run group's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteRunGroupOutput 

type DeleteRunGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRunInput 

type DeleteRunInput struct {

	// The run's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteRunOutput 

type DeleteRunOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteS3AccessPolicyInput added in v1.28.0 

type DeleteS3AccessPolicyInput struct {

	// The S3 access point ARN that has the access policy.
	//
	// This member is required.
	S3AccessPointArn *string
	// contains filtered or unexported fields
}

type DeleteS3AccessPolicyOutput added in v1.28.0 

type DeleteS3AccessPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSequenceStoreInput 

type DeleteSequenceStoreInput struct {

	// The sequence store's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteSequenceStoreOutput 

type DeleteSequenceStoreOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteShareInput added in v1.8.0 

type DeleteShareInput struct {

	// The ID for the resource share to be deleted.
	//
	// This member is required.
	ShareId *string
	// contains filtered or unexported fields
}

type DeleteShareOutput added in v1.8.0 

type DeleteShareOutput struct {

	// The status of the share being deleted.
	Status types.ShareStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVariantStoreInput 

type DeleteVariantStoreInput struct {

	// The store's name.
	//
	// This member is required.
	Name *string

	// Whether to force deletion.
	Force bool
	// contains filtered or unexported fields
}

type DeleteVariantStoreOutput 

type DeleteVariantStoreOutput struct {

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkflowInput 

type DeleteWorkflowInput struct {

	// The workflow's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteWorkflowOutput 

type DeleteWorkflowOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkflowVersionInput added in v1.30.0 

type DeleteWorkflowVersionInput struct {

	// The workflow version name.
	//
	// This member is required.
	VersionName *string

	// The workflow's ID.
	//
	// This member is required.
	WorkflowId *string
	// contains filtered or unexported fields
}

type DeleteWorkflowVersionOutput added in v1.30.0 

type DeleteWorkflowVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.6.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.6.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.6.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.6.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.6.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAnnotationImportJobAPIClient 

type GetAnnotationImportJobAPIClient interface {
	GetAnnotationImportJob(context.Context, *GetAnnotationImportJobInput, ...func(*Options)) (*GetAnnotationImportJobOutput, error)
}

GetAnnotationImportJobAPIClient is a client that implements the GetAnnotationImportJob operation.

type GetAnnotationImportJobInput 

type GetAnnotationImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetAnnotationImportJobOutput 

type GetAnnotationImportJobOutput struct {

	// When the job completed.
	//
	// This member is required.
	CompletionTime *time.Time

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination annotation store.
	//
	// This member is required.
	DestinationName *string

	// Formatting options for a file.
	//
	// This member is required.
	FormatOptions types.FormatOptions

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's imported items.
	//
	// This member is required.
	Items []types.AnnotationImportItemDetail

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's left normalization setting.
	//
	// This member is required.
	RunLeftNormalization bool

	// The job's status.
	//
	// This member is required.
	Status types.JobStatus

	// The job's status message.
	//
	// This member is required.
	StatusMessage *string

	// When the job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The name of the annotation store version.
	//
	// This member is required.
	VersionName *string

	// The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAnnotationStoreAPIClient 

type GetAnnotationStoreAPIClient interface {
	GetAnnotationStore(context.Context, *GetAnnotationStoreInput, ...func(*Options)) (*GetAnnotationStoreOutput, error)
}

GetAnnotationStoreAPIClient is a client that implements the GetAnnotationStore operation.

type GetAnnotationStoreInput 

type GetAnnotationStoreInput struct {

	// The store's name.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetAnnotationStoreOutput 

type GetAnnotationStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	//  An integer indicating how many versions of an annotation store exist.
	//
	// This member is required.
	NumVersions *int32

	// The store's genome reference.
	//
	// This member is required.
	Reference types.ReferenceItem

	// The store's server-side encryption (SSE) settings.
	//
	// This member is required.
	SseConfig *types.SseConfig

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// A status message.
	//
	// This member is required.
	StatusMessage *string

	// The store's ARN.
	//
	// This member is required.
	StoreArn *string

	// The store's size in bytes.
	//
	// This member is required.
	StoreSizeBytes *int64

	// The store's tags.
	//
	// This member is required.
	Tags map[string]string

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The store's annotation file format.
	StoreFormat types.StoreFormat

	// The store's parsing options.
	StoreOptions types.StoreOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAnnotationStoreVersionAPIClient added in v1.8.0 

type GetAnnotationStoreVersionAPIClient interface {
	GetAnnotationStoreVersion(context.Context, *GetAnnotationStoreVersionInput, ...func(*Options)) (*GetAnnotationStoreVersionOutput, error)
}

GetAnnotationStoreVersionAPIClient is a client that implements the GetAnnotationStoreVersion operation.

type GetAnnotationStoreVersionInput added in v1.8.0 

type GetAnnotationStoreVersionInput struct {

	//  The name given to an annotation store version to distinguish it from others.
	//
	// This member is required.
	Name *string

	//  The name given to an annotation store version to distinguish it from others.
	//
	// This member is required.
	VersionName *string
	// contains filtered or unexported fields
}

type GetAnnotationStoreVersionOutput added in v1.8.0 

type GetAnnotationStoreVersionOutput struct {

	//  The time stamp for when an annotation store version was created.
	//
	// This member is required.
	CreationTime *time.Time

	//  The description for an annotation store version.
	//
	// This member is required.
	Description *string

	//  The annotation store version ID.
	//
	// This member is required.
	Id *string

	//  The name of the annotation store.
	//
	// This member is required.
	Name *string

	//  The status of an annotation store version.
	//
	// This member is required.
	Status types.VersionStatus

	//  The status of an annotation store version.
	//
	// This member is required.
	StatusMessage *string

	//  The store ID for annotation store version.
	//
	// This member is required.
	StoreId *string

	//  Any tags associated with an annotation store version.
	//
	// This member is required.
	Tags map[string]string

	//  The time stamp for when an annotation store version was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The Arn for the annotation store.
	//
	// This member is required.
	VersionArn *string

	//  The name given to an annotation store version to distinguish it from others.
	//
	// This member is required.
	VersionName *string

	//  The size of the annotation store version in Bytes.
	//
	// This member is required.
	VersionSizeBytes *int64

	//  The options for an annotation store version.
	VersionOptions types.VersionOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadSetActivationJobAPIClient 

type GetReadSetActivationJobAPIClient interface {
	GetReadSetActivationJob(context.Context, *GetReadSetActivationJobInput, ...func(*Options)) (*GetReadSetActivationJobOutput, error)
}

GetReadSetActivationJobAPIClient is a client that implements the GetReadSetActivationJob operation.

type GetReadSetActivationJobInput 

type GetReadSetActivationJobInput struct {

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string
	// contains filtered or unexported fields
}

type GetReadSetActivationJobOutput 

type GetReadSetActivationJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetActivationJobStatus

	// When the job completed.
	CompletionTime *time.Time

	// The job's source files.
	Sources []types.ActivateReadSetSourceItem

	// The job's status message.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadSetExportJobAPIClient 

type GetReadSetExportJobAPIClient interface {
	GetReadSetExportJob(context.Context, *GetReadSetExportJobInput, ...func(*Options)) (*GetReadSetExportJobOutput, error)
}

GetReadSetExportJobAPIClient is a client that implements the GetReadSetExportJob operation.

type GetReadSetExportJobInput 

type GetReadSetExportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string
	// contains filtered or unexported fields
}

type GetReadSetExportJobOutput 

type GetReadSetExportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination in Amazon S3.
	//
	// This member is required.
	Destination *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetExportJobStatus

	// When the job completed.
	CompletionTime *time.Time

	// The job's read sets.
	ReadSets []types.ExportReadSetDetail

	// The job's status message.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadSetImportJobAPIClient 

type GetReadSetImportJobAPIClient interface {
	GetReadSetImportJob(context.Context, *GetReadSetImportJobInput, ...func(*Options)) (*GetReadSetImportJobOutput, error)
}

GetReadSetImportJobAPIClient is a client that implements the GetReadSetImportJob operation.

type GetReadSetImportJobInput 

type GetReadSetImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string
	// contains filtered or unexported fields
}

type GetReadSetImportJobOutput 

type GetReadSetImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.ImportReadSetSourceItem

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetImportJobStatus

	// When the job completed.
	CompletionTime *time.Time

	// The job's status message.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadSetInput 

type GetReadSetInput struct {

	// The read set's ID.
	//
	// This member is required.
	Id *string

	// The part number to retrieve.
	//
	// This member is required.
	PartNumber *int32

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The file to retrieve.
	File types.ReadSetFile
	// contains filtered or unexported fields
}

type GetReadSetMetadataInput 

type GetReadSetMetadataInput struct {

	// The read set's ID.
	//
	// This member is required.
	Id *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string
	// contains filtered or unexported fields
}

type GetReadSetMetadataOutput 

type GetReadSetMetadataOutput struct {

	// The read set's ARN.
	//
	// This member is required.
	Arn *string

	// When the read set was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The read set's file type.
	//
	// This member is required.
	FileType types.FileType

	// The read set's ID.
	//
	// This member is required.
	Id *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The read set's status.
	//
	// This member is required.
	Status types.ReadSetStatus

	// The read set's creation job ID.
	CreationJobId *string

	//  The creation type of the read set.
	CreationType types.CreationType

	// The read set's description.
	Description *string

	// The entity tag (ETag) is a hash of the object meant to represent its semantic
	// content.
	Etag *types.ETag

	// The read set's files.
	Files *types.ReadSetFiles

	// The read set's name.
	Name *string

	// The read set's genome reference ARN.
	ReferenceArn *string

	// The read set's sample ID.
	SampleId *string

	// The read set's sequence information.
	SequenceInformation *types.SequenceInformation

	// The status message for a read set. It provides more detail as to why the read
	// set has a status.
	StatusMessage *string

	// The read set's subject ID.
	SubjectId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReadSetOutput 

type GetReadSetOutput struct {

	// The read set file payload.
	Payload io.ReadCloser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReferenceImportJobAPIClient 

type GetReferenceImportJobAPIClient interface {
	GetReferenceImportJob(context.Context, *GetReferenceImportJobInput, ...func(*Options)) (*GetReferenceImportJobOutput, error)
}

GetReferenceImportJobAPIClient is a client that implements the GetReferenceImportJob operation.

type GetReferenceImportJobInput 

type GetReferenceImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string
	// contains filtered or unexported fields
}

type GetReferenceImportJobOutput 

type GetReferenceImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.ImportReferenceSourceItem

	// The job's status.
	//
	// This member is required.
	Status types.ReferenceImportJobStatus

	// When the job completed.
	CompletionTime *time.Time

	// The job's status message.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReferenceInput 

type GetReferenceInput struct {

	// The reference's ID.
	//
	// This member is required.
	Id *string

	// The part number to retrieve.
	//
	// This member is required.
	PartNumber *int32

	// The reference's store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// The file to retrieve.
	File types.ReferenceFile

	// The range to retrieve.
	Range *string
	// contains filtered or unexported fields
}

type GetReferenceMetadataInput 

type GetReferenceMetadataInput struct {

	// The reference's ID.
	//
	// This member is required.
	Id *string

	// The reference's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string
	// contains filtered or unexported fields
}

type GetReferenceMetadataOutput 

type GetReferenceMetadataOutput struct {

	// The reference's ARN.
	//
	// This member is required.
	Arn *string

	// When the reference was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The reference's ID.
	//
	// This member is required.
	Id *string

	// The reference's MD5 checksum.
	//
	// This member is required.
	Md5 *string

	// The reference's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// When the reference was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The reference's creation job ID.
	CreationJobId *string

	// The reference's creation type.
	CreationType types.ReferenceCreationType

	// The reference's description.
	Description *string

	// The reference's files.
	Files *types.ReferenceFiles

	// The reference's name.
	Name *string

	// The reference's status.
	Status types.ReferenceStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReferenceOutput 

type GetReferenceOutput struct {

	// The reference file payload.
	Payload io.ReadCloser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReferenceStoreInput 

type GetReferenceStoreInput struct {

	// The store's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetReferenceStoreOutput 

type GetReferenceStoreOutput struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The store's name.
	Name *string

	// The store's server-side encryption (SSE) settings.
	SseConfig *types.SseConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRunAPIClient 

type GetRunAPIClient interface {
	GetRun(context.Context, *GetRunInput, ...func(*Options)) (*GetRunOutput, error)
}

GetRunAPIClient is a client that implements the GetRun operation.

type GetRunCacheInput added in v1.27.0 

type GetRunCacheInput struct {

	// The identifier of the run cache to retrieve.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetRunCacheOutput added in v1.27.0 

type GetRunCacheOutput struct {

	// Unique resource identifier for the run cache.
	Arn *string

	// The default cache behavior for runs using this cache.
	CacheBehavior types.CacheBehavior

	// The identifier of the bucket owner.
	CacheBucketOwnerId *string

	// The S3 URI where the cache data is stored.
	CacheS3Uri *string

	// Creation time of the run cache (an ISO 8601 formatted string).
	CreationTime *time.Time

	// The run cache description.
	Description *string

	// The run cache ID.
	Id *string

	// The run cache name.
	Name *string

	// The run cache status.
	Status types.RunCacheStatus

	// The tags associated with the run cache.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRunGroupInput 

type GetRunGroupInput struct {

	// The group's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetRunGroupOutput 

type GetRunGroupOutput struct {

	// The group's ARN.
	Arn *string

	// When the group was created.
	CreationTime *time.Time

	// The group's ID.
	Id *string

	// The group's maximum number of CPUs to use.
	MaxCpus *int32

	// The group's maximum run time in minutes.
	MaxDuration *int32

	// The maximum GPUs that can be used by a run group.
	MaxGpus *int32

	// The maximum number of concurrent runs for the group.
	MaxRuns *int32

	// The group's name.
	Name *string

	// The group's tags.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRunInput 

type GetRunInput struct {

	// The run's ID.
	//
	// This member is required.
	Id *string

	// The run's export format.
	Export []types.RunExport
	// contains filtered or unexported fields
}

type GetRunOutput 

type GetRunOutput struct {

	// The computational accelerator used to run the workflow.
	Accelerators types.Accelerators

	// The run's ARN.
	Arn *string

	// The run cache behavior for the run.
	CacheBehavior types.CacheBehavior

	// The run cache associated with the run.
	CacheId *string

	// When the run was created.
	CreationTime *time.Time

	// The run's definition.
	Definition *string

	// The run's digest.
	Digest *string

	// The actual Nextflow engine version that Amazon Web Services HealthOmics used
	// for the run. The other workflow definition languages don't provide a value for
	// this field.
	EngineVersion *string

	// The reason a run has failed.
	FailureReason *string

	// The run's ID.
	Id *string

	// The run's log level.
	LogLevel types.RunLogLevel

	// The location of the run log.
	LogLocation *types.RunLogLocation

	// The run's name.
	Name *string

	// The run's output URI.
	OutputUri *string

	// The run's parameters.
	Parameters document.Interface

	// The run's priority.
	Priority *int32

	// The run's resource digests.
	ResourceDigests map[string]string

	// The run's retention mode.
	RetentionMode types.RunRetentionMode

	// The run's service role ARN.
	RoleArn *string

	// The run's group ID.
	RunGroupId *string

	// The run's ID.
	RunId *string

	// The destination for workflow outputs.
	RunOutputUri *string

	// When the run started.
	StartTime *time.Time

	// Who started the run.
	StartedBy *string

	// The run's status.
	Status types.RunStatus

	// The run's status message.
	StatusMessage *string

	// The run's stop time.
	StopTime *time.Time

	// The run's storage capacity in gibibytes. For dynamic storage, after the run has
	// completed, this value is the maximum amount of storage used during the run.
	StorageCapacity *int32

	// The run's storage type.
	StorageType types.StorageType

	// The run's tags.
	Tags map[string]string

	// The universally unique identifier for a run.
	Uuid *string

	// The run's workflow ID.
	WorkflowId *string

	// The ID of the workflow owner.
	WorkflowOwnerId *string

	// The run's workflow type.
	WorkflowType types.WorkflowType

	// The universally unique identifier (UUID) value for the workflow.
	WorkflowUuid *string

	// The workflow version name.
	WorkflowVersionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRunTaskAPIClient 

type GetRunTaskAPIClient interface {
	GetRunTask(context.Context, *GetRunTaskInput, ...func(*Options)) (*GetRunTaskOutput, error)
}

GetRunTaskAPIClient is a client that implements the GetRunTask operation.

type GetRunTaskInput 

type GetRunTaskInput struct {

	// The workflow run ID.
	//
	// This member is required.
	Id *string

	// The task's ID.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type GetRunTaskOutput 

type GetRunTaskOutput struct {

	// Set to true if Amazon Web Services HealthOmics found a matching entry in the
	// run cache for this task.
	CacheHit *bool

	// The S3 URI of the cache location.
	CacheS3Uri *string

	// The task's CPU usage.
	Cpus *int32

	// When the task was created.
	CreationTime *time.Time

	// The reason a task has failed.
	FailureReason *string

	// The number of Graphics Processing Units (GPU) specified in the task.
	Gpus *int32

	// Details about the container image that this task uses.
	ImageDetails *types.ImageDetails

	// The instance type for a task.
	InstanceType *string

	// The task's log stream.
	LogStream *string

	// The task's memory use in gigabytes.
	Memory *int32

	// The task's name.
	Name *string

	// The task's start time.
	StartTime *time.Time

	// The task's status.
	Status types.TaskStatus

	// The task's status message.
	StatusMessage *string

	// The task's stop time.
	StopTime *time.Time

	// The task's ID.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetS3AccessPolicyInput added in v1.28.0 

type GetS3AccessPolicyInput struct {

	// The S3 access point ARN that has the access policy.
	//
	// This member is required.
	S3AccessPointArn *string
	// contains filtered or unexported fields
}

type GetS3AccessPolicyOutput added in v1.28.0 

type GetS3AccessPolicyOutput struct {

	// The current resource policy that controls S3 access on the store.
	//
	// This value conforms to the media type: application/json
	//
	// This member is required.
	S3AccessPolicy *string

	// The S3 access point ARN that has the access policy.
	S3AccessPointArn *string

	// The Amazon Web Services-generated Sequence Store or Reference Store ID.
	StoreId *string

	// The type of store associated with the access point.
	StoreType types.StoreType

	// The time when the policy was last updated.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSequenceStoreInput 

type GetSequenceStoreInput struct {

	// The store's ID.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetSequenceStoreOutput 

type GetSequenceStoreOutput struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The algorithm family of the ETag.
	ETagAlgorithmFamily types.ETagAlgorithmFamily

	// An S3 location that is used to store files that have failed a direct upload.
	FallbackLocation *string

	// The store's name.
	Name *string

	// The tags keys to propagate to the S3 objects associated with read sets in the
	// sequence store.
	PropagatedSetLevelTags []string

	// The S3 metadata of a sequence store, including the ARN and S3 URI of the S3
	// bucket.
	S3Access *types.SequenceStoreS3Access

	// The store's server-side encryption (SSE) settings.
	SseConfig *types.SseConfig

	// The status of the sequence store.
	Status types.SequenceStoreStatus

	// The status message of the sequence store.
	StatusMessage *string

	// The last-updated time of the sequence store.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetShareInput added in v1.8.0 

type GetShareInput struct {

	// The ID of the share.
	//
	// This member is required.
	ShareId *string
	// contains filtered or unexported fields
}

type GetShareOutput added in v1.8.0 

type GetShareOutput struct {

	// A resource share details object. The object includes the status, the
	// resourceArn, and ownerId.
	Share *types.ShareDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVariantImportJobAPIClient 

type GetVariantImportJobAPIClient interface {
	GetVariantImportJob(context.Context, *GetVariantImportJobInput, ...func(*Options)) (*GetVariantImportJobOutput, error)
}

GetVariantImportJobAPIClient is a client that implements the GetVariantImportJob operation.

type GetVariantImportJobInput 

type GetVariantImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetVariantImportJobOutput 

type GetVariantImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination variant store.
	//
	// This member is required.
	DestinationName *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's items.
	//
	// This member is required.
	Items []types.VariantImportItemDetail

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's left normalization setting.
	//
	// This member is required.
	RunLeftNormalization bool

	// The job's status.
	//
	// This member is required.
	Status types.JobStatus

	// The job's status message.
	//
	// This member is required.
	StatusMessage *string

	// When the job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// When the job completed.
	CompletionTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVariantStoreAPIClient 

type GetVariantStoreAPIClient interface {
	GetVariantStore(context.Context, *GetVariantStoreInput, ...func(*Options)) (*GetVariantStoreOutput, error)
}

GetVariantStoreAPIClient is a client that implements the GetVariantStore operation.

type GetVariantStoreInput 

type GetVariantStoreInput struct {

	// The store's name.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetVariantStoreOutput 

type GetVariantStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's genome reference.
	//
	// This member is required.
	Reference types.ReferenceItem

	// The store's server-side encryption (SSE) settings.
	//
	// This member is required.
	SseConfig *types.SseConfig

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// The store's status message.
	//
	// This member is required.
	StatusMessage *string

	// The store's ARN.
	//
	// This member is required.
	StoreArn *string

	// The store's size in bytes.
	//
	// This member is required.
	StoreSizeBytes *int64

	// The store's tags.
	//
	// This member is required.
	Tags map[string]string

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowAPIClient 

type GetWorkflowAPIClient interface {
	GetWorkflow(context.Context, *GetWorkflowInput, ...func(*Options)) (*GetWorkflowOutput, error)
}

GetWorkflowAPIClient is a client that implements the GetWorkflow operation.

type GetWorkflowInput 

type GetWorkflowInput struct {

	// The workflow's ID.
	//
	// This member is required.
	Id *string

	// The export format for the workflow.
	Export []types.WorkflowExport

	// The workflow's type.
	Type types.WorkflowType

	// The ID of the workflow owner.
	WorkflowOwnerId *string
	// contains filtered or unexported fields
}

type GetWorkflowOutput 

type GetWorkflowOutput struct {

	// The computational accelerator specified to run the workflow.
	Accelerators types.Accelerators

	// The workflow's ARN.
	Arn *string

	// The registry map that this workflow is using.
	ContainerRegistryMap *types.ContainerRegistryMap

	// When the workflow was created.
	CreationTime *time.Time

	// The workflow's definition.
	Definition *string

	// Details about the source code repository that hosts the workflow definition
	// files.
	DefinitionRepositoryDetails *types.DefinitionRepositoryDetails

	// The workflow's description.
	Description *string

	// The workflow's digest.
	Digest *string

	// The workflow's engine.
	Engine types.WorkflowEngine

	// The workflow's ID.
	Id *string

	// The path of the main definition file for the workflow.
	Main *string

	// Gets metadata for the workflow.
	Metadata map[string]string

	// The workflow's name.
	Name *string

	// The workflow's parameter template.
	ParameterTemplate map[string]types.WorkflowParameter

	// The README content for the workflow, providing documentation and usage
	// information.
	Readme *string

	// The path to the workflow README markdown file within the repository. This file
	// provides documentation and usage information for the workflow. If not specified,
	// the README.md file from the root directory of the repository will be used.
	ReadmePath *string

	// The workflow's status.
	Status types.WorkflowStatus

	// The workflow's status message.
	StatusMessage *string

	// The default static storage capacity (in gibibytes) for runs that use this
	// workflow or workflow version.
	StorageCapacity *int32

	// The default storage type for runs using this workflow.
	StorageType types.StorageType

	// The workflow's tags.
	Tags map[string]string

	// The workflow's type.
	Type types.WorkflowType

	// The universally unique identifier (UUID) value for this workflow.
	Uuid *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkflowVersionAPIClient added in v1.30.0 

type GetWorkflowVersionAPIClient interface {
	GetWorkflowVersion(context.Context, *GetWorkflowVersionInput, ...func(*Options)) (*GetWorkflowVersionOutput, error)
}

GetWorkflowVersionAPIClient is a client that implements the GetWorkflowVersion operation.

type GetWorkflowVersionInput added in v1.30.0 

type GetWorkflowVersionInput struct {

	// The workflow version name.
	//
	// This member is required.
	VersionName *string

	// The workflow's ID. The workflowId is not the UUID.
	//
	// This member is required.
	WorkflowId *string

	// The export format for the workflow.
	Export []types.WorkflowExport

	// The workflow's type.
	Type types.WorkflowType

	// The 12-digit account ID of the workflow owner. The workflow owner ID can be
	// retrieved using the GetShare API operation. If you are the workflow owner, you
	// do not need to include this ID.
	WorkflowOwnerId *string
	// contains filtered or unexported fields
}

type GetWorkflowVersionOutput added in v1.30.0 

type GetWorkflowVersionOutput struct {

	// The accelerator for this workflow version.
	Accelerators types.Accelerators

	// ARN of the workflow version.
	Arn *string

	// The registry map that this workflow version uses.
	ContainerRegistryMap *types.ContainerRegistryMap

	// When the workflow version was created.
	CreationTime *time.Time

	// Definition of the workflow version.
	Definition *string

	// Details about the source code repository that hosts the workflow version
	// definition files.
	DefinitionRepositoryDetails *types.DefinitionRepositoryDetails

	// Description of the workflow version.
	Description *string

	// The workflow version's digest.
	Digest *string

	// The workflow engine for this workflow version.
	Engine types.WorkflowEngine

	// The path of the main definition file for the workflow.
	Main *string

	// The metadata for the workflow version.
	Metadata map[string]string

	// The parameter template for the workflow version.
	ParameterTemplate map[string]types.WorkflowParameter

	// The README content for the workflow version, providing documentation and usage
	// information specific to this version.
	Readme *string

	// The path to the workflow version README markdown file within the repository.
	// This file provides documentation and usage information for the workflow. If not
	// specified, the README.md file from the root directory of the repository will be
	// used.
	ReadmePath *string

	// The workflow version status
	Status types.WorkflowStatus

	// The workflow version status message
	StatusMessage *string

	// The default run storage capacity for static storage.
	StorageCapacity *int32

	// The default storage type for the run.
	StorageType types.StorageType

	// The workflow version tags
	Tags map[string]string

	// The workflow version type
	Type types.WorkflowType

	// The universally unique identifier (UUID) value for this workflow version
	Uuid *string

	// The workflow version name.
	VersionName *string

	// Amazon Web Services Id of the owner of the bucket.
	WorkflowBucketOwnerId *string

	// The workflow's ID.
	WorkflowId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAnnotationImportJobsAPIClient 

type ListAnnotationImportJobsAPIClient interface {
	ListAnnotationImportJobs(context.Context, *ListAnnotationImportJobsInput, ...func(*Options)) (*ListAnnotationImportJobsOutput, error)
}

ListAnnotationImportJobsAPIClient is a client that implements the ListAnnotationImportJobs operation.

type ListAnnotationImportJobsInput 

type ListAnnotationImportJobsInput struct {

	// A filter to apply to the list.
	Filter *types.ListAnnotationImportJobsFilter

	// IDs of annotation import jobs to retrieve.
	Ids []string

	// The maximum number of jobs to return in one page of results.
	MaxResults *int32

	// Specifies the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnnotationImportJobsOutput 

type ListAnnotationImportJobsOutput struct {

	// A list of jobs.
	AnnotationImportJobs []types.AnnotationImportJobItem

	// Specifies the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAnnotationImportJobsPaginator 

type ListAnnotationImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListAnnotationImportJobsPaginator is a paginator for ListAnnotationImportJobs

func NewListAnnotationImportJobsPaginator 

func NewListAnnotationImportJobsPaginator(client ListAnnotationImportJobsAPIClient, params *ListAnnotationImportJobsInput, optFns ...func(*ListAnnotationImportJobsPaginatorOptions)) *ListAnnotationImportJobsPaginator

NewListAnnotationImportJobsPaginator returns a new ListAnnotationImportJobsPaginator

func (*ListAnnotationImportJobsPaginator) HasMorePages 

func (p *ListAnnotationImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnnotationImportJobsPaginator) NextPage 

func (p *ListAnnotationImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnnotationImportJobsOutput, error)

NextPage retrieves the next ListAnnotationImportJobs page.

type ListAnnotationImportJobsPaginatorOptions 

type ListAnnotationImportJobsPaginatorOptions struct {
	// The maximum number of jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAnnotationImportJobsPaginatorOptions is the paginator options for ListAnnotationImportJobs

type ListAnnotationStoreVersionsAPIClient added in v1.8.0 

type ListAnnotationStoreVersionsAPIClient interface {
	ListAnnotationStoreVersions(context.Context, *ListAnnotationStoreVersionsInput, ...func(*Options)) (*ListAnnotationStoreVersionsOutput, error)
}

ListAnnotationStoreVersionsAPIClient is a client that implements the ListAnnotationStoreVersions operation.

type ListAnnotationStoreVersionsInput added in v1.8.0 

type ListAnnotationStoreVersionsInput struct {

	//  The name of an annotation store.
	//
	// This member is required.
	Name *string

	//  A filter to apply to the list of annotation store versions.
	Filter *types.ListAnnotationStoreVersionsFilter

	//  The maximum number of annotation store versions to return in one page of
	// results.
	MaxResults *int32

	//  Specifies the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnnotationStoreVersionsOutput added in v1.8.0 

type ListAnnotationStoreVersionsOutput struct {

	//  Lists all versions of an annotation store.
	AnnotationStoreVersions []types.AnnotationStoreVersionItem

	//  Specifies the pagination token from a previous request to retrieve the next
	// page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAnnotationStoreVersionsPaginator added in v1.8.0 

type ListAnnotationStoreVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListAnnotationStoreVersionsPaginator is a paginator for ListAnnotationStoreVersions

func NewListAnnotationStoreVersionsPaginator added in v1.8.0 

func NewListAnnotationStoreVersionsPaginator(client ListAnnotationStoreVersionsAPIClient, params *ListAnnotationStoreVersionsInput, optFns ...func(*ListAnnotationStoreVersionsPaginatorOptions)) *ListAnnotationStoreVersionsPaginator

NewListAnnotationStoreVersionsPaginator returns a new ListAnnotationStoreVersionsPaginator

func (*ListAnnotationStoreVersionsPaginator) HasMorePages added in v1.8.0 

func (p *ListAnnotationStoreVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnnotationStoreVersionsPaginator) NextPage added in v1.8.0 

func (p *ListAnnotationStoreVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnnotationStoreVersionsOutput, error)

NextPage retrieves the next ListAnnotationStoreVersions page.

type ListAnnotationStoreVersionsPaginatorOptions added in v1.8.0 

type ListAnnotationStoreVersionsPaginatorOptions struct {
	//  The maximum number of annotation store versions to return in one page of
	// results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAnnotationStoreVersionsPaginatorOptions is the paginator options for ListAnnotationStoreVersions

type ListAnnotationStoresAPIClient 

type ListAnnotationStoresAPIClient interface {
	ListAnnotationStores(context.Context, *ListAnnotationStoresInput, ...func(*Options)) (*ListAnnotationStoresOutput, error)
}

ListAnnotationStoresAPIClient is a client that implements the ListAnnotationStores operation.

type ListAnnotationStoresInput 

type ListAnnotationStoresInput struct {

	// A filter to apply to the list.
	Filter *types.ListAnnotationStoresFilter

	// IDs of stores to list.
	Ids []string

	// The maximum number of stores to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnnotationStoresOutput 

type ListAnnotationStoresOutput struct {

	// A list of stores.
	AnnotationStores []types.AnnotationStoreItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAnnotationStoresPaginator 

type ListAnnotationStoresPaginator struct {
	// contains filtered or unexported fields
}

ListAnnotationStoresPaginator is a paginator for ListAnnotationStores

func NewListAnnotationStoresPaginator 

func NewListAnnotationStoresPaginator(client ListAnnotationStoresAPIClient, params *ListAnnotationStoresInput, optFns ...func(*ListAnnotationStoresPaginatorOptions)) *ListAnnotationStoresPaginator

NewListAnnotationStoresPaginator returns a new ListAnnotationStoresPaginator

func (*ListAnnotationStoresPaginator) HasMorePages 

func (p *ListAnnotationStoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnnotationStoresPaginator) NextPage 

func (p *ListAnnotationStoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnnotationStoresOutput, error)

NextPage retrieves the next ListAnnotationStores page.

type ListAnnotationStoresPaginatorOptions 

type ListAnnotationStoresPaginatorOptions struct {
	// The maximum number of stores to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAnnotationStoresPaginatorOptions is the paginator options for ListAnnotationStores

type ListMultipartReadSetUploadsAPIClient added in v1.4.0 

type ListMultipartReadSetUploadsAPIClient interface {
	ListMultipartReadSetUploads(context.Context, *ListMultipartReadSetUploadsInput, ...func(*Options)) (*ListMultipartReadSetUploadsOutput, error)
}

ListMultipartReadSetUploadsAPIClient is a client that implements the ListMultipartReadSetUploads operation.

type ListMultipartReadSetUploadsInput added in v1.4.0 

type ListMultipartReadSetUploadsInput struct {

	// The Sequence Store ID used for the multipart uploads.
	//
	// This member is required.
	SequenceStoreId *string

	// The maximum number of multipart uploads returned in a page.
	MaxResults *int32

	// Next token returned in the response of a previous ListMultipartReadSetUploads
	// call. Used to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMultipartReadSetUploadsOutput added in v1.4.0 

type ListMultipartReadSetUploadsOutput struct {

	// Next token returned in the response of a previous ListMultipartReadSetUploads
	// call. Used to get the next page of results.
	NextToken *string

	// An array of multipart uploads.
	Uploads []types.MultipartReadSetUploadListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMultipartReadSetUploadsPaginator added in v1.4.0 

type ListMultipartReadSetUploadsPaginator struct {
	// contains filtered or unexported fields
}

ListMultipartReadSetUploadsPaginator is a paginator for ListMultipartReadSetUploads

func NewListMultipartReadSetUploadsPaginator added in v1.4.0 

func NewListMultipartReadSetUploadsPaginator(client ListMultipartReadSetUploadsAPIClient, params *ListMultipartReadSetUploadsInput, optFns ...func(*ListMultipartReadSetUploadsPaginatorOptions)) *ListMultipartReadSetUploadsPaginator

NewListMultipartReadSetUploadsPaginator returns a new ListMultipartReadSetUploadsPaginator

func (*ListMultipartReadSetUploadsPaginator) HasMorePages added in v1.4.0 

func (p *ListMultipartReadSetUploadsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMultipartReadSetUploadsPaginator) NextPage added in v1.4.0 

func (p *ListMultipartReadSetUploadsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMultipartReadSetUploadsOutput, error)

NextPage retrieves the next ListMultipartReadSetUploads page.

type ListMultipartReadSetUploadsPaginatorOptions added in v1.4.0 

type ListMultipartReadSetUploadsPaginatorOptions struct {
	// The maximum number of multipart uploads returned in a page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMultipartReadSetUploadsPaginatorOptions is the paginator options for ListMultipartReadSetUploads

type ListReadSetActivationJobsAPIClient 

type ListReadSetActivationJobsAPIClient interface {
	ListReadSetActivationJobs(context.Context, *ListReadSetActivationJobsInput, ...func(*Options)) (*ListReadSetActivationJobsOutput, error)
}

ListReadSetActivationJobsAPIClient is a client that implements the ListReadSetActivationJobs operation.

type ListReadSetActivationJobsInput 

type ListReadSetActivationJobsInput struct {

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ActivateReadSetFilter

	// The maximum number of read set activation jobs to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadSetActivationJobsOutput 

type ListReadSetActivationJobsOutput struct {

	// A list of jobs.
	ActivationJobs []types.ActivateReadSetJobItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadSetActivationJobsPaginator 

type ListReadSetActivationJobsPaginator struct {
	// contains filtered or unexported fields
}

ListReadSetActivationJobsPaginator is a paginator for ListReadSetActivationJobs

func NewListReadSetActivationJobsPaginator 

func NewListReadSetActivationJobsPaginator(client ListReadSetActivationJobsAPIClient, params *ListReadSetActivationJobsInput, optFns ...func(*ListReadSetActivationJobsPaginatorOptions)) *ListReadSetActivationJobsPaginator

NewListReadSetActivationJobsPaginator returns a new ListReadSetActivationJobsPaginator

func (*ListReadSetActivationJobsPaginator) HasMorePages 

func (p *ListReadSetActivationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadSetActivationJobsPaginator) NextPage 

func (p *ListReadSetActivationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadSetActivationJobsOutput, error)

NextPage retrieves the next ListReadSetActivationJobs page.

type ListReadSetActivationJobsPaginatorOptions 

type ListReadSetActivationJobsPaginatorOptions struct {
	// The maximum number of read set activation jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadSetActivationJobsPaginatorOptions is the paginator options for ListReadSetActivationJobs

type ListReadSetExportJobsAPIClient 

type ListReadSetExportJobsAPIClient interface {
	ListReadSetExportJobs(context.Context, *ListReadSetExportJobsInput, ...func(*Options)) (*ListReadSetExportJobsOutput, error)
}

ListReadSetExportJobsAPIClient is a client that implements the ListReadSetExportJobs operation.

type ListReadSetExportJobsInput 

type ListReadSetExportJobsInput struct {

	// The jobs' sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ExportReadSetFilter

	// The maximum number of jobs to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadSetExportJobsOutput 

type ListReadSetExportJobsOutput struct {

	// A list of jobs.
	ExportJobs []types.ExportReadSetJobDetail

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadSetExportJobsPaginator 

type ListReadSetExportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListReadSetExportJobsPaginator is a paginator for ListReadSetExportJobs

func NewListReadSetExportJobsPaginator 

func NewListReadSetExportJobsPaginator(client ListReadSetExportJobsAPIClient, params *ListReadSetExportJobsInput, optFns ...func(*ListReadSetExportJobsPaginatorOptions)) *ListReadSetExportJobsPaginator

NewListReadSetExportJobsPaginator returns a new ListReadSetExportJobsPaginator

func (*ListReadSetExportJobsPaginator) HasMorePages 

func (p *ListReadSetExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadSetExportJobsPaginator) NextPage 

func (p *ListReadSetExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadSetExportJobsOutput, error)

NextPage retrieves the next ListReadSetExportJobs page.

type ListReadSetExportJobsPaginatorOptions 

type ListReadSetExportJobsPaginatorOptions struct {
	// The maximum number of jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadSetExportJobsPaginatorOptions is the paginator options for ListReadSetExportJobs

type ListReadSetImportJobsAPIClient 

type ListReadSetImportJobsAPIClient interface {
	ListReadSetImportJobs(context.Context, *ListReadSetImportJobsInput, ...func(*Options)) (*ListReadSetImportJobsOutput, error)
}

ListReadSetImportJobsAPIClient is a client that implements the ListReadSetImportJobs operation.

type ListReadSetImportJobsInput 

type ListReadSetImportJobsInput struct {

	// The jobs' sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ImportReadSetFilter

	// The maximum number of jobs to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadSetImportJobsOutput 

type ListReadSetImportJobsOutput struct {

	// A list of jobs.
	ImportJobs []types.ImportReadSetJobItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadSetImportJobsPaginator 

type ListReadSetImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListReadSetImportJobsPaginator is a paginator for ListReadSetImportJobs

func NewListReadSetImportJobsPaginator 

func NewListReadSetImportJobsPaginator(client ListReadSetImportJobsAPIClient, params *ListReadSetImportJobsInput, optFns ...func(*ListReadSetImportJobsPaginatorOptions)) *ListReadSetImportJobsPaginator

NewListReadSetImportJobsPaginator returns a new ListReadSetImportJobsPaginator

func (*ListReadSetImportJobsPaginator) HasMorePages 

func (p *ListReadSetImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadSetImportJobsPaginator) NextPage 

func (p *ListReadSetImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadSetImportJobsOutput, error)

NextPage retrieves the next ListReadSetImportJobs page.

type ListReadSetImportJobsPaginatorOptions 

type ListReadSetImportJobsPaginatorOptions struct {
	// The maximum number of jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadSetImportJobsPaginatorOptions is the paginator options for ListReadSetImportJobs

type ListReadSetUploadPartsAPIClient added in v1.4.0 

type ListReadSetUploadPartsAPIClient interface {
	ListReadSetUploadParts(context.Context, *ListReadSetUploadPartsInput, ...func(*Options)) (*ListReadSetUploadPartsOutput, error)
}

ListReadSetUploadPartsAPIClient is a client that implements the ListReadSetUploadParts operation.

type ListReadSetUploadPartsInput added in v1.4.0 

type ListReadSetUploadPartsInput struct {

	// The source file for the upload part.
	//
	// This member is required.
	PartSource types.ReadSetPartSource

	// The Sequence Store ID used for the multipart uploads.
	//
	// This member is required.
	SequenceStoreId *string

	// The ID for the initiated multipart upload.
	//
	// This member is required.
	UploadId *string

	// Attributes used to filter for a specific subset of read set part uploads.
	Filter *types.ReadSetUploadPartListFilter

	// The maximum number of read set upload parts returned in a page.
	MaxResults *int32

	// Next token returned in the response of a previous ListReadSetUploadPartsRequest
	// call. Used to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadSetUploadPartsOutput added in v1.4.0 

type ListReadSetUploadPartsOutput struct {

	// Next token returned in the response of a previous ListReadSetUploadParts call.
	// Used to get the next page of results.
	NextToken *string

	// An array of upload parts.
	Parts []types.ReadSetUploadPartListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadSetUploadPartsPaginator added in v1.4.0 

type ListReadSetUploadPartsPaginator struct {
	// contains filtered or unexported fields
}

ListReadSetUploadPartsPaginator is a paginator for ListReadSetUploadParts

func NewListReadSetUploadPartsPaginator added in v1.4.0 

func NewListReadSetUploadPartsPaginator(client ListReadSetUploadPartsAPIClient, params *ListReadSetUploadPartsInput, optFns ...func(*ListReadSetUploadPartsPaginatorOptions)) *ListReadSetUploadPartsPaginator

NewListReadSetUploadPartsPaginator returns a new ListReadSetUploadPartsPaginator

func (*ListReadSetUploadPartsPaginator) HasMorePages added in v1.4.0 

func (p *ListReadSetUploadPartsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadSetUploadPartsPaginator) NextPage added in v1.4.0 

func (p *ListReadSetUploadPartsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadSetUploadPartsOutput, error)

NextPage retrieves the next ListReadSetUploadParts page.

type ListReadSetUploadPartsPaginatorOptions added in v1.4.0 

type ListReadSetUploadPartsPaginatorOptions struct {
	// The maximum number of read set upload parts returned in a page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadSetUploadPartsPaginatorOptions is the paginator options for ListReadSetUploadParts

type ListReadSetsAPIClient 

type ListReadSetsAPIClient interface {
	ListReadSets(context.Context, *ListReadSetsInput, ...func(*Options)) (*ListReadSetsOutput, error)
}

ListReadSetsAPIClient is a client that implements the ListReadSets operation.

type ListReadSetsInput 

type ListReadSetsInput struct {

	// The jobs' sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ReadSetFilter

	// The maximum number of read sets to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadSetsOutput 

type ListReadSetsOutput struct {

	// A list of read sets.
	//
	// This member is required.
	ReadSets []types.ReadSetListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReadSetsPaginator 

type ListReadSetsPaginator struct {
	// contains filtered or unexported fields
}

ListReadSetsPaginator is a paginator for ListReadSets

func NewListReadSetsPaginator 

func NewListReadSetsPaginator(client ListReadSetsAPIClient, params *ListReadSetsInput, optFns ...func(*ListReadSetsPaginatorOptions)) *ListReadSetsPaginator

NewListReadSetsPaginator returns a new ListReadSetsPaginator

func (*ListReadSetsPaginator) HasMorePages 

func (p *ListReadSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadSetsPaginator) NextPage 

func (p *ListReadSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadSetsOutput, error)

NextPage retrieves the next ListReadSets page.

type ListReadSetsPaginatorOptions 

type ListReadSetsPaginatorOptions struct {
	// The maximum number of read sets to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReadSetsPaginatorOptions is the paginator options for ListReadSets

type ListReferenceImportJobsAPIClient 

type ListReferenceImportJobsAPIClient interface {
	ListReferenceImportJobs(context.Context, *ListReferenceImportJobsInput, ...func(*Options)) (*ListReferenceImportJobsOutput, error)
}

ListReferenceImportJobsAPIClient is a client that implements the ListReferenceImportJobs operation.

type ListReferenceImportJobsInput 

type ListReferenceImportJobsInput struct {

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ImportReferenceFilter

	// The maximum number of jobs to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReferenceImportJobsOutput 

type ListReferenceImportJobsOutput struct {

	// A lis of jobs.
	ImportJobs []types.ImportReferenceJobItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReferenceImportJobsPaginator 

type ListReferenceImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListReferenceImportJobsPaginator is a paginator for ListReferenceImportJobs

func NewListReferenceImportJobsPaginator 

func NewListReferenceImportJobsPaginator(client ListReferenceImportJobsAPIClient, params *ListReferenceImportJobsInput, optFns ...func(*ListReferenceImportJobsPaginatorOptions)) *ListReferenceImportJobsPaginator

NewListReferenceImportJobsPaginator returns a new ListReferenceImportJobsPaginator

func (*ListReferenceImportJobsPaginator) HasMorePages 

func (p *ListReferenceImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReferenceImportJobsPaginator) NextPage 

func (p *ListReferenceImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReferenceImportJobsOutput, error)

NextPage retrieves the next ListReferenceImportJobs page.

type ListReferenceImportJobsPaginatorOptions 

type ListReferenceImportJobsPaginatorOptions struct {
	// The maximum number of jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReferenceImportJobsPaginatorOptions is the paginator options for ListReferenceImportJobs

type ListReferenceStoresAPIClient 

type ListReferenceStoresAPIClient interface {
	ListReferenceStores(context.Context, *ListReferenceStoresInput, ...func(*Options)) (*ListReferenceStoresOutput, error)
}

ListReferenceStoresAPIClient is a client that implements the ListReferenceStores operation.

type ListReferenceStoresInput 

type ListReferenceStoresInput struct {

	// A filter to apply to the list.
	Filter *types.ReferenceStoreFilter

	// The maximum number of stores to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReferenceStoresOutput 

type ListReferenceStoresOutput struct {

	// A list of reference stores.
	//
	// This member is required.
	ReferenceStores []types.ReferenceStoreDetail

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReferenceStoresPaginator 

type ListReferenceStoresPaginator struct {
	// contains filtered or unexported fields
}

ListReferenceStoresPaginator is a paginator for ListReferenceStores

func NewListReferenceStoresPaginator 

func NewListReferenceStoresPaginator(client ListReferenceStoresAPIClient, params *ListReferenceStoresInput, optFns ...func(*ListReferenceStoresPaginatorOptions)) *ListReferenceStoresPaginator

NewListReferenceStoresPaginator returns a new ListReferenceStoresPaginator

func (*ListReferenceStoresPaginator) HasMorePages 

func (p *ListReferenceStoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReferenceStoresPaginator) NextPage 

func (p *ListReferenceStoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReferenceStoresOutput, error)

NextPage retrieves the next ListReferenceStores page.

type ListReferenceStoresPaginatorOptions 

type ListReferenceStoresPaginatorOptions struct {
	// The maximum number of stores to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReferenceStoresPaginatorOptions is the paginator options for ListReferenceStores

type ListReferencesAPIClient 

type ListReferencesAPIClient interface {
	ListReferences(context.Context, *ListReferencesInput, ...func(*Options)) (*ListReferencesOutput, error)
}

ListReferencesAPIClient is a client that implements the ListReferences operation.

type ListReferencesInput 

type ListReferencesInput struct {

	// The references' reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// A filter to apply to the list.
	Filter *types.ReferenceFilter

	// The maximum number of references to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReferencesOutput 

type ListReferencesOutput struct {

	// A list of references.
	//
	// This member is required.
	References []types.ReferenceListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReferencesPaginator 

type ListReferencesPaginator struct {
	// contains filtered or unexported fields
}

ListReferencesPaginator is a paginator for ListReferences

func NewListReferencesPaginator 

func NewListReferencesPaginator(client ListReferencesAPIClient, params *ListReferencesInput, optFns ...func(*ListReferencesPaginatorOptions)) *ListReferencesPaginator

NewListReferencesPaginator returns a new ListReferencesPaginator

func (*ListReferencesPaginator) HasMorePages 

func (p *ListReferencesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReferencesPaginator) NextPage 

func (p *ListReferencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReferencesOutput, error)

NextPage retrieves the next ListReferences page.

type ListReferencesPaginatorOptions 

type ListReferencesPaginatorOptions struct {
	// The maximum number of references to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReferencesPaginatorOptions is the paginator options for ListReferences

type ListRunCachesAPIClient added in v1.27.0 

type ListRunCachesAPIClient interface {
	ListRunCaches(context.Context, *ListRunCachesInput, ...func(*Options)) (*ListRunCachesOutput, error)
}

ListRunCachesAPIClient is a client that implements the ListRunCaches operation.

type ListRunCachesInput added in v1.27.0 

type ListRunCachesInput struct {

	// The maximum number of results to return.
	MaxResults *int32

	// Optional pagination token returned from a prior call to the ListRunCaches API
	// operation.
	StartingToken *string
	// contains filtered or unexported fields
}

type ListRunCachesOutput added in v1.27.0 

type ListRunCachesOutput struct {

	// Details about each run cache in the response.
	Items []types.RunCacheListItem

	// Pagination token to retrieve additional run caches. If the response does not
	// have a nextToken value, you have reached to the end of the list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunCachesPaginator added in v1.27.0 

type ListRunCachesPaginator struct {
	// contains filtered or unexported fields
}

ListRunCachesPaginator is a paginator for ListRunCaches

func NewListRunCachesPaginator added in v1.27.0 

func NewListRunCachesPaginator(client ListRunCachesAPIClient, params *ListRunCachesInput, optFns ...func(*ListRunCachesPaginatorOptions)) *ListRunCachesPaginator

NewListRunCachesPaginator returns a new ListRunCachesPaginator

func (*ListRunCachesPaginator) HasMorePages added in v1.27.0 

func (p *ListRunCachesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRunCachesPaginator) NextPage added in v1.27.0 

func (p *ListRunCachesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRunCachesOutput, error)

NextPage retrieves the next ListRunCaches page.

type ListRunCachesPaginatorOptions added in v1.27.0 

type ListRunCachesPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRunCachesPaginatorOptions is the paginator options for ListRunCaches

type ListRunGroupsAPIClient 

type ListRunGroupsAPIClient interface {
	ListRunGroups(context.Context, *ListRunGroupsInput, ...func(*Options)) (*ListRunGroupsOutput, error)
}

ListRunGroupsAPIClient is a client that implements the ListRunGroups operation.

type ListRunGroupsInput 

type ListRunGroupsInput struct {

	// The maximum number of run groups to return in one page of results.
	MaxResults *int32

	// The run groups' name.
	Name *string

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	StartingToken *string
	// contains filtered or unexported fields
}

type ListRunGroupsOutput 

type ListRunGroupsOutput struct {

	// A list of groups.
	Items []types.RunGroupListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunGroupsPaginator 

type ListRunGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListRunGroupsPaginator is a paginator for ListRunGroups

func NewListRunGroupsPaginator 

func NewListRunGroupsPaginator(client ListRunGroupsAPIClient, params *ListRunGroupsInput, optFns ...func(*ListRunGroupsPaginatorOptions)) *ListRunGroupsPaginator

NewListRunGroupsPaginator returns a new ListRunGroupsPaginator

func (*ListRunGroupsPaginator) HasMorePages 

func (p *ListRunGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRunGroupsPaginator) NextPage 

func (p *ListRunGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRunGroupsOutput, error)

NextPage retrieves the next ListRunGroups page.

type ListRunGroupsPaginatorOptions 

type ListRunGroupsPaginatorOptions struct {
	// The maximum number of run groups to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRunGroupsPaginatorOptions is the paginator options for ListRunGroups

type ListRunTasksAPIClient 

type ListRunTasksAPIClient interface {
	ListRunTasks(context.Context, *ListRunTasksInput, ...func(*Options)) (*ListRunTasksOutput, error)
}

ListRunTasksAPIClient is a client that implements the ListRunTasks operation.

type ListRunTasksInput 

type ListRunTasksInput struct {

	// The run's ID.
	//
	// This member is required.
	Id *string

	// The maximum number of run tasks to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	StartingToken *string

	// Filter the list by status.
	Status types.TaskStatus
	// contains filtered or unexported fields
}

type ListRunTasksOutput 

type ListRunTasksOutput struct {

	// A list of tasks.
	Items []types.TaskListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunTasksPaginator 

type ListRunTasksPaginator struct {
	// contains filtered or unexported fields
}

ListRunTasksPaginator is a paginator for ListRunTasks

func NewListRunTasksPaginator 

func NewListRunTasksPaginator(client ListRunTasksAPIClient, params *ListRunTasksInput, optFns ...func(*ListRunTasksPaginatorOptions)) *ListRunTasksPaginator

NewListRunTasksPaginator returns a new ListRunTasksPaginator

func (*ListRunTasksPaginator) HasMorePages 

func (p *ListRunTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRunTasksPaginator) NextPage 

func (p *ListRunTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRunTasksOutput, error)

NextPage retrieves the next ListRunTasks page.

type ListRunTasksPaginatorOptions 

type ListRunTasksPaginatorOptions struct {
	// The maximum number of run tasks to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRunTasksPaginatorOptions is the paginator options for ListRunTasks

type ListRunsAPIClient 

type ListRunsAPIClient interface {
	ListRuns(context.Context, *ListRunsInput, ...func(*Options)) (*ListRunsOutput, error)
}

ListRunsAPIClient is a client that implements the ListRuns operation.

type ListRunsInput 

type ListRunsInput struct {

	// The maximum number of runs to return in one page of results.
	MaxResults *int32

	// Filter the list by run name.
	Name *string

	// Filter the list by run group ID.
	RunGroupId *string

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	StartingToken *string

	// The status of a run.
	Status types.RunStatus
	// contains filtered or unexported fields
}

type ListRunsOutput 

type ListRunsOutput struct {

	// A list of runs.
	Items []types.RunListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunsPaginator 

type ListRunsPaginator struct {
	// contains filtered or unexported fields
}

ListRunsPaginator is a paginator for ListRuns

func NewListRunsPaginator 

func NewListRunsPaginator(client ListRunsAPIClient, params *ListRunsInput, optFns ...func(*ListRunsPaginatorOptions)) *ListRunsPaginator

NewListRunsPaginator returns a new ListRunsPaginator

func (*ListRunsPaginator) HasMorePages 

func (p *ListRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRunsPaginator) NextPage 

func (p *ListRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRunsOutput, error)

NextPage retrieves the next ListRuns page.

type ListRunsPaginatorOptions 

type ListRunsPaginatorOptions struct {
	// The maximum number of runs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRunsPaginatorOptions is the paginator options for ListRuns

type ListSequenceStoresAPIClient 

type ListSequenceStoresAPIClient interface {
	ListSequenceStores(context.Context, *ListSequenceStoresInput, ...func(*Options)) (*ListSequenceStoresOutput, error)
}

ListSequenceStoresAPIClient is a client that implements the ListSequenceStores operation.

type ListSequenceStoresInput 

type ListSequenceStoresInput struct {

	// A filter to apply to the list.
	Filter *types.SequenceStoreFilter

	// The maximum number of stores to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSequenceStoresOutput 

type ListSequenceStoresOutput struct {

	// A list of sequence stores.
	//
	// This member is required.
	SequenceStores []types.SequenceStoreDetail

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSequenceStoresPaginator 

type ListSequenceStoresPaginator struct {
	// contains filtered or unexported fields
}

ListSequenceStoresPaginator is a paginator for ListSequenceStores

func NewListSequenceStoresPaginator 

func NewListSequenceStoresPaginator(client ListSequenceStoresAPIClient, params *ListSequenceStoresInput, optFns ...func(*ListSequenceStoresPaginatorOptions)) *ListSequenceStoresPaginator

NewListSequenceStoresPaginator returns a new ListSequenceStoresPaginator

func (*ListSequenceStoresPaginator) HasMorePages 

func (p *ListSequenceStoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSequenceStoresPaginator) NextPage 

func (p *ListSequenceStoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSequenceStoresOutput, error)

NextPage retrieves the next ListSequenceStores page.

type ListSequenceStoresPaginatorOptions 

type ListSequenceStoresPaginatorOptions struct {
	// The maximum number of stores to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSequenceStoresPaginatorOptions is the paginator options for ListSequenceStores

type ListSharesAPIClient added in v1.8.0 

type ListSharesAPIClient interface {
	ListShares(context.Context, *ListSharesInput, ...func(*Options)) (*ListSharesOutput, error)
}

ListSharesAPIClient is a client that implements the ListShares operation.

type ListSharesInput added in v1.8.0 

type ListSharesInput struct {

	// The account that owns the resource shares.
	//
	// This member is required.
	ResourceOwner types.ResourceOwner

	// Attributes that you use to filter for a specific subset of resource shares.
	Filter *types.Filter

	// The maximum number of shares to return in one page of results.
	MaxResults *int32

	// Next token returned in the response of a previous ListReadSetUploadPartsRequest
	// call. Used to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSharesOutput added in v1.8.0 

type ListSharesOutput struct {

	// The shares available and their metadata details.
	//
	// This member is required.
	Shares []types.ShareDetails

	//  Next token returned in the response of a previous ListSharesResponse call.
	// Used to get the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSharesPaginator added in v1.8.0 

type ListSharesPaginator struct {
	// contains filtered or unexported fields
}

ListSharesPaginator is a paginator for ListShares

func NewListSharesPaginator added in v1.8.0 

func NewListSharesPaginator(client ListSharesAPIClient, params *ListSharesInput, optFns ...func(*ListSharesPaginatorOptions)) *ListSharesPaginator

NewListSharesPaginator returns a new ListSharesPaginator

func (*ListSharesPaginator) HasMorePages added in v1.8.0 

func (p *ListSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSharesPaginator) NextPage added in v1.8.0 

func (p *ListSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSharesOutput, error)

NextPage retrieves the next ListShares page.

type ListSharesPaginatorOptions added in v1.8.0 

type ListSharesPaginatorOptions struct {
	// The maximum number of shares to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSharesPaginatorOptions is the paginator options for ListShares

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of tags.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVariantImportJobsAPIClient 

type ListVariantImportJobsAPIClient interface {
	ListVariantImportJobs(context.Context, *ListVariantImportJobsInput, ...func(*Options)) (*ListVariantImportJobsOutput, error)
}

ListVariantImportJobsAPIClient is a client that implements the ListVariantImportJobs operation.

type ListVariantImportJobsInput 

type ListVariantImportJobsInput struct {

	// A filter to apply to the list.
	Filter *types.ListVariantImportJobsFilter

	// A list of job IDs.
	Ids []string

	// The maximum number of import jobs to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVariantImportJobsOutput 

type ListVariantImportJobsOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of jobs.
	VariantImportJobs []types.VariantImportJobItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVariantImportJobsPaginator 

type ListVariantImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListVariantImportJobsPaginator is a paginator for ListVariantImportJobs

func NewListVariantImportJobsPaginator 

func NewListVariantImportJobsPaginator(client ListVariantImportJobsAPIClient, params *ListVariantImportJobsInput, optFns ...func(*ListVariantImportJobsPaginatorOptions)) *ListVariantImportJobsPaginator

NewListVariantImportJobsPaginator returns a new ListVariantImportJobsPaginator

func (*ListVariantImportJobsPaginator) HasMorePages 

func (p *ListVariantImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVariantImportJobsPaginator) NextPage 

func (p *ListVariantImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVariantImportJobsOutput, error)

NextPage retrieves the next ListVariantImportJobs page.

type ListVariantImportJobsPaginatorOptions 

type ListVariantImportJobsPaginatorOptions struct {
	// The maximum number of import jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVariantImportJobsPaginatorOptions is the paginator options for ListVariantImportJobs

type ListVariantStoresAPIClient 

type ListVariantStoresAPIClient interface {
	ListVariantStores(context.Context, *ListVariantStoresInput, ...func(*Options)) (*ListVariantStoresOutput, error)
}

ListVariantStoresAPIClient is a client that implements the ListVariantStores operation.

type ListVariantStoresInput 

type ListVariantStoresInput struct {

	// A filter to apply to the list.
	Filter *types.ListVariantStoresFilter

	// A list of store IDs.
	Ids []string

	// The maximum number of stores to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVariantStoresOutput 

type ListVariantStoresOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of variant stores.
	VariantStores []types.VariantStoreItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVariantStoresPaginator 

type ListVariantStoresPaginator struct {
	// contains filtered or unexported fields
}

ListVariantStoresPaginator is a paginator for ListVariantStores

func NewListVariantStoresPaginator 

func NewListVariantStoresPaginator(client ListVariantStoresAPIClient, params *ListVariantStoresInput, optFns ...func(*ListVariantStoresPaginatorOptions)) *ListVariantStoresPaginator

NewListVariantStoresPaginator returns a new ListVariantStoresPaginator

func (*ListVariantStoresPaginator) HasMorePages 

func (p *ListVariantStoresPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVariantStoresPaginator) NextPage 

func (p *ListVariantStoresPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVariantStoresOutput, error)

NextPage retrieves the next ListVariantStores page.

type ListVariantStoresPaginatorOptions 

type ListVariantStoresPaginatorOptions struct {
	// The maximum number of stores to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVariantStoresPaginatorOptions is the paginator options for ListVariantStores

type ListWorkflowVersionsAPIClient added in v1.30.0 

type ListWorkflowVersionsAPIClient interface {
	ListWorkflowVersions(context.Context, *ListWorkflowVersionsInput, ...func(*Options)) (*ListWorkflowVersionsOutput, error)
}

ListWorkflowVersionsAPIClient is a client that implements the ListWorkflowVersions operation.

type ListWorkflowVersionsInput added in v1.30.0 

type ListWorkflowVersionsInput struct {

	// The workflow's ID. The workflowId is not the UUID.
	//
	// This member is required.
	WorkflowId *string

	// The maximum number of workflows to return in one page of results.
	MaxResults *int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	StartingToken *string

	// The workflow type.
	Type types.WorkflowType

	// The 12-digit account ID of the workflow owner. The workflow owner ID can be
	// retrieved using the GetShare API operation. If you are the workflow owner, you
	// do not need to include this ID.
	WorkflowOwnerId *string
	// contains filtered or unexported fields
}

type ListWorkflowVersionsOutput added in v1.30.0 

type ListWorkflowVersionsOutput struct {

	// A list of workflow version items.
	Items []types.WorkflowVersionListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowVersionsPaginator added in v1.30.0 

type ListWorkflowVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowVersionsPaginator is a paginator for ListWorkflowVersions

func NewListWorkflowVersionsPaginator added in v1.30.0 

func NewListWorkflowVersionsPaginator(client ListWorkflowVersionsAPIClient, params *ListWorkflowVersionsInput, optFns ...func(*ListWorkflowVersionsPaginatorOptions)) *ListWorkflowVersionsPaginator

NewListWorkflowVersionsPaginator returns a new ListWorkflowVersionsPaginator

func (*ListWorkflowVersionsPaginator) HasMorePages added in v1.30.0 

func (p *ListWorkflowVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowVersionsPaginator) NextPage added in v1.30.0 

func (p *ListWorkflowVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowVersionsOutput, error)

NextPage retrieves the next ListWorkflowVersions page.

type ListWorkflowVersionsPaginatorOptions added in v1.30.0 

type ListWorkflowVersionsPaginatorOptions struct {
	// The maximum number of workflows to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowVersionsPaginatorOptions is the paginator options for ListWorkflowVersions

type ListWorkflowsAPIClient 

type ListWorkflowsAPIClient interface {
	ListWorkflows(context.Context, *ListWorkflowsInput, ...func(*Options)) (*ListWorkflowsOutput, error)
}

ListWorkflowsAPIClient is a client that implements the ListWorkflows operation.

type ListWorkflowsInput 

type ListWorkflowsInput struct {

	// The maximum number of workflows to return in one page of results.
	MaxResults *int32

	// Filter the list by workflow name.
	Name *string

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	StartingToken *string

	// Filter the list by workflow type.
	Type types.WorkflowType
	// contains filtered or unexported fields
}

type ListWorkflowsOutput 

type ListWorkflowsOutput struct {

	// A list of workflow items.
	Items []types.WorkflowListItem

	// A pagination token that's included if more results are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkflowsPaginator 

type ListWorkflowsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkflowsPaginator is a paginator for ListWorkflows

func NewListWorkflowsPaginator 

func NewListWorkflowsPaginator(client ListWorkflowsAPIClient, params *ListWorkflowsInput, optFns ...func(*ListWorkflowsPaginatorOptions)) *ListWorkflowsPaginator

NewListWorkflowsPaginator returns a new ListWorkflowsPaginator

func (*ListWorkflowsPaginator) HasMorePages 

func (p *ListWorkflowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkflowsPaginator) NextPage 

func (p *ListWorkflowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowsOutput, error)

NextPage retrieves the next ListWorkflows page.

type ListWorkflowsPaginatorOptions 

type ListWorkflowsPaginatorOptions struct {
	// The maximum number of workflows to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkflowsPaginatorOptions is the paginator options for ListWorkflows

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.15.1 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutS3AccessPolicyInput added in v1.28.0 

type PutS3AccessPolicyInput struct {

	// The S3 access point ARN where you want to put the access policy.
	//
	// This member is required.
	S3AccessPointArn *string

	// The resource policy that controls S3 access to the store.
	//
	// This value conforms to the media type: application/json
	//
	// This member is required.
	S3AccessPolicy *string
	// contains filtered or unexported fields
}

type PutS3AccessPolicyOutput added in v1.28.0 

type PutS3AccessPolicyOutput struct {

	// The S3 access point ARN that now has the access policy.
	S3AccessPointArn *string

	// The Amazon Web Services-generated Sequence Store or Reference Store ID.
	StoreId *string

	// The type of store associated with the access point.
	StoreType types.StoreType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ReadSetActivationJobCompletedWaiter 

type ReadSetActivationJobCompletedWaiter struct {
	// contains filtered or unexported fields
}

ReadSetActivationJobCompletedWaiter defines the waiters for ReadSetActivationJobCompleted

func NewReadSetActivationJobCompletedWaiter 

func NewReadSetActivationJobCompletedWaiter(client GetReadSetActivationJobAPIClient, optFns ...func(*ReadSetActivationJobCompletedWaiterOptions)) *ReadSetActivationJobCompletedWaiter

NewReadSetActivationJobCompletedWaiter constructs a ReadSetActivationJobCompletedWaiter.

func (*ReadSetActivationJobCompletedWaiter) Wait 

func (w *ReadSetActivationJobCompletedWaiter) Wait(ctx context.Context, params *GetReadSetActivationJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetActivationJobCompletedWaiterOptions)) error

Wait calls the waiter function for ReadSetActivationJobCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ReadSetActivationJobCompletedWaiter) WaitForOutput 

func (w *ReadSetActivationJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetActivationJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetActivationJobCompletedWaiterOptions)) (*GetReadSetActivationJobOutput, error)

WaitForOutput calls the waiter function for ReadSetActivationJobCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ReadSetActivationJobCompletedWaiterOptions 

type ReadSetActivationJobCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ReadSetActivationJobCompletedWaiter will use default minimum delay of 30
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ReadSetActivationJobCompletedWaiter will use default max delay of
	// 600 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetReadSetActivationJobInput, *GetReadSetActivationJobOutput, error) (bool, error)
}

ReadSetActivationJobCompletedWaiterOptions are waiter options for ReadSetActivationJobCompletedWaiter

type ReadSetExportJobCompletedWaiter 

type ReadSetExportJobCompletedWaiter struct {
	// contains filtered or unexported fields
}

ReadSetExportJobCompletedWaiter defines the waiters for ReadSetExportJobCompleted

func NewReadSetExportJobCompletedWaiter 

func NewReadSetExportJobCompletedWaiter(client GetReadSetExportJobAPIClient, optFns ...func(*ReadSetExportJobCompletedWaiterOptions)) *ReadSetExportJobCompletedWaiter

NewReadSetExportJobCompletedWaiter constructs a ReadSetExportJobCompletedWaiter.

func (*ReadSetExportJobCompletedWaiter) Wait 

func (w *ReadSetExportJobCompletedWaiter) Wait(ctx context.Context, params *GetReadSetExportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetExportJobCompletedWaiterOptions)) error

Wait calls the waiter function for ReadSetExportJobCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ReadSetExportJobCompletedWaiter) WaitForOutput 

func (w *ReadSetExportJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetExportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetExportJobCompletedWaiterOptions)) (*GetReadSetExportJobOutput, error)

WaitForOutput calls the waiter function for ReadSetExportJobCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ReadSetExportJobCompletedWaiterOptions 

type ReadSetExportJobCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ReadSetExportJobCompletedWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ReadSetExportJobCompletedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetReadSetExportJobInput, *GetReadSetExportJobOutput, error) (bool, error)
}

ReadSetExportJobCompletedWaiterOptions are waiter options for ReadSetExportJobCompletedWaiter

type ReadSetImportJobCompletedWaiter 

type ReadSetImportJobCompletedWaiter struct {
	// contains filtered or unexported fields
}

ReadSetImportJobCompletedWaiter defines the waiters for ReadSetImportJobCompleted

func NewReadSetImportJobCompletedWaiter 

func NewReadSetImportJobCompletedWaiter(client GetReadSetImportJobAPIClient, optFns ...func(*ReadSetImportJobCompletedWaiterOptions)) *ReadSetImportJobCompletedWaiter

NewReadSetImportJobCompletedWaiter constructs a ReadSetImportJobCompletedWaiter.

func (*ReadSetImportJobCompletedWaiter) Wait 

func (w *ReadSetImportJobCompletedWaiter) Wait(ctx context.Context, params *GetReadSetImportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetImportJobCompletedWaiterOptions)) error

Wait calls the waiter function for ReadSetImportJobCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ReadSetImportJobCompletedWaiter) WaitForOutput 

func (w *ReadSetImportJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetImportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetImportJobCompletedWaiterOptions)) (*GetReadSetImportJobOutput, error)

WaitForOutput calls the waiter function for ReadSetImportJobCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ReadSetImportJobCompletedWaiterOptions 

type ReadSetImportJobCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ReadSetImportJobCompletedWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ReadSetImportJobCompletedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetReadSetImportJobInput, *GetReadSetImportJobOutput, error) (bool, error)
}

ReadSetImportJobCompletedWaiterOptions are waiter options for ReadSetImportJobCompletedWaiter

type ReferenceImportJobCompletedWaiter 

type ReferenceImportJobCompletedWaiter struct {
	// contains filtered or unexported fields
}

ReferenceImportJobCompletedWaiter defines the waiters for ReferenceImportJobCompleted

func NewReferenceImportJobCompletedWaiter 

func NewReferenceImportJobCompletedWaiter(client GetReferenceImportJobAPIClient, optFns ...func(*ReferenceImportJobCompletedWaiterOptions)) *ReferenceImportJobCompletedWaiter

NewReferenceImportJobCompletedWaiter constructs a ReferenceImportJobCompletedWaiter.

func (*ReferenceImportJobCompletedWaiter) Wait 

func (w *ReferenceImportJobCompletedWaiter) Wait(ctx context.Context, params *GetReferenceImportJobInput, maxWaitDur time.Duration, optFns ...func(*ReferenceImportJobCompletedWaiterOptions)) error

Wait calls the waiter function for ReferenceImportJobCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ReferenceImportJobCompletedWaiter) WaitForOutput 

func (w *ReferenceImportJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReferenceImportJobInput, maxWaitDur time.Duration, optFns ...func(*ReferenceImportJobCompletedWaiterOptions)) (*GetReferenceImportJobOutput, error)

WaitForOutput calls the waiter function for ReferenceImportJobCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ReferenceImportJobCompletedWaiterOptions 

type ReferenceImportJobCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ReferenceImportJobCompletedWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ReferenceImportJobCompletedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetReferenceImportJobInput, *GetReferenceImportJobOutput, error) (bool, error)
}

ReferenceImportJobCompletedWaiterOptions are waiter options for ReferenceImportJobCompletedWaiter

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RunCompletedWaiter 

type RunCompletedWaiter struct {
	// contains filtered or unexported fields
}

RunCompletedWaiter defines the waiters for RunCompleted

func NewRunCompletedWaiter 

func NewRunCompletedWaiter(client GetRunAPIClient, optFns ...func(*RunCompletedWaiterOptions)) *RunCompletedWaiter

NewRunCompletedWaiter constructs a RunCompletedWaiter.

func (*RunCompletedWaiter) Wait 

func (w *RunCompletedWaiter) Wait(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunCompletedWaiterOptions)) error

Wait calls the waiter function for RunCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*RunCompletedWaiter) WaitForOutput 

func (w *RunCompletedWaiter) WaitForOutput(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunCompletedWaiterOptions)) (*GetRunOutput, error)

WaitForOutput calls the waiter function for RunCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type RunCompletedWaiterOptions 

type RunCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// RunCompletedWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, RunCompletedWaiter will use default max delay of 600 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetRunInput, *GetRunOutput, error) (bool, error)
}

RunCompletedWaiterOptions are waiter options for RunCompletedWaiter

type RunRunningWaiter 

type RunRunningWaiter struct {
	// contains filtered or unexported fields
}

RunRunningWaiter defines the waiters for RunRunning

func NewRunRunningWaiter 

func NewRunRunningWaiter(client GetRunAPIClient, optFns ...func(*RunRunningWaiterOptions)) *RunRunningWaiter

NewRunRunningWaiter constructs a RunRunningWaiter.

func (*RunRunningWaiter) Wait 

func (w *RunRunningWaiter) Wait(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunRunningWaiterOptions)) error

Wait calls the waiter function for RunRunning waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*RunRunningWaiter) WaitForOutput 

func (w *RunRunningWaiter) WaitForOutput(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunRunningWaiterOptions)) (*GetRunOutput, error)

WaitForOutput calls the waiter function for RunRunning waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type RunRunningWaiterOptions 

type RunRunningWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// RunRunningWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, RunRunningWaiter will use default max delay of 600 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetRunInput, *GetRunOutput, error) (bool, error)
}

RunRunningWaiterOptions are waiter options for RunRunningWaiter

type StartAnnotationImportJobInput 

type StartAnnotationImportJobInput struct {

	// A destination annotation store for the job.
	//
	// This member is required.
	DestinationName *string

	// Items to import.
	//
	// This member is required.
	Items []types.AnnotationImportItemSource

	// A service role for the job.
	//
	// This member is required.
	RoleArn *string

	// The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// Formatting options for the annotation file.
	FormatOptions types.FormatOptions

	// The job's left normalization setting.
	RunLeftNormalization bool

	//  The name of the annotation store version.
	VersionName *string
	// contains filtered or unexported fields
}

type StartAnnotationImportJobOutput 

type StartAnnotationImportJobOutput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartReadSetActivationJobInput 

type StartReadSetActivationJobInput struct {

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.StartReadSetActivationJobSourceItem

	// To ensure that jobs don't run multiple times, specify a unique token for each
	// job.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartReadSetActivationJobOutput 

type StartReadSetActivationJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetActivationJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartReadSetExportJobInput 

type StartReadSetExportJobInput struct {

	// A location for exported files in Amazon S3.
	//
	// This member is required.
	Destination *string

	// A service role for the job.
	//
	// This member is required.
	RoleArn *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.ExportReadSet

	// To ensure that jobs don't run multiple times, specify a unique token for each
	// job.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartReadSetExportJobOutput 

type StartReadSetExportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's output location.
	//
	// This member is required.
	Destination *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetExportJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartReadSetImportJobInput 

type StartReadSetImportJobInput struct {

	// A service role for the job.
	//
	// This member is required.
	RoleArn *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.StartReadSetImportJobSourceItem

	// To ensure that jobs don't run multiple times, specify a unique token for each
	// job.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartReadSetImportJobOutput 

type StartReadSetImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status types.ReadSetImportJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartReferenceImportJobInput 

type StartReferenceImportJobInput struct {

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// A service role for the job.
	//
	// This member is required.
	RoleArn *string

	// The job's source files.
	//
	// This member is required.
	Sources []types.StartReferenceImportJobSourceItem

	// To ensure that jobs don't run multiple times, specify a unique token for each
	// job.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartReferenceImportJobOutput 

type StartReferenceImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's status.
	//
	// This member is required.
	Status types.ReferenceImportJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartRunInput 

type StartRunInput struct {

	// An output S3 URI for the run. The S3 bucket must be in the same region as the
	// workflow. The role ARN must have permission to write to this S3 bucket.
	//
	// This member is required.
	OutputUri *string

	// An idempotency token used to dedupe retry requests so that duplicate runs are
	// not created.
	//
	// This member is required.
	RequestId *string

	// A service role for the run. The roleArn requires access to Amazon Web Services
	// HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is
	// arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ . In
	// this example, the AWS account ID is 123456789012 and the role name is
	// omics-service-role-serviceRole-W8O1XMPL7QZ .
	//
	// This member is required.
	RoleArn *string

	// The cache behavior for the run. You specify this value if you want to override
	// the default behavior for the cache. You had set the default value when you
	// created the cache. For more information, see [Run cache behavior]in the Amazon Web Services
	// HealthOmics User Guide.
	//
	// [Run cache behavior]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
	CacheBehavior types.CacheBehavior

	// Identifier of the cache associated with this run. If you don't specify a cache
	// ID, no task outputs are cached for this run.
	CacheId *string

	// A log level for the run.
	LogLevel types.RunLogLevel

	// A name for the run. This is recommended to view and organize runs in the Amazon
	// Web Services HealthOmics console and CloudWatch logs.
	Name *string

	// Parameters for the run. The run needs all required parameters and can include
	// optional parameters. The run cannot include any parameters that are not defined
	// in the parameter template. To retrieve parameters from the run, use the GetRun
	// API operation.
	Parameters document.Interface

	// Use the run priority (highest: 1) to establish the order of runs in a run group
	// when you start a run. If multiple runs share the same priority, the run that was
	// initiated first will have the higher priority. Runs that do not belong to a run
	// group can be assigned a priority. The priorities of these runs are ranked among
	// other runs that are not in a run group. For more information, see [Run priority]in the Amazon
	// Web Services HealthOmics User Guide.
	//
	// [Run priority]: https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority
	Priority *int32

	// The retention mode for the run. The default value is RETAIN .
	//
	// Amazon Web Services HealthOmics stores a fixed number of runs that are
	// available to the console and API. In the default mode ( RETAIN ), you need to
	// remove runs manually when the number of run exceeds the maximum. If you set the
	// retention mode to REMOVE , Amazon Web Services HealthOmics automatically removes
	// runs (that have mode set to REMOVE ) when the number of run exceeds the maximum.
	// All run logs are available in CloudWatch logs, if you need information about a
	// run that is no longer available to the API.
	//
	// For more information about retention mode, see [Specifying run retention mode] in the Amazon Web Services
	// HealthOmics User Guide.
	//
	// [Specifying run retention mode]: https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html
	RetentionMode types.RunRetentionMode

	// The run's group ID. Use a run group to cap the compute resources (and number of
	// concurrent runs) for the runs that you add to the run group.
	RunGroupId *string

	// The ID of a run to duplicate.
	RunId *string

	// The STATIC storage capacity (in gibibytes, GiB) for this run. The default run
	// storage capacity is 1200 GiB. If your requested storage capacity is unavailable,
	// the system rounds up the value to the nearest 1200 GiB multiple. If the
	// requested storage capacity is still unavailable, the system rounds up the value
	// to the nearest 2400 GiB multiple. This field is not required if the storage type
	// is DYNAMIC (the system ignores any value that you enter).
	StorageCapacity *int32

	// The storage type for the run. If you set the storage type to DYNAMIC , Amazon
	// Web Services HealthOmics dynamically scales the storage up or down, based on
	// file system utilization. By default, the run uses STATIC storage type, which
	// allocates a fixed amount of storage. For more information about DYNAMIC and
	// STATIC storage, see [Run storage types] in the Amazon Web Services HealthOmics User Guide.
	//
	// [Run storage types]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
	StorageType types.StorageType

	// Tags for the run. You can add up to 50 tags per run. For more information, see [Adding a tag]
	// in the Amazon Web Services HealthOmics User Guide.
	//
	// [Adding a tag]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
	Tags map[string]string

	// The run's workflow ID. The workflowId is not the UUID.
	WorkflowId *string

	// The 12-digit account ID of the workflow owner that is used for running a shared
	// workflow. The workflow owner ID can be retrieved using the GetShare API
	// operation. If you are the workflow owner, you do not need to include this ID.
	WorkflowOwnerId *string

	// The run's workflow type. The workflowType must be specified if you are running
	// a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do
	// not need to include the workflow type.
	WorkflowType types.WorkflowType

	// The name of the workflow version. Use workflow versions to track and organize
	// changes to the workflow. If your workflow has multiple versions, the run uses
	// the default version unless you specify a version name. To learn more, see [Workflow versioning]in
	// the Amazon Web Services HealthOmics User Guide.
	//
	// [Workflow versioning]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
	WorkflowVersionName *string
	// contains filtered or unexported fields
}

type StartRunOutput 

type StartRunOutput struct {

	// Unique resource identifier for the run.
	Arn *string

	// The run's ID.
	Id *string

	// The destination for workflow outputs.
	RunOutputUri *string

	// The run's status.
	Status types.RunStatus

	// The run's tags.
	Tags map[string]string

	// The universally unique identifier for a run.
	Uuid *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartVariantImportJobInput 

type StartVariantImportJobInput struct {

	// The destination variant store for the job.
	//
	// This member is required.
	DestinationName *string

	// Items to import.
	//
	// This member is required.
	Items []types.VariantImportItemSource

	// A service role for the job.
	//
	// This member is required.
	RoleArn *string

	// The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// The job's left normalization setting.
	RunLeftNormalization bool
	// contains filtered or unexported fields
}

type StartVariantImportJobOutput 

type StartVariantImportJobOutput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string

	// Tags for the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TaskCompletedWaiter 

type TaskCompletedWaiter struct {
	// contains filtered or unexported fields
}

TaskCompletedWaiter defines the waiters for TaskCompleted

func NewTaskCompletedWaiter 

func NewTaskCompletedWaiter(client GetRunTaskAPIClient, optFns ...func(*TaskCompletedWaiterOptions)) *TaskCompletedWaiter

NewTaskCompletedWaiter constructs a TaskCompletedWaiter.

func (*TaskCompletedWaiter) Wait 

func (w *TaskCompletedWaiter) Wait(ctx context.Context, params *GetRunTaskInput, maxWaitDur time.Duration, optFns ...func(*TaskCompletedWaiterOptions)) error

Wait calls the waiter function for TaskCompleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*TaskCompletedWaiter) WaitForOutput 

func (w *TaskCompletedWaiter) WaitForOutput(ctx context.Context, params *GetRunTaskInput, maxWaitDur time.Duration, optFns ...func(*TaskCompletedWaiterOptions)) (*GetRunTaskOutput, error)

WaitForOutput calls the waiter function for TaskCompleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type TaskCompletedWaiterOptions 

type TaskCompletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// TaskCompletedWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, TaskCompletedWaiter will use default max delay of 600 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetRunTaskInput, *GetRunTaskOutput, error) (bool, error)
}

TaskCompletedWaiterOptions are waiter options for TaskCompletedWaiter

type TaskRunningWaiter 

type TaskRunningWaiter struct {
	// contains filtered or unexported fields
}

TaskRunningWaiter defines the waiters for TaskRunning

func NewTaskRunningWaiter 

func NewTaskRunningWaiter(client GetRunTaskAPIClient, optFns ...func(*TaskRunningWaiterOptions)) *TaskRunningWaiter

NewTaskRunningWaiter constructs a TaskRunningWaiter.

func (*TaskRunningWaiter) Wait 

func (w *TaskRunningWaiter) Wait(ctx context.Context, params *GetRunTaskInput, maxWaitDur time.Duration, optFns ...func(*TaskRunningWaiterOptions)) error

Wait calls the waiter function for TaskRunning waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*TaskRunningWaiter) WaitForOutput 

func (w *TaskRunningWaiter) WaitForOutput(ctx context.Context, params *GetRunTaskInput, maxWaitDur time.Duration, optFns ...func(*TaskRunningWaiterOptions)) (*GetRunTaskOutput, error)

WaitForOutput calls the waiter function for TaskRunning waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type TaskRunningWaiterOptions 

type TaskRunningWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// TaskRunningWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, TaskRunningWaiter will use default max delay of 600 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetRunTaskInput, *GetRunTaskOutput, error) (bool, error)
}

TaskRunningWaiterOptions are waiter options for TaskRunningWaiter

type UntagResourceInput 

type UntagResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string

	// Keys of tags to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAnnotationStoreInput 

type UpdateAnnotationStoreInput struct {

	// A name for the store.
	//
	// This member is required.
	Name *string

	// A description for the store.
	Description *string
	// contains filtered or unexported fields
}

type UpdateAnnotationStoreOutput 

type UpdateAnnotationStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's genome reference.
	//
	// This member is required.
	Reference types.ReferenceItem

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The annotation file format of the store.
	StoreFormat types.StoreFormat

	// Parsing options for the store.
	StoreOptions types.StoreOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAnnotationStoreVersionInput added in v1.8.0 

type UpdateAnnotationStoreVersionInput struct {

	//  The name of an annotation store.
	//
	// This member is required.
	Name *string

	//  The name of an annotation store version.
	//
	// This member is required.
	VersionName *string

	//  The description of an annotation store.
	Description *string
	// contains filtered or unexported fields
}

type UpdateAnnotationStoreVersionOutput added in v1.8.0 

type UpdateAnnotationStoreVersionOutput struct {

	//  The time stamp for when an annotation store version was created.
	//
	// This member is required.
	CreationTime *time.Time

	//  The description of an annotation store version.
	//
	// This member is required.
	Description *string

	//  The annotation store version ID.
	//
	// This member is required.
	Id *string

	//  The name of an annotation store.
	//
	// This member is required.
	Name *string

	//  The status of an annotation store version.
	//
	// This member is required.
	Status types.VersionStatus

	//  The annotation store ID.
	//
	// This member is required.
	StoreId *string

	//  The time stamp for when an annotation store version was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The name of an annotation store version.
	//
	// This member is required.
	VersionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunCacheInput added in v1.27.0 

type UpdateRunCacheInput struct {

	// The identifier of the run cache you want to update.
	//
	// This member is required.
	Id *string

	// Update the default run cache behavior.
	CacheBehavior types.CacheBehavior

	// Update the run cache description.
	Description *string

	// Update the name of the run cache.
	Name *string
	// contains filtered or unexported fields
}

type UpdateRunCacheOutput added in v1.27.0 

type UpdateRunCacheOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunGroupInput 

type UpdateRunGroupInput struct {

	// The group's ID.
	//
	// This member is required.
	Id *string

	// The maximum number of CPUs to use.
	MaxCpus *int32

	// A maximum run time for the group in minutes.
	MaxDuration *int32

	// The maximum GPUs that can be used by a run group.
	MaxGpus *int32

	// The maximum number of concurrent runs for the group.
	MaxRuns *int32

	// A name for the group.
	Name *string
	// contains filtered or unexported fields
}

type UpdateRunGroupOutput 

type UpdateRunGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSequenceStoreInput added in v1.28.0 

type UpdateSequenceStoreInput struct {

	// The ID of the sequence store.
	//
	// This member is required.
	Id *string

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

	// A description for the sequence store.
	Description *string

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

	// A name for the sequence store.
	Name *string

	// The tags keys to propagate to the S3 objects associated with read sets in the
	// sequence store.
	PropagatedSetLevelTags []string

	// S3 access configuration parameters.
	S3AccessConfig *types.S3AccessConfig
	// contains filtered or unexported fields
}

type UpdateSequenceStoreOutput added in v1.28.0 

type UpdateSequenceStoreOutput struct {

	// The ARN of the sequence store.
	//
	// This member is required.
	Arn *string

	// The time when the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The ID of the sequence store.
	//
	// This member is required.
	Id *string

	// Description of the sequence store.
	Description *string

	// The ETag algorithm family to use on ingested read sets.
	ETagAlgorithmFamily types.ETagAlgorithmFamily

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

	// The name of the sequence store.
	Name *string

	// The tags keys to propagate to the S3 objects associated with read sets in the
	// sequence store.
	PropagatedSetLevelTags []string

	// The S3 access metadata of the sequence store.
	S3Access *types.SequenceStoreS3Access

	// Server-side encryption (SSE) settings for a store.
	SseConfig *types.SseConfig

	// The status of the sequence store.
	Status types.SequenceStoreStatus

	// The status message of the sequence store.
	StatusMessage *string

	// The last-updated time of the Sequence Store.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateVariantStoreInput 

type UpdateVariantStoreInput struct {

	// A name for the store.
	//
	// This member is required.
	Name *string

	// A description for the store.
	Description *string
	// contains filtered or unexported fields
}

type UpdateVariantStoreOutput 

type UpdateVariantStoreOutput struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's genome reference.
	//
	// This member is required.
	Reference types.ReferenceItem

	// The store's status.
	//
	// This member is required.
	Status types.StoreStatus

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkflowInput 

type UpdateWorkflowInput struct {

	// The workflow's ID.
	//
	// This member is required.
	Id *string

	// A description for the workflow.
	Description *string

	// A name for the workflow.
	Name *string

	// The markdown content for the workflow's README file. This provides
	// documentation and usage information for users of the workflow.
	//
	// This value conforms to the media type: text/markdown
	ReadmeMarkdown *string

	// The default static storage capacity (in gibibytes) for runs that use this
	// workflow or workflow version.
	StorageCapacity *int32

	// The default storage type for runs that use this workflow. STATIC storage
	// allocates a fixed amount of storage. DYNAMIC storage dynamically scales the
	// storage up or down, based on file system utilization. For more information about
	// static and dynamic storage, see [Running workflows]in the Amazon Web Services HealthOmics User
	// Guide.
	//
	// [Running workflows]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
	StorageType types.StorageType
	// contains filtered or unexported fields
}

type UpdateWorkflowOutput 

type UpdateWorkflowOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkflowVersionInput added in v1.30.0 

type UpdateWorkflowVersionInput struct {

	// The name of the workflow version.
	//
	// This member is required.
	VersionName *string

	// The workflow's ID. The workflowId is not the UUID.
	//
	// This member is required.
	WorkflowId *string

	// Description of the workflow version.
	Description *string

	// The markdown content for the workflow version's README file. This provides
	// documentation and usage information for users of this specific workflow version.
	//
	// This value conforms to the media type: text/markdown
	ReadmeMarkdown *string

	// The default static storage capacity (in gibibytes) for runs that use this
	// workflow version. The storageCapacity can be overwritten at run time. The
	// storage capacity is not required for runs with a DYNAMIC storage type.
	StorageCapacity *int32

	// The default storage type for runs that use this workflow version. The
	// storageType can be overridden at run time. DYNAMIC storage dynamically scales
	// the storage up or down, based on file system utilization. STATIC storage
	// allocates a fixed amount of storage. For more information about dynamic and
	// static storage types, see [Run storage types]in the in the Amazon Web Services HealthOmics User
	// Guide .
	//
	// [Run storage types]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
	StorageType types.StorageType
	// contains filtered or unexported fields
}

type UpdateWorkflowVersionOutput added in v1.30.0 

type UpdateWorkflowVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UploadReadSetPartInput added in v1.4.0 

type UploadReadSetPartInput struct {

	// The number of the part being uploaded.
	//
	// This member is required.
	PartNumber *int32

	// The source file for an upload part.
	//
	// This member is required.
	PartSource types.ReadSetPartSource

	// The read set data to upload for a part.
	//
	// This member is required.
	Payload io.Reader

	// The Sequence Store ID used for the multipart upload.
	//
	// This member is required.
	SequenceStoreId *string

	// The ID for the initiated multipart upload.
	//
	// This member is required.
	UploadId *string
	// contains filtered or unexported fields
}

type UploadReadSetPartOutput added in v1.4.0 

type UploadReadSetPartOutput struct {

	// An identifier used to confirm that parts are being added to the intended upload.
	//
	// This member is required.
	Checksum *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type VariantImportJobCreatedWaiter 

type VariantImportJobCreatedWaiter struct {
	// contains filtered or unexported fields
}

VariantImportJobCreatedWaiter defines the waiters for VariantImportJobCreated

func NewVariantImportJobCreatedWaiter 

func NewVariantImportJobCreatedWaiter(client GetVariantImportJobAPIClient, optFns ...func(*VariantImportJobCreatedWaiterOptions)) *VariantImportJobCreatedWaiter

NewVariantImportJobCreatedWaiter constructs a VariantImportJobCreatedWaiter.

func (*VariantImportJobCreatedWaiter) Wait 

func (w *VariantImportJobCreatedWaiter) Wait(ctx context.Context, params *GetVariantImportJobInput, maxWaitDur time.Duration, optFns ...func(*VariantImportJobCreatedWaiterOptions)) error

Wait calls the waiter function for VariantImportJobCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*VariantImportJobCreatedWaiter) WaitForOutput 

func (w *VariantImportJobCreatedWaiter) WaitForOutput(ctx context.Context, params *GetVariantImportJobInput, maxWaitDur time.Duration, optFns ...func(*VariantImportJobCreatedWaiterOptions)) (*GetVariantImportJobOutput, error)

WaitForOutput calls the waiter function for VariantImportJobCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type VariantImportJobCreatedWaiterOptions 

type VariantImportJobCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// VariantImportJobCreatedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, VariantImportJobCreatedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetVariantImportJobInput, *GetVariantImportJobOutput, error) (bool, error)
}

VariantImportJobCreatedWaiterOptions are waiter options for VariantImportJobCreatedWaiter

type VariantStoreCreatedWaiter 

type VariantStoreCreatedWaiter struct {
	// contains filtered or unexported fields
}

VariantStoreCreatedWaiter defines the waiters for VariantStoreCreated

func NewVariantStoreCreatedWaiter 

func NewVariantStoreCreatedWaiter(client GetVariantStoreAPIClient, optFns ...func(*VariantStoreCreatedWaiterOptions)) *VariantStoreCreatedWaiter

NewVariantStoreCreatedWaiter constructs a VariantStoreCreatedWaiter.

func (*VariantStoreCreatedWaiter) Wait 

func (w *VariantStoreCreatedWaiter) Wait(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreCreatedWaiterOptions)) error

Wait calls the waiter function for VariantStoreCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*VariantStoreCreatedWaiter) WaitForOutput 

func (w *VariantStoreCreatedWaiter) WaitForOutput(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreCreatedWaiterOptions)) (*GetVariantStoreOutput, error)

WaitForOutput calls the waiter function for VariantStoreCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type VariantStoreCreatedWaiterOptions 

type VariantStoreCreatedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// VariantStoreCreatedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, VariantStoreCreatedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetVariantStoreInput, *GetVariantStoreOutput, error) (bool, error)
}

VariantStoreCreatedWaiterOptions are waiter options for VariantStoreCreatedWaiter

type VariantStoreDeletedWaiter 

type VariantStoreDeletedWaiter struct {
	// contains filtered or unexported fields
}

VariantStoreDeletedWaiter defines the waiters for VariantStoreDeleted

func NewVariantStoreDeletedWaiter 

func NewVariantStoreDeletedWaiter(client GetVariantStoreAPIClient, optFns ...func(*VariantStoreDeletedWaiterOptions)) *VariantStoreDeletedWaiter

NewVariantStoreDeletedWaiter constructs a VariantStoreDeletedWaiter.

func (*VariantStoreDeletedWaiter) Wait 

func (w *VariantStoreDeletedWaiter) Wait(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreDeletedWaiterOptions)) error

Wait calls the waiter function for VariantStoreDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*VariantStoreDeletedWaiter) WaitForOutput 

func (w *VariantStoreDeletedWaiter) WaitForOutput(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreDeletedWaiterOptions)) (*GetVariantStoreOutput, error)

WaitForOutput calls the waiter function for VariantStoreDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type VariantStoreDeletedWaiterOptions 

type VariantStoreDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// VariantStoreDeletedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, VariantStoreDeletedWaiter will use default max delay of 600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetVariantStoreInput, *GetVariantStoreOutput, error) (bool, error)
}

VariantStoreDeletedWaiterOptions are waiter options for VariantStoreDeletedWaiter

type WorkflowActiveWaiter 

type WorkflowActiveWaiter struct {
	// contains filtered or unexported fields
}

WorkflowActiveWaiter defines the waiters for WorkflowActive

func NewWorkflowActiveWaiter 

func NewWorkflowActiveWaiter(client GetWorkflowAPIClient, optFns ...func(*WorkflowActiveWaiterOptions)) *WorkflowActiveWaiter

NewWorkflowActiveWaiter constructs a WorkflowActiveWaiter.

func (*WorkflowActiveWaiter) Wait 

func (w *WorkflowActiveWaiter) Wait(ctx context.Context, params *GetWorkflowInput, maxWaitDur time.Duration, optFns ...func(*WorkflowActiveWaiterOptions)) error

Wait calls the waiter function for WorkflowActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*WorkflowActiveWaiter) WaitForOutput 

func (w *WorkflowActiveWaiter) WaitForOutput(ctx context.Context, params *GetWorkflowInput, maxWaitDur time.Duration, optFns ...func(*WorkflowActiveWaiterOptions)) (*GetWorkflowOutput, error)

WaitForOutput calls the waiter function for WorkflowActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type WorkflowActiveWaiterOptions 

type WorkflowActiveWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// WorkflowActiveWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, WorkflowActiveWaiter will use default max delay of 30 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetWorkflowInput, *GetWorkflowOutput, error) (bool, error)
}

WorkflowActiveWaiterOptions are waiter options for WorkflowActiveWaiter

type WorkflowVersionActiveWaiter added in v1.30.0 

type WorkflowVersionActiveWaiter struct {
	// contains filtered or unexported fields
}

WorkflowVersionActiveWaiter defines the waiters for WorkflowVersionActive

func NewWorkflowVersionActiveWaiter added in v1.30.0 

func NewWorkflowVersionActiveWaiter(client GetWorkflowVersionAPIClient, optFns ...func(*WorkflowVersionActiveWaiterOptions)) *WorkflowVersionActiveWaiter

NewWorkflowVersionActiveWaiter constructs a WorkflowVersionActiveWaiter.

func (*WorkflowVersionActiveWaiter) Wait added in v1.30.0 

func (w *WorkflowVersionActiveWaiter) Wait(ctx context.Context, params *GetWorkflowVersionInput, maxWaitDur time.Duration, optFns ...func(*WorkflowVersionActiveWaiterOptions)) error

Wait calls the waiter function for WorkflowVersionActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*WorkflowVersionActiveWaiter) WaitForOutput added in v1.30.0 

func (w *WorkflowVersionActiveWaiter) WaitForOutput(ctx context.Context, params *GetWorkflowVersionInput, maxWaitDur time.Duration, optFns ...func(*WorkflowVersionActiveWaiterOptions)) (*GetWorkflowVersionOutput, error)

WaitForOutput calls the waiter function for WorkflowVersionActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type WorkflowVersionActiveWaiterOptions added in v1.30.0 

type WorkflowVersionActiveWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// WorkflowVersionActiveWaiter will use default minimum delay of 3 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, WorkflowVersionActiveWaiter will use default max delay of 30
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetWorkflowVersionInput, *GetWorkflowVersionOutput, error) (bool, error)
}

WorkflowVersionActiveWaiterOptions are waiter options for WorkflowVersionActiveWaiter

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.