@aws-sdk/client-emr-containers 3.201.0 → 3.204.0

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

@@ -42,6 +42,140 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * <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>
+ */
+export interface ParametricCloudWatchMonitoringConfiguration {
+    /**
+     * <p> The name of the log group for log publishing.</p>
+     */
+    logGroupName?: string;
+    /**
+     * <p> The specified name prefix for log streams.</p>
+     */
+    logStreamNamePrefix?: string;
+}
+/**
+ * <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>
+ */
+export interface ParametricS3MonitoringConfiguration {
+    /**
+     * <p>Amazon S3 destination URI for log publishing.</p>
+     */
+    logUri?: string;
+}
+/**
+ * <p> Configuration setting for monitoring. This data type allows job template parameters to
+ *          be specified within.</p>
+ */
+export interface ParametricMonitoringConfiguration {
+    /**
+     * <p> Monitoring configurations for the persistent application UI.</p>
+     */
+    persistentAppUI?: string;
+    /**
+     * <p> Monitoring configurations for CloudWatch.</p>
+     */
+    cloudWatchMonitoringConfiguration?: ParametricCloudWatchMonitoringConfiguration;
+    /**
+     * <p> Amazon S3 configuration for monitoring log publishing.</p>
+     */
+    s3MonitoringConfiguration?: ParametricS3MonitoringConfiguration;
+}
+/**
+ * <p>The job driver for job type.</p>
+ */
+export interface SparkSqlJobDriver {
+    /**
+     * <p>The SQL file to be executed.</p>
+     */
+    entryPoint?: string;
+    /**
+     * <p>The Spark parameters to be included in the Spark SQL command.</p>
+     */
+    sparkSqlParameters?: string;
+}
+/**
+ * <p>The information about job driver for Spark submit.</p>
+ */
+export interface SparkSubmitJobDriver {
+    /**
+     * <p>The entry point of job application.</p>
+     */
+    entryPoint: string | undefined;
+    /**
+     * <p>The arguments for job application.</p>
+     */
+    entryPointArguments?: string[];
+    /**
+     * <p>The Spark submit parameters that are used for job runs.</p>
+     */
+    sparkSubmitParameters?: string;
+}
+/**
+ * <p>Specify the driver that the job runs on. Exactly one of the two available job drivers is
+ *          required, either sparkSqlJobDriver or sparkSubmitJobDriver.</p>
+ */
+export interface JobDriver {
+    /**
+     * <p>The job driver parameters specified for spark submit.</p>
+     */
+    sparkSubmitJobDriver?: SparkSubmitJobDriver;
+    /**
+     * <p>The job driver for job type.</p>
+     */
+    sparkSqlJobDriver?: SparkSqlJobDriver;
+}
+export declare enum TemplateParameterDataType {
+    NUMBER = "NUMBER",
+    STRING = "STRING"
+}
+/**
+ * <p>The configuration of a job template parameter.</p>
+ */
+export interface TemplateParameterConfiguration {
+    /**
+     * <p>The type of the job template parameter. Allowed values are: ‘String’, ‘Number’.</p>
+     */
+    type?: TemplateParameterDataType | string;
+    /**
+     * <p>The default value for the job template parameter.</p>
+     */
+    defaultValue?: string;
+}
+export interface CreateJobTemplateResponse {
+    /**
+     * <p>This output display the created job template ID.</p>
+     */
+    id?: string;
+    /**
+     * <p>This output displays the name of the created job template.</p>
+     */
+    name?: string;
+    /**
+     * <p>This output display the ARN of the created job template.</p>
+     */
+    arn?: string;
+    /**
+     * <p>This output displays the date and time when the job template was created.</p>
+     */
+    createdAt?: Date;
+}
+/**
+ * <p>The specified resource was not found.</p>
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
 /**
  * <p>A configuration for CloudWatch monitoring. You can configure your jobs to send log
  *          information to CloudWatch Logs.</p>
@@ -105,17 +239,6 @@ export interface CreateManagedEndpointResponse {
      */
     virtualClusterId?: string;
 }
-/**
- * <p>The specified resource was not found.</p>
- */
-export declare class ResourceNotFoundException extends __BaseException {
-    readonly name: "ResourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
-}
 /**
  * <p>The information about the EKS cluster.</p>
  */
@@ -199,6 +322,18 @@ export interface CreateVirtualClusterResponse {
      */
     arn?: string;
 }
+export interface DeleteJobTemplateRequest {
+    /**
+     * <p>The ID of the job template that will be deleted.</p>
+     */
+    id: string | undefined;
+}
+export interface DeleteJobTemplateResponse {
+    /**
+     * <p>This output contains the ID of the job template that was deleted.</p>
+     */
+    id?: string;
+}
 export interface DeleteManagedEndpointRequest {
     /**
      * <p>The ID of the managed endpoint.</p>
@@ -247,49 +382,6 @@ export declare enum FailureReason {
     USER_ERROR = "USER_ERROR",
     VALIDATION_ERROR = "VALIDATION_ERROR"
 }
-/**
- * <p>The job driver for job type.</p>
- */
-export interface SparkSqlJobDriver {
-    /**
-     * <p>The SQL file to be executed.</p>
-     */
-    entryPoint?: string;
-    /**
-     * <p>The Spark parameters to be included in the Spark SQL command.</p>
-     */
-    sparkSqlParameters?: string;
-}
-/**
- * <p>The information about job driver for Spark submit.</p>
- */
-export interface SparkSubmitJobDriver {
-    /**
-     * <p>The entry point of job application.</p>
-     */
-    entryPoint: string | undefined;
-    /**
-     * <p>The arguments for job application.</p>
-     */
-    entryPointArguments?: string[];
-    /**
-     * <p>The Spark submit parameters that are used for job runs.</p>
-     */
-    sparkSubmitParameters?: string;
-}
-/**
- * <p>Specify the driver that the job runs on.</p>
- */
-export interface JobDriver {
-    /**
-     * <p>The job driver parameters specified for spark submit.</p>
-     */
-    sparkSubmitJobDriver?: SparkSubmitJobDriver;
-    /**
-     * <p>The job driver for job type.</p>
-     */
-    sparkSqlJobDriver?: SparkSqlJobDriver;
-}
 export declare enum JobRunState {
     CANCELLED = "CANCELLED",
     CANCEL_PENDING = "CANCEL_PENDING",
@@ -299,6 +391,12 @@ export declare enum JobRunState {
     RUNNING = "RUNNING",
     SUBMITTED = "SUBMITTED"
 }
+export interface DescribeJobTemplateRequest {
+    /**
+     * <p>The ID of the job template that will be described.</p>
+     */
+    id: string | undefined;
+}
 export interface DescribeManagedEndpointRequest {
     /**
      * <p>This output displays ID of the managed endpoint.</p>
@@ -415,6 +513,24 @@ export interface ListJobRunsRequest {
      */
     nextToken?: string;
 }
+export interface ListJobTemplatesRequest {
+    /**
+     * <p>The date and time after which the job templates were created.</p>
+     */
+    createdAfter?: Date;
+    /**
+     * <p> The date and time before which the job templates were created.</p>
+     */
+    createdBefore?: Date;
+    /**
+     * <p> The maximum number of job templates that can be listed.</p>
+     */
+    maxResults?: number;
+    /**
+     * <p> The token for the next set of job templates to return.</p>
+     */
+    nextToken?: string;
+}
 export interface ListManagedEndpointsRequest {
     /**
      * <p>The ID of the virtual cluster.</p>
@@ -574,6 +690,20 @@ export interface ConfigurationOverrides {
      */
     monitoringConfiguration?: MonitoringConfiguration;
 }
+/**
+ * <p> A configuration specification to be used to override existing configurations. This data
+ *          type allows job template parameters to be specified within.</p>
+ */
+export interface ParametricConfigurationOverrides {
+    /**
+     * <p> The configurations for the application running by the job run.</p>
+     */
+    applicationConfiguration?: Configuration[];
+    /**
+     * <p> The configurations for monitoring. </p>
+     */
+    monitoringConfiguration?: ParametricMonitoringConfiguration;
+}
 export interface CreateManagedEndpointRequest {
     /**
      * <p>The name of the managed endpoint.</p>
@@ -598,8 +728,8 @@ export interface CreateManagedEndpointRequest {
     /**
      * @deprecated
      *
-     * <p>The certificate ARN provided by users for the managed endpoint. This field is under
-     *          deprecation and will be removed in future releases.</p>
+     * <p>The certificate ARN provided by users for the managed endpoint. This field
+     *          is under deprecation and will be removed in future releases.</p>
      */
     certificateArn?: string;
     /**
@@ -611,7 +741,8 @@ export interface CreateManagedEndpointRequest {
      */
     clientToken?: string;
     /**
-     * <p>The tags of the managed endpoint. </p>
+     * <p>The tags of the managed endpoint.
+     *       </p>
      */
     tags?: Record<string, string>;
 }
@@ -659,7 +790,8 @@ export interface Endpoint {
      */
     certificateArn?: string;
     /**
-     * <p>The certificate generated by emr control plane on customer behalf to secure the managed endpoint.</p>
+     * <p>The certificate generated by emr control plane on customer behalf to secure the managed
+     *          endpoint.</p>
      */
     certificateAuthority?: Certificate;
     /**
@@ -766,6 +898,37 @@ export interface JobRun {
      */
     tags?: Record<string, string>;
 }
+/**
+ * <p>The values of StartJobRun API requests used in job runs started using the job
+ *          template.</p>
+ */
+export interface JobTemplateData {
+    /**
+     * <p>The execution role ARN of the job run.</p>
+     */
+    executionRoleArn: string | undefined;
+    /**
+     * <p> The release version of Amazon EMR.</p>
+     */
+    releaseLabel: string | undefined;
+    /**
+     * <p> The configuration settings that are used to override defaults configuration.</p>
+     */
+    configurationOverrides?: ParametricConfigurationOverrides;
+    /**
+     * <p>Specify the driver that the job runs on. Exactly one of the two available job drivers is
+     *          required, either sparkSqlJobDriver or sparkSubmitJobDriver.</p>
+     */
+    jobDriver: JobDriver | undefined;
+    /**
+     * <p>The configuration of parameters existing in the job template.</p>
+     */
+    parameterConfiguration?: Record<string, TemplateParameterConfiguration>;
+    /**
+     * <p>The tags assigned to jobs started using the job template.</p>
+     */
+    jobTags?: Record<string, string>;
+}
 export interface StartJobRunRequest {
     /**
      * <p>The name of the job run.</p>
@@ -782,15 +945,15 @@ export interface StartJobRunRequest {
     /**
      * <p>The execution role ARN for the job run.</p>
      */
-    executionRoleArn: string | undefined;
+    executionRoleArn?: string;
     /**
      * <p>The Amazon EMR release version to use for the job run.</p>
      */
-    releaseLabel: string | undefined;
+    releaseLabel?: string;
     /**
      * <p>The job driver for the job run.</p>
      */
-    jobDriver: JobDriver | undefined;
+    jobDriver?: JobDriver;
     /**
      * <p>The configuration overrides for the job run.</p>
      */
@@ -799,6 +962,36 @@ export interface StartJobRunRequest {
      * <p>The tags assigned to job runs.</p>
      */
     tags?: Record<string, string>;
+    /**
+     * <p>The job template ID to be used to start the job run.</p>
+     */
+    jobTemplateId?: string;
+    /**
+     * <p>The values of job template parameters to start a job run.</p>
+     */
+    jobTemplateParameters?: Record<string, string>;
+}
+export interface CreateJobTemplateRequest {
+    /**
+     * <p>The specified name of the job template.</p>
+     */
+    name: string | undefined;
+    /**
+     * <p>The client token of the job template.</p>
+     */
+    clientToken?: string;
+    /**
+     * <p>The job template data which holds values of StartJobRun API request.</p>
+     */
+    jobTemplateData: JobTemplateData | undefined;
+    /**
+     * <p>The tags that are associated with the job template.</p>
+     */
+    tags?: Record<string, string>;
+    /**
+     * <p>The KMS key ARN used to encrypt the job template.</p>
+     */
+    kmsKeyArn?: string;
 }
 export interface DescribeJobRunResponse {
     /**
@@ -812,6 +1005,56 @@ export interface DescribeManagedEndpointResponse {
      */
     endpoint?: Endpoint;
 }
+/**
+ * <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
+ *          in StartJobRun API request.</p>
+ */
+export interface JobTemplate {
+    /**
+     * <p>The name of the job template.</p>
+     */
+    name?: string;
+    /**
+     * <p>The ID of the job template.</p>
+     */
+    id?: string;
+    /**
+     * <p>The ARN of the job template.</p>
+     */
+    arn?: string;
+    /**
+     * <p> The date and time when the job template was created.</p>
+     */
+    createdAt?: Date;
+    /**
+     * <p> The user who created the job template.</p>
+     */
+    createdBy?: string;
+    /**
+     * <p>The tags assigned to the job template.</p>
+     */
+    tags?: Record<string, string>;
+    /**
+     * <p>The job template data which holds values of StartJobRun API request.</p>
+     */
+    jobTemplateData: JobTemplateData | undefined;
+    /**
+     * <p> The KMS key ARN used to encrypt the job template.</p>
+     */
+    kmsKeyArn?: string;
+    /**
+     * <p>The error message in case the decryption of job template fails.</p>
+     */
+    decryptionError?: string;
+}
+export interface DescribeJobTemplateResponse {
+    /**
+     * <p>This output displays information about the specified job template.</p>
+     */
+    jobTemplate?: JobTemplate;
+}
 export interface ListJobRunsResponse {
     /**
      * <p>This output lists information about the specified job runs.</p>
@@ -832,6 +1075,16 @@ export interface ListManagedEndpointsResponse {
      */
     nextToken?: string;
 }
+export interface ListJobTemplatesResponse {
+    /**
+     * <p>This output lists information about the specified job templates.</p>
+     */
+    templates?: JobTemplate[];
+    /**
+     * <p> This output displays the token for the next set of job templates.</p>
+     */
+    nextToken?: string;
+}
 /**
  * @internal
  */
@@ -840,6 +1093,38 @@ export declare const CancelJobRunRequestFilterSensitiveLog: (obj: CancelJobRunRe
  * @internal
  */
 export declare const CancelJobRunResponseFilterSensitiveLog: (obj: CancelJobRunResponse) => any;
+/**
+ * @internal
+ */
+export declare const ParametricCloudWatchMonitoringConfigurationFilterSensitiveLog: (obj: ParametricCloudWatchMonitoringConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const ParametricS3MonitoringConfigurationFilterSensitiveLog: (obj: ParametricS3MonitoringConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const ParametricMonitoringConfigurationFilterSensitiveLog: (obj: ParametricMonitoringConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const SparkSqlJobDriverFilterSensitiveLog: (obj: SparkSqlJobDriver) => any;
+/**
+ * @internal
+ */
+export declare const SparkSubmitJobDriverFilterSensitiveLog: (obj: SparkSubmitJobDriver) => any;
+/**
+ * @internal
+ */
+export declare const JobDriverFilterSensitiveLog: (obj: JobDriver) => any;
+/**
+ * @internal
+ */
+export declare const TemplateParameterConfigurationFilterSensitiveLog: (obj: TemplateParameterConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const CreateJobTemplateResponseFilterSensitiveLog: (obj: CreateJobTemplateResponse) => any;
 /**
  * @internal
  */
@@ -879,35 +1164,35 @@ export declare const CreateVirtualClusterResponseFilterSensitiveLog: (obj: Creat
 /**
  * @internal
  */
-export declare const DeleteManagedEndpointRequestFilterSensitiveLog: (obj: DeleteManagedEndpointRequest) => any;
+export declare const DeleteJobTemplateRequestFilterSensitiveLog: (obj: DeleteJobTemplateRequest) => any;
 /**
  * @internal
  */
-export declare const DeleteManagedEndpointResponseFilterSensitiveLog: (obj: DeleteManagedEndpointResponse) => any;
+export declare const DeleteJobTemplateResponseFilterSensitiveLog: (obj: DeleteJobTemplateResponse) => any;
 /**
  * @internal
  */
-export declare const DeleteVirtualClusterRequestFilterSensitiveLog: (obj: DeleteVirtualClusterRequest) => any;
+export declare const DeleteManagedEndpointRequestFilterSensitiveLog: (obj: DeleteManagedEndpointRequest) => any;
 /**
  * @internal
  */
-export declare const DeleteVirtualClusterResponseFilterSensitiveLog: (obj: DeleteVirtualClusterResponse) => any;
+export declare const DeleteManagedEndpointResponseFilterSensitiveLog: (obj: DeleteManagedEndpointResponse) => any;
 /**
  * @internal
  */
-export declare const DescribeJobRunRequestFilterSensitiveLog: (obj: DescribeJobRunRequest) => any;
+export declare const DeleteVirtualClusterRequestFilterSensitiveLog: (obj: DeleteVirtualClusterRequest) => any;
 /**
  * @internal
  */
-export declare const SparkSqlJobDriverFilterSensitiveLog: (obj: SparkSqlJobDriver) => any;
+export declare const DeleteVirtualClusterResponseFilterSensitiveLog: (obj: DeleteVirtualClusterResponse) => any;
 /**
  * @internal
  */
-export declare const SparkSubmitJobDriverFilterSensitiveLog: (obj: SparkSubmitJobDriver) => any;
+export declare const DescribeJobRunRequestFilterSensitiveLog: (obj: DescribeJobRunRequest) => any;
 /**
  * @internal
  */
-export declare const JobDriverFilterSensitiveLog: (obj: JobDriver) => any;
+export declare const DescribeJobTemplateRequestFilterSensitiveLog: (obj: DescribeJobTemplateRequest) => any;
 /**
  * @internal
  */
@@ -932,6 +1217,10 @@ export declare const DescribeVirtualClusterResponseFilterSensitiveLog: (obj: Des
  * @internal
  */
 export declare const ListJobRunsRequestFilterSensitiveLog: (obj: ListJobRunsRequest) => any;
+/**
+ * @internal
+ */
+export declare const ListJobTemplatesRequestFilterSensitiveLog: (obj: ListJobTemplatesRequest) => any;
 /**
  * @internal
  */
@@ -980,6 +1269,10 @@ export declare const ConfigurationFilterSensitiveLog: (obj: Configuration) => an
  * @internal
  */
 export declare const ConfigurationOverridesFilterSensitiveLog: (obj: ConfigurationOverrides) => any;
+/**
+ * @internal
+ */
+export declare const ParametricConfigurationOverridesFilterSensitiveLog: (obj: ParametricConfigurationOverrides) => any;
 /**
  * @internal
  */
@@ -992,10 +1285,18 @@ export declare const EndpointFilterSensitiveLog: (obj: Endpoint) => any;
  * @internal
  */
 export declare const JobRunFilterSensitiveLog: (obj: JobRun) => any;
+/**
+ * @internal
+ */
+export declare const JobTemplateDataFilterSensitiveLog: (obj: JobTemplateData) => any;
 /**
  * @internal
  */
 export declare const StartJobRunRequestFilterSensitiveLog: (obj: StartJobRunRequest) => any;
+/**
+ * @internal
+ */
+export declare const CreateJobTemplateRequestFilterSensitiveLog: (obj: CreateJobTemplateRequest) => any;
 /**
  * @internal
  */
@@ -1004,6 +1305,14 @@ export declare const DescribeJobRunResponseFilterSensitiveLog: (obj: DescribeJob
  * @internal
  */
 export declare const DescribeManagedEndpointResponseFilterSensitiveLog: (obj: DescribeManagedEndpointResponse) => any;
+/**
+ * @internal
+ */
+export declare const JobTemplateFilterSensitiveLog: (obj: JobTemplate) => any;
+/**
+ * @internal
+ */
+export declare const DescribeJobTemplateResponseFilterSensitiveLog: (obj: DescribeJobTemplateResponse) => any;
 /**
  * @internal
  */
@@ -1012,3 +1321,7 @@ export declare const ListJobRunsResponseFilterSensitiveLog: (obj: ListJobRunsRes
  * @internal
  */
 export declare const ListManagedEndpointsResponseFilterSensitiveLog: (obj: ListManagedEndpointsResponse) => any;
+/**
+ * @internal
+ */
+export declare const ListJobTemplatesResponseFilterSensitiveLog: (obj: ListJobTemplatesResponse) => any;

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

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

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

@@ -1,4 +1,5 @@
 export * from "./Interfaces";
 export * from "./ListJobRunsPaginator";
+export * from "./ListJobTemplatesPaginator";
 export * from "./ListManagedEndpointsPaginator";
 export * from "./ListVirtualClustersPaginator";