@pgarbe/cdk-ecr-sync 0.5.18 → 0.5.22

package/node_modules/aws-sdk/clients/braket.d.ts

@@ -11,6 +11,14 @@ declare class Braket extends Service {
    */
   constructor(options?: Braket.Types.ClientConfiguration)
   config: Config & Braket.Types.ClientConfiguration;
+  /**
+   * Cancels an Amazon Braket job.
+   */
+  cancelJob(params: Braket.Types.CancelJobRequest, callback?: (err: AWSError, data: Braket.Types.CancelJobResponse) => void): Request<Braket.Types.CancelJobResponse, AWSError>;
+  /**
+   * Cancels an Amazon Braket job.
+   */
+  cancelJob(callback?: (err: AWSError, data: Braket.Types.CancelJobResponse) => void): Request<Braket.Types.CancelJobResponse, AWSError>;
   /**
    * Cancels the specified task.
    */
@@ -19,6 +27,14 @@ declare class Braket extends Service {
    * Cancels the specified task.
    */
   cancelQuantumTask(callback?: (err: AWSError, data: Braket.Types.CancelQuantumTaskResponse) => void): Request<Braket.Types.CancelQuantumTaskResponse, AWSError>;
+  /**
+   * Creates an Amazon Braket job.
+   */
+  createJob(params: Braket.Types.CreateJobRequest, callback?: (err: AWSError, data: Braket.Types.CreateJobResponse) => void): Request<Braket.Types.CreateJobResponse, AWSError>;
+  /**
+   * Creates an Amazon Braket job.
+   */
+  createJob(callback?: (err: AWSError, data: Braket.Types.CreateJobResponse) => void): Request<Braket.Types.CreateJobResponse, AWSError>;
   /**
    * Creates a quantum task.
    */
@@ -35,6 +51,14 @@ declare class Braket extends Service {
    * Retrieves the devices available in Amazon Braket.
    */
   getDevice(callback?: (err: AWSError, data: Braket.Types.GetDeviceResponse) => void): Request<Braket.Types.GetDeviceResponse, AWSError>;
+  /**
+   * Retrieves the specified Amazon Braket job.
+   */
+  getJob(params: Braket.Types.GetJobRequest, callback?: (err: AWSError, data: Braket.Types.GetJobResponse) => void): Request<Braket.Types.GetJobResponse, AWSError>;
+  /**
+   * Retrieves the specified Amazon Braket job.
+   */
+  getJob(callback?: (err: AWSError, data: Braket.Types.GetJobResponse) => void): Request<Braket.Types.GetJobResponse, AWSError>;
   /**
    * Retrieves the specified quantum task.
    */
@@ -59,6 +83,14 @@ declare class Braket extends Service {
    * Searches for devices using the specified filters.
    */
   searchDevices(callback?: (err: AWSError, data: Braket.Types.SearchDevicesResponse) => void): Request<Braket.Types.SearchDevicesResponse, AWSError>;
+  /**
+   * Searches for Amazon Braket jobs that match the specified filter values.
+   */
+  searchJobs(params: Braket.Types.SearchJobsRequest, callback?: (err: AWSError, data: Braket.Types.SearchJobsResponse) => void): Request<Braket.Types.SearchJobsResponse, AWSError>;
+  /**
+   * Searches for Amazon Braket jobs that match the specified filter values.
+   */
+  searchJobs(callback?: (err: AWSError, data: Braket.Types.SearchJobsResponse) => void): Request<Braket.Types.SearchJobsResponse, AWSError>;
   /**
    * Searches for tasks that match the specified filter values.
    */
@@ -85,6 +117,32 @@ declare class Braket extends Service {
   untagResource(callback?: (err: AWSError, data: Braket.Types.UntagResourceResponse) => void): Request<Braket.Types.UntagResourceResponse, AWSError>;
 }
 declare namespace Braket {
+  export interface AlgorithmSpecification {
+    /**
+     * 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;
+  }
+  export interface CancelJobRequest {
+    /**
+     * The ARN of the Amazon Braket job to cancel.
+     */
+    jobArn: JobArn;
+  }
+  export interface CancelJobResponse {
+    /**
+     * The status of the job cancellation request.
+     */
+    cancellationStatus: CancellationStatus;
+    /**
+     * The ARN of the Amazon Braket job.
+     */
+    jobArn: JobArn;
+  }
   export interface CancelQuantumTaskRequest {
     /**
      * The client token associated with the request.
@@ -106,6 +164,71 @@ declare namespace Braket {
     quantumTaskArn: QuantumTaskArn;
   }
   export type CancellationStatus = "CANCELLING"|"CANCELLED"|string;
+  export type CompressionType = "NONE"|"GZIP"|string;
+  export interface ContainerImage {
+    /**
+     * The URI locating the container image.
+     */
+    uri: Uri;
+  }
+  export interface CreateJobRequest {
+    /**
+     * Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
+     */
+    algorithmSpecification: AlgorithmSpecification;
+    /**
+     * Information about the output locations for job checkpoint data.
+     */
+    checkpointConfig?: JobCheckpointConfig;
+    /**
+     * A unique token that guarantees that the call to this API is idempotent.
+     */
+    clientToken: String64;
+    /**
+     * The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
+     */
+    deviceConfig: DeviceConfig;
+    /**
+     * Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
+     */
+    hyperParameters?: HyperParameters;
+    /**
+     * A list of parameters that specify the name and type of input data and where it is located.
+     */
+    inputDataConfig?: CreateJobRequestInputDataConfigList;
+    /**
+     * Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
+     */
+    instanceConfig: InstanceConfig;
+    /**
+     * The name of the Amazon Braket job.
+     */
+    jobName: CreateJobRequestJobNameString;
+    /**
+     * The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
+     */
+    outputDataConfig: JobOutputDataConfig;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
+     */
+    roleArn: RoleArn;
+    /**
+     *  The user-defined criteria that specifies when a job stops running.
+     */
+    stoppingCondition?: JobStoppingCondition;
+    /**
+     * A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
+     */
+    tags?: TagsMap;
+  }
+  export type CreateJobRequestInputDataConfigList = InputFileConfig[];
+  export type CreateJobRequestJobNameString = string;
+  export interface CreateJobResponse {
+    /**
+     * The ARN of the Amazon Braket job created.
+     */
+    jobArn: JobArn;
+  }
   export interface CreateQuantumTaskRequest {
     /**
      * The action associated with the task.
@@ -123,6 +246,10 @@ declare namespace Braket {
      * The parameters for the device to run the task on.
      */
     deviceParameters?: CreateQuantumTaskRequestDeviceParametersString;
+    /**
+     * The token for an Amazon Braket job that associates it with the quantum task.
+     */
+    jobToken?: JobToken;
     /**
      * The S3 bucket to store task result files in.
      */
@@ -150,7 +277,19 @@ declare namespace Braket {
      */
     quantumTaskArn: QuantumTaskArn;
   }
+  export interface DataSource {
+    /**
+     * Information about the data stored in Amazon S3 used by the Amazon Braket job.
+     */
+    s3DataSource: S3DataSource;
+  }
   export type DeviceArn = string;
+  export interface DeviceConfig {
+    /**
+     * The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
+     */
+    device: String256;
+  }
   export type DeviceStatus = "ONLINE"|"OFFLINE"|"RETIRED"|string;
   export interface DeviceSummary {
     /**
@@ -208,6 +347,91 @@ declare namespace Braket {
      */
     providerName: String;
   }
+  export interface GetJobRequest {
+    /**
+     * The ARN of the job to retrieve.
+     */
+    jobArn: JobArn;
+  }
+  export interface GetJobResponse {
+    /**
+     * Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
+     */
+    algorithmSpecification: AlgorithmSpecification;
+    /**
+     * The billable time the Amazon Braket job used to complete.
+     */
+    billableDuration?: Integer;
+    /**
+     * Information about the output locations for job checkpoint data.
+     */
+    checkpointConfig?: JobCheckpointConfig;
+    /**
+     * The date and time that the Amazon Braket job was created.
+     */
+    createdAt: SyntheticTimestamp_date_time;
+    /**
+     * The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
+     */
+    deviceConfig?: DeviceConfig;
+    /**
+     * The date and time that the Amazon Braket job ended.
+     */
+    endedAt?: SyntheticTimestamp_date_time;
+    /**
+     * Details about the type and time events occurred related to the Amazon Braket job.
+     */
+    events?: JobEvents;
+    /**
+     * A description of the reason why an Amazon Braket job failed, if it failed.
+     */
+    failureReason?: String1024;
+    /**
+     * Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
+     */
+    hyperParameters?: HyperParameters;
+    /**
+     * A list of parameters that specify the name and type of input data and where it is located.
+     */
+    inputDataConfig?: InputConfigList;
+    /**
+     * The resource instances to use while running the hybrid job on Amazon Braket.
+     */
+    instanceConfig: InstanceConfig;
+    /**
+     * The ARN of the Amazon Braket job.
+     */
+    jobArn: JobArn;
+    /**
+     * The name of the Amazon Braket job.
+     */
+    jobName: GetJobResponseJobNameString;
+    /**
+     * The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
+     */
+    outputDataConfig: JobOutputDataConfig;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.
+     */
+    roleArn: RoleArn;
+    /**
+     * The date and time that the Amazon Braket job was started.
+     */
+    startedAt?: SyntheticTimestamp_date_time;
+    /**
+     * The status of the Amazon Braket job.
+     */
+    status: JobPrimaryStatus;
+    /**
+     * The user-defined criteria that specifies when to stop a job running.
+     */
+    stoppingCondition?: JobStoppingCondition;
+    /**
+     * A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
+     */
+    tags?: TagsMap;
+  }
+  export type GetJobResponseJobNameString = string;
   export interface GetQuantumTaskRequest {
     /**
      * the ARN of the task to retrieve.
@@ -235,6 +459,10 @@ declare namespace Braket {
      * The reason that a task failed.
      */
     failureReason?: String;
+    /**
+     * The ARN of the Amazon Braket job associated with the quantum task.
+     */
+    jobArn?: JobArn;
     /**
      * The S3 bucket where task results are stored.
      */
@@ -260,6 +488,119 @@ declare namespace Braket {
      */
     tags?: TagsMap;
   }
+  export type HyperParameters = {[key: string]: HyperParametersValueString};
+  export type HyperParametersValueString = string;
+  export type InputConfigList = InputFileConfig[];
+  export interface InputFileConfig {
+    /**
+     * A named input source that an Amazon Braket job can consume.
+     */
+    channelName: InputFileConfigChannelNameString;
+    /**
+     * The MIME type of the data.
+     */
+    contentType?: String256;
+    /**
+     * The location of the channel data.
+     */
+    dataSource: DataSource;
+  }
+  export type InputFileConfigChannelNameString = string;
+  export interface InstanceConfig {
+    /**
+     * Configures the type resource instances to use while running an Amazon Braket hybrid job.
+     */
+    instanceType: InstanceType;
+    /**
+     * The size of the storage volume, in GB, that user wants to provision.
+     */
+    volumeSizeInGb: InstanceConfigVolumeSizeInGbInteger;
+  }
+  export type InstanceConfigVolumeSizeInGbInteger = number;
+  export type InstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.p4d.24xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|string;
+  export type Integer = number;
+  export type JobArn = string;
+  export interface JobCheckpointConfig {
+    /**
+     * (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.
+     */
+    localPath?: String4096;
+    /**
+     * Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.
+     */
+    s3Uri: S3Path;
+  }
+  export interface JobEventDetails {
+    /**
+     * 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?: JobEventDetailsMessageString;
+    /**
+     * TThe type of event that occurred related to the Amazon Braket job.
+     */
+    timeOfEvent?: SyntheticTimestamp_date_time;
+  }
+  export type JobEventDetailsMessageString = string;
+  export type JobEventType = "WAITING_FOR_PRIORITY"|"QUEUED_FOR_EXECUTION"|"STARTING_INSTANCE"|"DOWNLOADING_DATA"|"RUNNING"|"DEPRIORITIZED_DUE_TO_INACTIVITY"|"UPLOADING_RESULTS"|"COMPLETED"|"FAILED"|"MAX_RUNTIME_EXCEEDED"|"CANCELLED"|string;
+  export type JobEvents = JobEventDetails[];
+  export interface JobOutputDataConfig {
+    /**
+     * 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?: String2048;
+    /**
+     * Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.
+     */
+    s3Path: S3Path;
+  }
+  export type JobPrimaryStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED"|"CANCELLING"|"CANCELLED"|string;
+  export interface JobStoppingCondition {
+    /**
+     * The maximum length of time, in seconds, that an Amazon Braket job can run.
+     */
+    maxRuntimeInSeconds?: JobStoppingConditionMaxRuntimeInSecondsInteger;
+  }
+  export type JobStoppingConditionMaxRuntimeInSecondsInteger = number;
+  export interface JobSummary {
+    /**
+     * The date and time that the Amazon Braket job was created.
+     */
+    createdAt: SyntheticTimestamp_date_time;
+    /**
+     * Provides summary information about the primary device used by an Amazon Braket job.
+     */
+    device: String256;
+    /**
+     * The date and time that the Amazon Braket job ended.
+     */
+    endedAt?: SyntheticTimestamp_date_time;
+    /**
+     * The ARN of the Amazon Braket job.
+     */
+    jobArn: JobArn;
+    /**
+     * The name of the Amazon Braket job.
+     */
+    jobName: String;
+    /**
+     * The date and time that the Amazon Braket job was started.
+     */
+    startedAt?: SyntheticTimestamp_date_time;
+    /**
+     * The status of the Amazon Braket job.
+     */
+    status: JobPrimaryStatus;
+    /**
+     * A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
+     */
+    tags?: TagsMap;
+  }
+  export type JobSummaryList = JobSummary[];
+  export type JobToken = string;
   export type JsonValue = string;
   export interface ListTagsForResourceRequest {
     /**
@@ -315,6 +656,28 @@ declare namespace Braket {
     tags?: TagsMap;
   }
   export type QuantumTaskSummaryList = QuantumTaskSummary[];
+  export type RoleArn = string;
+  export interface S3DataSource {
+    /**
+     * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.
+     */
+    s3Uri: S3Path;
+  }
+  export type S3Path = string;
+  export interface ScriptModeConfig {
+    /**
+     * The type of compression used by the Python scripts for an Amazon Braket job.
+     */
+    compressionType?: CompressionType;
+    /**
+     * The path to the Python script that serves as the entry point for an Amazon Braket job.
+     */
+    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.
+     */
+    s3Uri: S3Path;
+  }
   export interface SearchDevicesFilter {
     /**
      * The name to use to filter results.
@@ -353,6 +716,48 @@ declare namespace Braket {
      */
     nextToken?: String;
   }
+  export interface SearchJobsFilter {
+    /**
+     * The name to use for the jobs filter.
+     */
+    name: String64;
+    /**
+     * An operator to use for the jobs filter.
+     */
+    operator: SearchJobsFilterOperator;
+    /**
+     * The values to use for the jobs filter.
+     */
+    values: SearchJobsFilterValuesList;
+  }
+  export type SearchJobsFilterOperator = "LT"|"LTE"|"EQUAL"|"GT"|"GTE"|"BETWEEN"|"CONTAINS"|string;
+  export type SearchJobsFilterValuesList = String256[];
+  export interface SearchJobsRequest {
+    /**
+     * The filter values to use when searching for a job.
+     */
+    filters: SearchJobsRequestFiltersList;
+    /**
+     * The maximum number of results to return in the response.
+     */
+    maxResults?: SearchJobsRequestMaxResultsInteger;
+    /**
+     * A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
+     */
+    nextToken?: String;
+  }
+  export type SearchJobsRequestFiltersList = SearchJobsFilter[];
+  export type SearchJobsRequestMaxResultsInteger = number;
+  export interface SearchJobsResponse {
+    /**
+     * An array of JobSummary objects for devices that match the specified filter values.
+     */
+    jobs: JobSummaryList;
+    /**
+     * A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
+     */
+    nextToken?: String;
+  }
   export interface SearchQuantumTasksFilter {
     /**
      * The name of the device used for the task.
@@ -396,7 +801,10 @@ declare namespace Braket {
     quantumTasks: QuantumTaskSummaryList;
   }
   export type String = string;
+  export type String1024 = string;
+  export type String2048 = string;
   export type String256 = string;
+  export type String4096 = string;
   export type String64 = string;
   export type SyntheticTimestamp_date_time = Date;
   export type TagKeys = String[];
@@ -425,6 +833,7 @@ declare namespace Braket {
   }
   export interface UntagResourceResponse {
   }
+  export type Uri = string;
   /**
    * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
    */