@aws-sdk/client-emr-containers 3.295.0 → 3.297.0

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { EMRContainersServiceException as __BaseException } from "./EMRContainersServiceException";
+/**
+ * @public
+ */
 export interface CancelJobRunRequest {
     /**
      * <p>The ID of the job run to cancel.</p>
@@ -10,6 +13,9 @@ export interface CancelJobRunRequest {
      */
     virtualClusterId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CancelJobRunResponse {
     /**
      * <p>The output contains the ID of the cancelled job run.</p>
@@ -21,6 +27,7 @@ export interface CancelJobRunResponse {
     virtualClusterId?: string;
 }
 /**
+ * @public
  * <p>This is an internal server exception.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -32,6 +39,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>There are invalid parameters in the client request.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -43,6 +51,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p> A configuration for CloudWatch monitoring. You can configure your jobs to send log
  *          information to CloudWatch Logs. This data type allows job template parameters to be
  *          specified within.</p>
@@ -58,6 +67,7 @@ export interface ParametricCloudWatchMonitoringConfiguration {
     logStreamNamePrefix?: string;
 }
 /**
+ * @public
  * <p> Amazon S3 configuration for monitoring log publishing. You can configure your jobs to
  *          send log information to Amazon S3. This data type allows job template parameters to be
  *          specified within.</p>
@@ -69,6 +79,7 @@ export interface ParametricS3MonitoringConfiguration {
     logUri?: string;
 }
 /**
+ * @public
  * <p> Configuration setting for monitoring. This data type allows job template parameters to
  *          be specified within.</p>
  */
@@ -87,6 +98,7 @@ export interface ParametricMonitoringConfiguration {
     s3MonitoringConfiguration?: ParametricS3MonitoringConfiguration;
 }
 /**
+ * @public
  * <p>The job driver for job type.</p>
  */
 export interface SparkSqlJobDriver {
@@ -100,6 +112,7 @@ export interface SparkSqlJobDriver {
     sparkSqlParameters?: string;
 }
 /**
+ * @public
  * <p>The information about job driver for Spark submit.</p>
  */
 export interface SparkSubmitJobDriver {
@@ -117,6 +130,7 @@ export interface SparkSubmitJobDriver {
     sparkSubmitParameters?: string;
 }
 /**
+ * @public
  * <p>Specify the driver that the job runs on. Exactly one of the two available job drivers is
  *          required, either sparkSqlJobDriver or sparkSubmitJobDriver.</p>
  */
@@ -130,11 +144,15 @@ export interface JobDriver {
      */
     sparkSqlJobDriver?: SparkSqlJobDriver;
 }
+/**
+ * @public
+ */
 export declare enum TemplateParameterDataType {
     NUMBER = "NUMBER",
     STRING = "STRING"
 }
 /**
+ * @public
  * <p>The configuration of a job template parameter.</p>
  */
 export interface TemplateParameterConfiguration {
@@ -147,6 +165,9 @@ export interface TemplateParameterConfiguration {
      */
     defaultValue?: string;
 }
+/**
+ * @public
+ */
 export interface CreateJobTemplateResponse {
     /**
      * <p>This output display the created job template ID.</p>
@@ -166,6 +187,7 @@ export interface CreateJobTemplateResponse {
     createdAt?: Date;
 }
 /**
+ * @public
  * <p>The specified resource was not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -177,6 +199,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>A configuration for CloudWatch monitoring. You can configure your jobs to send log
  *          information to CloudWatch Logs.</p>
  */
@@ -190,11 +213,15 @@ export interface CloudWatchMonitoringConfiguration {
      */
     logStreamNamePrefix?: string;
 }
+/**
+ * @public
+ */
 export declare enum PersistentAppUI {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p> Amazon S3 configuration for monitoring log publishing. You can configure your jobs to
  *          send log information to Amazon S3.</p>
  */
@@ -205,6 +232,7 @@ export interface S3MonitoringConfiguration {
     logUri: string | undefined;
 }
 /**
+ * @public
  * <p>Configuration setting for monitoring.</p>
  */
 export interface MonitoringConfiguration {
@@ -221,6 +249,9 @@ export interface MonitoringConfiguration {
      */
     s3MonitoringConfiguration?: S3MonitoringConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateManagedEndpointResponse {
     /**
      * <p>The output contains the ID of the managed endpoint.</p>
@@ -240,6 +271,7 @@ export interface CreateManagedEndpointResponse {
     virtualClusterId?: string;
 }
 /**
+ * @public
  * <p>The information about the Amazon EKS cluster.</p>
  */
 export interface EksInfo {
@@ -249,9 +281,13 @@ export interface EksInfo {
     namespace?: string;
 }
 /**
+ * @public
  * <p>The information about the container used for a job run or a managed endpoint.</p>
  */
 export type ContainerInfo = ContainerInfo.EksInfoMember | ContainerInfo.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace ContainerInfo {
     /**
      * <p>The information about the Amazon EKS cluster.</p>
@@ -270,10 +306,14 @@ export declare namespace ContainerInfo {
     }
     const visit: <T>(value: ContainerInfo, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export declare enum ContainerProviderType {
     EKS = "EKS"
 }
 /**
+ * @public
  * <p>The information about the container provider.</p>
  */
 export interface ContainerProvider {
@@ -290,6 +330,9 @@ export interface ContainerProvider {
      */
     info?: ContainerInfo;
 }
+/**
+ * @public
+ */
 export interface CreateVirtualClusterRequest {
     /**
      * <p>The specified name of the virtual cluster.</p>
@@ -308,6 +351,9 @@ export interface CreateVirtualClusterRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CreateVirtualClusterResponse {
     /**
      * <p>This output contains the virtual cluster ID.</p>
@@ -322,18 +368,27 @@ export interface CreateVirtualClusterResponse {
      */
     arn?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteJobTemplateRequest {
     /**
      * <p>The ID of the job template that will be deleted.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteJobTemplateResponse {
     /**
      * <p>This output contains the ID of the job template that was deleted.</p>
      */
     id?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteManagedEndpointRequest {
     /**
      * <p>The ID of the managed endpoint.</p>
@@ -344,6 +399,9 @@ export interface DeleteManagedEndpointRequest {
      */
     virtualClusterId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteManagedEndpointResponse {
     /**
      * <p>The output displays the ID of the managed endpoint.</p>
@@ -354,18 +412,27 @@ export interface DeleteManagedEndpointResponse {
      */
     virtualClusterId?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteVirtualClusterRequest {
     /**
      * <p>The ID of the virtual cluster that will be deleted.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteVirtualClusterResponse {
     /**
      * <p>This output contains the ID of the virtual cluster that will be deleted. </p>
      */
     id?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeJobRunRequest {
     /**
      * <p>The ID of the job run request. </p>
@@ -376,6 +443,9 @@ export interface DescribeJobRunRequest {
      */
     virtualClusterId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum FailureReason {
     CLUSTER_UNAVAILABLE = "CLUSTER_UNAVAILABLE",
     INTERNAL_ERROR = "INTERNAL_ERROR",
@@ -383,6 +453,7 @@ export declare enum FailureReason {
     VALIDATION_ERROR = "VALIDATION_ERROR"
 }
 /**
+ * @public
  * <p>The configuration of the retry policy that the job runs on.</p>
  */
 export interface RetryPolicyConfiguration {
@@ -392,6 +463,7 @@ export interface RetryPolicyConfiguration {
     maxAttempts: number | undefined;
 }
 /**
+ * @public
  * <p>The current status of the retry policy executed on the job.</p>
  */
 export interface RetryPolicyExecution {
@@ -400,6 +472,9 @@ export interface RetryPolicyExecution {
      */
     currentAttemptCount: number | undefined;
 }
+/**
+ * @public
+ */
 export declare enum JobRunState {
     CANCELLED = "CANCELLED",
     CANCEL_PENDING = "CANCEL_PENDING",
@@ -409,12 +484,18 @@ export declare enum JobRunState {
     RUNNING = "RUNNING",
     SUBMITTED = "SUBMITTED"
 }
+/**
+ * @public
+ */
 export interface DescribeJobTemplateRequest {
     /**
      * <p>The ID of the job template that will be described.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeManagedEndpointRequest {
     /**
      * <p>This output displays ID of the managed endpoint.</p>
@@ -426,6 +507,7 @@ export interface DescribeManagedEndpointRequest {
     virtualClusterId: string | undefined;
 }
 /**
+ * @public
  * <p>The entity representing certificate data generated for managed endpoint.</p>
  */
 export interface Certificate {
@@ -438,6 +520,9 @@ export interface Certificate {
      */
     certificateData?: string;
 }
+/**
+ * @public
+ */
 export declare enum EndpointState {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -445,12 +530,18 @@ export declare enum EndpointState {
     TERMINATED_WITH_ERRORS = "TERMINATED_WITH_ERRORS",
     TERMINATING = "TERMINATING"
 }
+/**
+ * @public
+ */
 export interface DescribeVirtualClusterRequest {
     /**
      * <p>The ID of the virtual cluster that will be described.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum VirtualClusterState {
     ARRESTED = "ARRESTED",
     RUNNING = "RUNNING",
@@ -458,6 +549,7 @@ export declare enum VirtualClusterState {
     TERMINATING = "TERMINATING"
 }
 /**
+ * @public
  * <p>This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace
  *          that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host
  *          endpoints. Multiple virtual clusters can be backed by the same physical cluster. However,
@@ -495,12 +587,18 @@ export interface VirtualCluster {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DescribeVirtualClusterResponse {
     /**
      * <p>This output displays information about the specified virtual cluster.</p>
      */
     virtualCluster?: VirtualCluster;
 }
+/**
+ * @public
+ */
 export interface ListJobRunsRequest {
     /**
      * <p>The ID of the virtual cluster for which to list the job run. </p>
@@ -531,6 +629,9 @@ export interface ListJobRunsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListJobTemplatesRequest {
     /**
      * <p>The date and time after which the job templates were created.</p>
@@ -549,6 +650,9 @@ export interface ListJobTemplatesRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListManagedEndpointsRequest {
     /**
      * <p>The ID of the virtual cluster.</p>
@@ -579,18 +683,27 @@ export interface ListManagedEndpointsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of tagged resources.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags assigned to resources.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface ListVirtualClustersRequest {
     /**
      * <p>The container provider ID of the virtual cluster.</p>
@@ -622,6 +735,9 @@ export interface ListVirtualClustersRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListVirtualClustersResponse {
     /**
      * <p>This output lists the specified virtual clusters.</p>
@@ -632,6 +748,9 @@ export interface ListVirtualClustersResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface StartJobRunResponse {
     /**
      * <p>This output displays the started job run ID.</p>
@@ -650,6 +769,9 @@ export interface StartJobRunResponse {
      */
     virtualClusterId?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of resources.</p>
@@ -660,8 +782,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of resources.</p>
@@ -672,9 +800,13 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**
+ * @public
  * <p>A configuration specification to be used when provisioning virtual clusters, which can
  *          include configurations for applications and software bundled with Amazon EMR on EKS. A
  *          configuration consists of a classification, properties, and optional nested configurations.
@@ -696,6 +828,7 @@ export interface Configuration {
     configurations?: Configuration[];
 }
 /**
+ * @public
  * <p>A configuration specification to be used to override existing configurations.</p>
  */
 export interface ConfigurationOverrides {
@@ -709,6 +842,7 @@ export interface ConfigurationOverrides {
     monitoringConfiguration?: MonitoringConfiguration;
 }
 /**
+ * @public
  * <p> A configuration specification to be used to override existing configurations. This data
  *          type allows job template parameters to be specified within.</p>
  */
@@ -722,6 +856,9 @@ export interface ParametricConfigurationOverrides {
      */
     monitoringConfiguration?: ParametricMonitoringConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateManagedEndpointRequest {
     /**
      * <p>The name of the managed endpoint.</p>
@@ -764,6 +901,7 @@ export interface CreateManagedEndpointRequest {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>This entity represents the endpoint that is managed by Amazon EMR on EKS.</p>
  */
 export interface Endpoint {
@@ -846,6 +984,7 @@ export interface Endpoint {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>This entity describes a job run. A job run is a unit of work, such as a Spark jar,
  *          PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS. </p>
  */
@@ -924,6 +1063,7 @@ export interface JobRun {
     retryPolicyExecution?: RetryPolicyExecution;
 }
 /**
+ * @public
  * <p>The values of StartJobRun API requests used in job runs started using the job
  *          template.</p>
  */
@@ -954,6 +1094,9 @@ export interface JobTemplateData {
      */
     jobTags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface StartJobRunRequest {
     /**
      * <p>The name of the job run.</p>
@@ -1000,6 +1143,9 @@ export interface StartJobRunRequest {
      */
     retryPolicyConfiguration?: RetryPolicyConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateJobTemplateRequest {
     /**
      * <p>The specified name of the job template.</p>
@@ -1022,12 +1168,18 @@ export interface CreateJobTemplateRequest {
      */
     kmsKeyArn?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeJobRunResponse {
     /**
      * <p>The output displays information about a job run.</p>
      */
     jobRun?: JobRun;
 }
+/**
+ * @public
+ */
 export interface DescribeManagedEndpointResponse {
     /**
      * <p>This output displays information about a managed endpoint.</p>
@@ -1035,6 +1187,7 @@ export interface DescribeManagedEndpointResponse {
     endpoint?: Endpoint;
 }
 /**
+ * @public
  * <p>This entity describes a job template. Job template stores values of StartJobRun API
  *          request in a template and can be used to start a job run. Job template allows two use
  *          cases: avoid repeating recurring StartJobRun API request values, enforcing certain values
@@ -1078,12 +1231,18 @@ export interface JobTemplate {
      */
     decryptionError?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeJobTemplateResponse {
     /**
      * <p>This output displays information about the specified job template.</p>
      */
     jobTemplate?: JobTemplate;
 }
+/**
+ * @public
+ */
 export interface ListJobRunsResponse {
     /**
      * <p>This output lists information about the specified job runs.</p>
@@ -1094,6 +1253,9 @@ export interface ListJobRunsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListManagedEndpointsResponse {
     /**
      * <p>The managed endpoints to be listed.</p>
@@ -1104,6 +1266,9 @@ export interface ListManagedEndpointsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListJobTemplatesResponse {
     /**
      * <p>This output lists information about the specified job templates.</p>

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

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

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListJobRunsCommandInput, ListJobRunsCommandOutput } from "../commands/ListJobRunsCommand";
 import { EMRContainersPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListJobRuns(config: EMRContainersPaginationConfiguration, input: ListJobRunsCommandInput, ...additionalArguments: any): Paginator<ListJobRunsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListJobTemplatesCommandInput, ListJobTemplatesCommandOutput } from "../commands/ListJobTemplatesCommand";
 import { EMRContainersPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListJobTemplates(config: EMRContainersPaginationConfiguration, input: ListJobTemplatesCommandInput, ...additionalArguments: any): Paginator<ListJobTemplatesCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListManagedEndpointsCommandInput, ListManagedEndpointsCommandOutput } from "../commands/ListManagedEndpointsCommand";
 import { EMRContainersPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListManagedEndpoints(config: EMRContainersPaginationConfiguration, input: ListManagedEndpointsCommandInput, ...additionalArguments: any): Paginator<ListManagedEndpointsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListVirtualClustersCommandInput, ListVirtualClustersCommandOutput } from "../commands/ListVirtualClustersCommand";
 import { EMRContainersPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListVirtualClusters(config: EMRContainersPaginationConfiguration, input: ListVirtualClustersCommandInput, ...additionalArguments: any): Paginator<ListVirtualClustersCommandOutput>;