@aws-sdk/client-braket 3.296.0 → 3.298.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { BraketServiceException as __BaseException } from "./BraketServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The container image used to create an Amazon Braket job.</p>
  */
 export interface ContainerImage {
@@ -20,11 +22,15 @@ export interface ContainerImage {
      */
     uri: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum CompressionType {
     GZIP = "GZIP",
     NONE = "NONE"
 }
 /**
+ * @public
  * <p>Contains information about the Python scripts used for entry and by an Amazon Braket
  *          job.</p>
  */
@@ -45,6 +51,7 @@ export interface ScriptModeConfig {
     compressionType?: CompressionType | string;
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -58,21 +65,33 @@ export interface AlgorithmSpecification {
      */
     containerImage?: ContainerImage;
 }
+/**
+ * @public
+ */
 export interface GetDeviceRequest {
     /**
      * <p>The ARN of the device to retrieve.</p>
      */
     deviceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum DeviceStatus {
     OFFLINE = "OFFLINE",
     ONLINE = "ONLINE",
     RETIRED = "RETIRED"
 }
+/**
+ * @public
+ */
 export declare enum DeviceType {
     QPU = "QPU",
     SIMULATOR = "SIMULATOR"
 }
+/**
+ * @public
+ */
 export interface GetDeviceResponse {
     /**
      * <p>The ARN of the device.</p>
@@ -100,6 +119,7 @@ export interface GetDeviceResponse {
     deviceCapabilities: __LazyJsonString | string | undefined;
 }
 /**
+ * @public
  * <p>The request processing has failed because of an unknown error, exception, or
  *          failure.</p>
  */
@@ -112,6 +132,7 @@ export declare class InternalServiceException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified resource was not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -123,6 +144,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The throttling rate limit is met.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -134,6 +156,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -145,6 +168,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p>The filter to use for searching devices.</p>
  */
 export interface SearchDevicesFilter {
@@ -157,6 +181,9 @@ export interface SearchDevicesFilter {
      */
     values: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface SearchDevicesRequest {
     /**
      * <p>A token used for pagination of results returned in the response. Use the token returned
@@ -173,6 +200,7 @@ export interface SearchDevicesRequest {
     filters: SearchDevicesFilter[] | undefined;
 }
 /**
+ * @public
  * <p>Includes information about the device.</p>
  */
 export interface DeviceSummary {
@@ -197,6 +225,9 @@ export interface DeviceSummary {
      */
     deviceStatus: DeviceStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface SearchDevicesResponse {
     /**
      * <p>An array of <code>DeviceSummary</code> objects for devices that match the specified
@@ -210,16 +241,25 @@ export interface SearchDevicesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface CancelJobRequest {
     /**
      * <p>The ARN of the Amazon Braket job to cancel.</p>
      */
     jobArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum CancellationStatus {
     CANCELLED = "CANCELLED",
     CANCELLING = "CANCELLING"
 }
+/**
+ * @public
+ */
 export interface CancelJobResponse {
     /**
      * <p>The ARN of the Amazon Braket job.</p>
@@ -231,6 +271,7 @@ export interface CancelJobResponse {
     cancellationStatus: CancellationStatus | string | undefined;
 }
 /**
+ * @public
  * <p>An error occurred due to a conflict.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -242,6 +283,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>Contains information about the output locations for job checkpoint data.</p>
  */
 export interface JobCheckpointConfig {
@@ -257,6 +299,7 @@ export interface JobCheckpointConfig {
     s3Uri: string | undefined;
 }
 /**
+ * @public
  * <p>Configures the quantum processing units (QPUs) or simulator used to create and run an
  *          Amazon Braket job.</p>
  */
@@ -268,6 +311,7 @@ export interface DeviceConfig {
     device: string | undefined;
 }
 /**
+ * @public
  * <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
  */
 export interface S3DataSource {
@@ -278,6 +322,7 @@ export interface S3DataSource {
     s3Uri: string | undefined;
 }
 /**
+ * @public
  * <p>Information about the source of the data used by the Amazon Braket job.</p>
  */
 export interface DataSource {
@@ -287,6 +332,7 @@ export interface DataSource {
     s3DataSource: S3DataSource | undefined;
 }
 /**
+ * @public
  * <p>A list of parameters that specify the input channels, type of input data, and where it
  *          is located.</p>
  */
@@ -304,6 +350,9 @@ export interface InputFileConfig {
      */
     dataSource: DataSource | undefined;
 }
+/**
+ * @public
+ */
 export declare enum _InstanceType {
     ML_C4_2XLARGE = "ml.c4.2xlarge",
     ML_C4_4XLARGE = "ml.c4.4xlarge",
@@ -346,6 +395,7 @@ export declare enum _InstanceType {
     ML_P4D_24XLARGE = "ml.p4d.24xlarge"
 }
 /**
+ * @public
  * <p>Configures the resource instances to use while running the Amazon Braket hybrid job on
  *          Amazon Braket.</p>
  */
@@ -366,6 +416,7 @@ export interface InstanceConfig {
     instanceCount?: number;
 }
 /**
+ * @public
  * <p>Specifies the path to the S3 location where you want to store job artifacts and the
  *          encryption key used to store them.</p>
  */
@@ -382,6 +433,7 @@ export interface JobOutputDataConfig {
     s3Path: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies limits for how long an Amazon Braket job can run. </p>
  */
 export interface JobStoppingCondition {
@@ -390,6 +442,9 @@ export interface JobStoppingCondition {
      */
     maxRuntimeInSeconds?: number;
 }
+/**
+ * @public
+ */
 export interface CreateJobRequest {
     /**
      * <p>A unique token that guarantees that the call to this API is idempotent.</p>
@@ -450,6 +505,9 @@ export interface CreateJobRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CreateJobResponse {
     /**
      * <p>The ARN of the Amazon Braket job created.</p>
@@ -457,6 +515,7 @@ export interface CreateJobResponse {
     jobArn: string | undefined;
 }
 /**
+ * @public
  * <p>The specified device has been retired.</p>
  */
 export declare class DeviceRetiredException extends __BaseException {
@@ -468,6 +527,7 @@ export declare class DeviceRetiredException extends __BaseException {
     constructor(opts: __ExceptionOptionType<DeviceRetiredException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request failed because a service quota is exceeded.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -478,12 +538,18 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetJobRequest {
     /**
      * <p>The ARN of the job to retrieve.</p>
      */
     jobArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum JobEventType {
     CANCELLED = "CANCELLED",
     COMPLETED = "COMPLETED",
@@ -498,6 +564,7 @@ export declare enum JobEventType {
     WAITING_FOR_PRIORITY = "WAITING_FOR_PRIORITY"
 }
 /**
+ * @public
  * <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
  */
 export interface JobEventDetails {
@@ -514,6 +581,9 @@ export interface JobEventDetails {
      */
     message?: string;
 }
+/**
+ * @public
+ */
 export declare enum JobPrimaryStatus {
     CANCELLED = "CANCELLED",
     CANCELLING = "CANCELLING",
@@ -522,6 +592,9 @@ export declare enum JobPrimaryStatus {
     QUEUED = "QUEUED",
     RUNNING = "RUNNING"
 }
+/**
+ * @public
+ */
 export interface GetJobResponse {
     /**
      * <p>The status of the Amazon Braket job.</p>
@@ -609,6 +682,9 @@ export interface GetJobResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum SearchJobsFilterOperator {
     BETWEEN = "BETWEEN",
     CONTAINS = "CONTAINS",
@@ -619,6 +695,7 @@ export declare enum SearchJobsFilterOperator {
     LTE = "LTE"
 }
 /**
+ * @public
  * <p>A filter used to search for Amazon Braket jobs.</p>
  */
 export interface SearchJobsFilter {
@@ -635,6 +712,9 @@ export interface SearchJobsFilter {
      */
     operator: SearchJobsFilterOperator | string | undefined;
 }
+/**
+ * @public
+ */
 export interface SearchJobsRequest {
     /**
      * <p>A token used for pagination of results returned in the response. Use the token returned
@@ -651,6 +731,7 @@ export interface SearchJobsRequest {
     filters: SearchJobsFilter[] | undefined;
 }
 /**
+ * @public
  * <p>Provides summary information about an Amazon Braket job.</p>
  */
 export interface JobSummary {
@@ -689,6 +770,9 @@ export interface JobSummary {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface SearchJobsResponse {
     /**
      * <p>An array of <code>JobSummary</code> objects for devices that match the specified filter
@@ -702,18 +786,27 @@ export interface SearchJobsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>Specify the <code>resourceArn</code> for the resource whose tags to display.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>Displays the key, value pairs of tags associated with this resource.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CancelQuantumTaskRequest {
     /**
      * <p>The ARN of the task to cancel.</p>
@@ -724,6 +817,9 @@ export interface CancelQuantumTaskRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CancelQuantumTaskResponse {
     /**
      * <p>The ARN of the task.</p>
@@ -734,6 +830,9 @@ export interface CancelQuantumTaskResponse {
      */
     cancellationStatus: CancellationStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateQuantumTaskRequest {
     /**
      * <p>The client token associated with the request.</p>
@@ -772,6 +871,9 @@ export interface CreateQuantumTaskRequest {
      */
     jobToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateQuantumTaskResponse {
     /**
      * <p>The ARN of the task created by the request.</p>
@@ -779,6 +881,7 @@ export interface CreateQuantumTaskResponse {
     quantumTaskArn: string | undefined;
 }
 /**
+ * @public
  * <p>The specified device is currently offline.</p>
  */
 export declare class DeviceOfflineException extends __BaseException {
@@ -789,12 +892,18 @@ export declare class DeviceOfflineException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DeviceOfflineException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetQuantumTaskRequest {
     /**
      * <p>the ARN of the task to retrieve.</p>
      */
     quantumTaskArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum QuantumTaskStatus {
     CANCELLED = "CANCELLED",
     CANCELLING = "CANCELLING",
@@ -804,6 +913,9 @@ export declare enum QuantumTaskStatus {
     QUEUED = "QUEUED",
     RUNNING = "RUNNING"
 }
+/**
+ * @public
+ */
 export interface GetQuantumTaskResponse {
     /**
      * <p>The ARN of the task.</p>
@@ -854,6 +966,9 @@ export interface GetQuantumTaskResponse {
      */
     jobArn?: string;
 }
+/**
+ * @public
+ */
 export declare enum SearchQuantumTasksFilterOperator {
     BETWEEN = "BETWEEN",
     EQUAL = "EQUAL",
@@ -863,6 +978,7 @@ export declare enum SearchQuantumTasksFilterOperator {
     LTE = "LTE"
 }
 /**
+ * @public
  * <p>A filter to use to search for tasks.</p>
  */
 export interface SearchQuantumTasksFilter {
@@ -879,6 +995,9 @@ export interface SearchQuantumTasksFilter {
      */
     operator: SearchQuantumTasksFilterOperator | string | undefined;
 }
+/**
+ * @public
+ */
 export interface SearchQuantumTasksRequest {
     /**
      * <p>A token used for pagination of results returned in the response. Use the token returned
@@ -895,6 +1014,7 @@ export interface SearchQuantumTasksRequest {
     filters: SearchQuantumTasksFilter[] | undefined;
 }
 /**
+ * @public
  * <p>Includes information about a quantum task.</p>
  */
 export interface QuantumTaskSummary {
@@ -935,6 +1055,9 @@ export interface QuantumTaskSummary {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface SearchQuantumTasksResponse {
     /**
      * <p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified
@@ -948,6 +1071,9 @@ export interface SearchQuantumTasksResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>Specify the <code>resourceArn</code> of the resource to which a tag will be
@@ -959,8 +1085,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>Specify the <code>resourceArn</code> for the resource from which to remove the
@@ -972,181 +1104,8 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
-export interface UntagResourceResponse {
-}
-/**
- * @internal
- */
-export declare const ContainerImageFilterSensitiveLog: (obj: ContainerImage) => any;
-/**
- * @internal
- */
-export declare const ScriptModeConfigFilterSensitiveLog: (obj: ScriptModeConfig) => any;
-/**
- * @internal
- */
-export declare const AlgorithmSpecificationFilterSensitiveLog: (obj: AlgorithmSpecification) => any;
-/**
- * @internal
- */
-export declare const GetDeviceRequestFilterSensitiveLog: (obj: GetDeviceRequest) => any;
 /**
- * @internal
+ * @public
  */
-export declare const GetDeviceResponseFilterSensitiveLog: (obj: GetDeviceResponse) => any;
-/**
- * @internal
- */
-export declare const SearchDevicesFilterFilterSensitiveLog: (obj: SearchDevicesFilter) => any;
-/**
- * @internal
- */
-export declare const SearchDevicesRequestFilterSensitiveLog: (obj: SearchDevicesRequest) => any;
-/**
- * @internal
- */
-export declare const DeviceSummaryFilterSensitiveLog: (obj: DeviceSummary) => any;
-/**
- * @internal
- */
-export declare const SearchDevicesResponseFilterSensitiveLog: (obj: SearchDevicesResponse) => any;
-/**
- * @internal
- */
-export declare const CancelJobRequestFilterSensitiveLog: (obj: CancelJobRequest) => any;
-/**
- * @internal
- */
-export declare const CancelJobResponseFilterSensitiveLog: (obj: CancelJobResponse) => any;
-/**
- * @internal
- */
-export declare const JobCheckpointConfigFilterSensitiveLog: (obj: JobCheckpointConfig) => any;
-/**
- * @internal
- */
-export declare const DeviceConfigFilterSensitiveLog: (obj: DeviceConfig) => any;
-/**
- * @internal
- */
-export declare const S3DataSourceFilterSensitiveLog: (obj: S3DataSource) => any;
-/**
- * @internal
- */
-export declare const DataSourceFilterSensitiveLog: (obj: DataSource) => any;
-/**
- * @internal
- */
-export declare const InputFileConfigFilterSensitiveLog: (obj: InputFileConfig) => any;
-/**
- * @internal
- */
-export declare const InstanceConfigFilterSensitiveLog: (obj: InstanceConfig) => any;
-/**
- * @internal
- */
-export declare const JobOutputDataConfigFilterSensitiveLog: (obj: JobOutputDataConfig) => any;
-/**
- * @internal
- */
-export declare const JobStoppingConditionFilterSensitiveLog: (obj: JobStoppingCondition) => any;
-/**
- * @internal
- */
-export declare const CreateJobRequestFilterSensitiveLog: (obj: CreateJobRequest) => any;
-/**
- * @internal
- */
-export declare const CreateJobResponseFilterSensitiveLog: (obj: CreateJobResponse) => any;
-/**
- * @internal
- */
-export declare const GetJobRequestFilterSensitiveLog: (obj: GetJobRequest) => any;
-/**
- * @internal
- */
-export declare const JobEventDetailsFilterSensitiveLog: (obj: JobEventDetails) => any;
-/**
- * @internal
- */
-export declare const GetJobResponseFilterSensitiveLog: (obj: GetJobResponse) => any;
-/**
- * @internal
- */
-export declare const SearchJobsFilterFilterSensitiveLog: (obj: SearchJobsFilter) => any;
-/**
- * @internal
- */
-export declare const SearchJobsRequestFilterSensitiveLog: (obj: SearchJobsRequest) => any;
-/**
- * @internal
- */
-export declare const JobSummaryFilterSensitiveLog: (obj: JobSummary) => any;
-/**
- * @internal
- */
-export declare const SearchJobsResponseFilterSensitiveLog: (obj: SearchJobsResponse) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
-/**
- * @internal
- */
-export declare const CancelQuantumTaskRequestFilterSensitiveLog: (obj: CancelQuantumTaskRequest) => any;
-/**
- * @internal
- */
-export declare const CancelQuantumTaskResponseFilterSensitiveLog: (obj: CancelQuantumTaskResponse) => any;
-/**
- * @internal
- */
-export declare const CreateQuantumTaskRequestFilterSensitiveLog: (obj: CreateQuantumTaskRequest) => any;
-/**
- * @internal
- */
-export declare const CreateQuantumTaskResponseFilterSensitiveLog: (obj: CreateQuantumTaskResponse) => any;
-/**
- * @internal
- */
-export declare const GetQuantumTaskRequestFilterSensitiveLog: (obj: GetQuantumTaskRequest) => any;
-/**
- * @internal
- */
-export declare const GetQuantumTaskResponseFilterSensitiveLog: (obj: GetQuantumTaskResponse) => any;
-/**
- * @internal
- */
-export declare const SearchQuantumTasksFilterFilterSensitiveLog: (obj: SearchQuantumTasksFilter) => any;
-/**
- * @internal
- */
-export declare const SearchQuantumTasksRequestFilterSensitiveLog: (obj: SearchQuantumTasksRequest) => any;
-/**
- * @internal
- */
-export declare const QuantumTaskSummaryFilterSensitiveLog: (obj: QuantumTaskSummary) => any;
-/**
- * @internal
- */
-export declare const SearchQuantumTasksResponseFilterSensitiveLog: (obj: SearchQuantumTasksResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
+export interface UntagResourceResponse {
+}

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { BraketClient } from "../BraketClient";
+/**
+ * @public
+ */
 export interface BraketPaginationConfiguration extends PaginationConfiguration {
     client: BraketClient;
 }