// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Defines the Amazon Braket job to be created. Specifies the container image the
// job uses and the paths to the Python scripts used for entry and training.
type AlgorithmSpecification struct {

	// The container image used to create an Amazon Braket job.
	ContainerImage *ContainerImage

	// Configures the paths to the Python scripts used for entry and training.
	ScriptModeConfig *ScriptModeConfig

	noSmithyDocumentSerde
}

// The Amazon Braket resource and the association type.
type Association struct {

	// The Amazon Braket resource arn.
	//
	// This member is required.
	Arn *string

	// The association type for the specified Amazon Braket resource arn.
	//
	// This member is required.
	Type AssociationType

	noSmithyDocumentSerde
}

// The container image used to create an Amazon Braket job.
type ContainerImage struct {

	// The URI locating the container image.
	//
	// This member is required.
	Uri *string

	noSmithyDocumentSerde
}

// Information about the source of the data used by the Amazon Braket job.
type DataSource struct {

	// Information about the data stored in Amazon S3 used by the Amazon Braket job.
	//
	// This member is required.
	S3DataSource *S3DataSource

	noSmithyDocumentSerde
}

// Configures the quantum processing units (QPUs) or simulator used to create and
// run an Amazon Braket job.
type DeviceConfig struct {

	// The primary quantum processing unit (QPU) or simulator used to create and run
	// an Amazon Braket job.
	//
	// This member is required.
	Device *string

	noSmithyDocumentSerde
}

// Information about tasks and jobs queued on a device.
type DeviceQueueInfo struct {

	// The name of the queue.
	//
	// This member is required.
	Queue QueueName

	// The number of jobs or tasks in the queue for a given device.
	//
	// This member is required.
	QueueSize *string

	// Optional. Specifies the priority of the queue. Tasks in a priority queue are
	// processed before the tasks in a normal queue.
	QueuePriority QueuePriority

	noSmithyDocumentSerde
}

// Includes information about the device.
type DeviceSummary struct {

	// The ARN of the device.
	//
	// This member is required.
	DeviceArn *string

	// The name of the device.
	//
	// This member is required.
	DeviceName *string

	// The status of the device.
	//
	// This member is required.
	DeviceStatus DeviceStatus

	// The type of the device.
	//
	// This member is required.
	DeviceType DeviceType

	// The provider of the device.
	//
	// This member is required.
	ProviderName *string

	noSmithyDocumentSerde
}

// Information about the queue for a specified job.
type HybridJobQueueInfo struct {

	// Current position of the job in the jobs queue.
	//
	// This member is required.
	Position *string

	// The name of the queue.
	//
	// This member is required.
	Queue QueueName

	// Optional. Provides more information about the queue position. For example, if
	// the job is complete and no longer in the queue, the message field contains that
	// information.
	Message *string

	noSmithyDocumentSerde
}

// A list of parameters that specify the input channels, type of input data, and
// where it is located.
type InputFileConfig struct {

	// A named input source that an Amazon Braket job can consume.
	//
	// This member is required.
	ChannelName *string

	// The location of the channel data.
	//
	// This member is required.
	DataSource *DataSource

	// The MIME type of the data.
	ContentType *string

	noSmithyDocumentSerde
}

// Configures the resource instances to use while running the Amazon Braket hybrid
// job on Amazon Braket.
type InstanceConfig struct {

	// Configures the type resource instances to use while running an Amazon Braket
	// hybrid job.
	//
	// This member is required.
	InstanceType InstanceType

	// The size of the storage volume, in GB, that user wants to provision.
	//
	// This member is required.
	VolumeSizeInGb *int32

	// Configures the number of resource instances to use while running an Amazon
	// Braket job on Amazon Braket. The default value is 1.
	InstanceCount *int32

	noSmithyDocumentSerde
}

// Contains information about the output locations for job checkpoint data.
type JobCheckpointConfig struct {

	// Identifies the S3 path where you want Amazon Braket to store checkpoints. For
	// example, s3://bucket-name/key-name-prefix .
	//
	// This member is required.
	S3Uri *string

	// (Optional) The local directory where checkpoints are written. The default
	// directory is /opt/braket/checkpoints/ .
	LocalPath *string

	noSmithyDocumentSerde
}

// Details about the type and time events occurred related to the Amazon Braket
// job.
type JobEventDetails struct {

	// The type of event that occurred related to the Amazon Braket job.
	EventType JobEventType

	// A message describing the event that occurred related to the Amazon Braket job.
	Message *string

	// The type of event that occurred related to the Amazon Braket job.
	TimeOfEvent *time.Time

	noSmithyDocumentSerde
}

// Specifies the path to the S3 location where you want to store job artifacts and
// the encryption key used to store them.
type JobOutputDataConfig struct {

	// Identifies the S3 path where you want Amazon Braket to store the job training
	// artifacts. For example, s3://bucket-name/key-name-prefix .
	//
	// This member is required.
	S3Path *string

	// The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt
	// the job training artifacts at rest using Amazon S3 server-side encryption.
	KmsKeyId *string

	noSmithyDocumentSerde
}

// Specifies limits for how long an Amazon Braket job can run.
type JobStoppingCondition struct {

	// The maximum length of time, in seconds, that an Amazon Braket job can run.
	MaxRuntimeInSeconds *int32

	noSmithyDocumentSerde
}

// Provides summary information about an Amazon Braket job.
type JobSummary struct {

	// The date and time that the Amazon Braket job was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Provides summary information about the primary device used by an Amazon Braket
	// job.
	//
	// This member is required.
	Device *string

	// The ARN of the Amazon Braket job.
	//
	// This member is required.
	JobArn *string

	// The name of the Amazon Braket job.
	//
	// This member is required.
	JobName *string

	// The status of the Amazon Braket job.
	//
	// This member is required.
	Status JobPrimaryStatus

	// The date and time that the Amazon Braket job ended.
	EndedAt *time.Time

	// The date and time that the Amazon Braket job was started.
	StartedAt *time.Time

	// A tag object that consists of a key and an optional value, used to manage
	// metadata for Amazon Braket resources.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Information about the queue for the specified quantum task.
type QuantumTaskQueueInfo struct {

	// Current position of the task in the quantum tasks queue.
	//
	// This member is required.
	Position *string

	// The name of the queue.
	//
	// This member is required.
	Queue QueueName

	// Optional. Provides more information about the queue position. For example, if
	// the task is complete and no longer in the queue, the message field contains that
	// information.
	Message *string

	// Optional. Specifies the priority of the queue. Quantum tasks in a priority
	// queue are processed before the tasks in a normal queue.
	QueuePriority QueuePriority

	noSmithyDocumentSerde
}

// Includes information about a quantum task.
type QuantumTaskSummary struct {

	// The time at which the task was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ARN of the device the task ran on.
	//
	// This member is required.
	DeviceArn *string

	// The S3 bucket where the task result file is stored..
	//
	// This member is required.
	OutputS3Bucket *string

	// The folder in the S3 bucket where the task result file is stored.
	//
	// This member is required.
	OutputS3Directory *string

	// The ARN of the task.
	//
	// This member is required.
	QuantumTaskArn *string

	// The shots used for the task.
	//
	// This member is required.
	Shots *int64

	// The status of the task.
	//
	// This member is required.
	Status QuantumTaskStatus

	// The time at which the task finished.
	EndedAt *time.Time

	// Displays the key, value pairs of tags associated with this quantum task.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Information about the data stored in Amazon S3 used by the Amazon Braket job.
type S3DataSource struct {

	// Depending on the value specified for the S3DataType , identifies either a key
	// name prefix or a manifest that locates the S3 data source.
	//
	// This member is required.
	S3Uri *string

	noSmithyDocumentSerde
}

// Contains information about the Python scripts used for entry and by an Amazon
// Braket job.
type ScriptModeConfig struct {

	// The path to the Python script that serves as the entry point for an Amazon
	// Braket job.
	//
	// This member is required.
	EntryPoint *string

	// The URI that specifies the S3 path to the Python script module that contains
	// the training script used by an Amazon Braket job.
	//
	// This member is required.
	S3Uri *string

	// The type of compression used by the Python scripts for an Amazon Braket job.
	CompressionType CompressionType

	noSmithyDocumentSerde
}

// The filter to use for searching devices.
type SearchDevicesFilter struct {

	// The name to use to filter results.
	//
	// This member is required.
	Name *string

	// The values to use to filter results.
	//
	// This member is required.
	Values []string

	noSmithyDocumentSerde
}

// A filter used to search for Amazon Braket jobs.
type SearchJobsFilter struct {

	// The name to use for the jobs filter.
	//
	// This member is required.
	Name *string

	// An operator to use for the jobs filter.
	//
	// This member is required.
	Operator SearchJobsFilterOperator

	// The values to use for the jobs filter.
	//
	// This member is required.
	Values []string

	noSmithyDocumentSerde
}

// A filter to use to search for tasks.
type SearchQuantumTasksFilter struct {

	// The name of the device used for the task.
	//
	// This member is required.
	Name *string

	// An operator to use in the filter.
	//
	// This member is required.
	Operator SearchQuantumTasksFilterOperator

	// The values to use for the filter.
	//
	// This member is required.
	Values []string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde