Class: AWS.EMRcontainers

var params = {
  clientToken: 'STRING_VALUE', /* required */
  jobTemplateData: { /* required */
    executionRoleArn: 'STRING_VALUE', /* required */
    jobDriver: { /* required */
      sparkSqlJobDriver: {
        entryPoint: 'STRING_VALUE',
        sparkSqlParameters: 'STRING_VALUE'
      },
      sparkSubmitJobDriver: {
        entryPoint: 'STRING_VALUE', /* required */
        entryPointArguments: [
          'STRING_VALUE',
          /* more items */
        ],
        sparkSubmitParameters: 'STRING_VALUE'
      }
    },
    releaseLabel: 'STRING_VALUE', /* required */
    configurationOverrides: {
      applicationConfiguration: [ /* ConfigurationList */
        {
          classification: 'STRING_VALUE', /* required */
          configurations: /* recursive ConfigurationList */,
          properties: {
            '<String1024>': 'STRING_VALUE',
            /* '<String1024>': ... */
          }
        },
        /* more items */
      ],
      monitoringConfiguration: {
        cloudWatchMonitoringConfiguration: {
          logGroupName: 'STRING_VALUE',
          logStreamNamePrefix: 'STRING_VALUE'
        },
        persistentAppUI: 'STRING_VALUE',
        s3MonitoringConfiguration: {
          logUri: 'STRING_VALUE'
        }
      }
    },
    jobTags: {
      '<String128>': 'STRING_VALUE',
      /* '<String128>': ... */
    },
    parameterConfiguration: {
      '<TemplateParameterName>': {
        defaultValue: 'STRING_VALUE',
        type: NUMBER | STRING
      },
      /* '<TemplateParameterName>': ... */
    }
  },
  name: 'STRING_VALUE', /* required */
  kmsKeyArn: 'STRING_VALUE',
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createJobTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The specified name of the job template.

  • clientToken — (String)

    The client token of the job template.

    If a token is not provided, the SDK will use a version 4 UUID.
  • jobTemplateData — (map)

    The job template data which holds values of StartJobRun API request.

    • executionRoleArn — required — (String)

      The execution role ARN of the job run.

    • releaseLabel — required — (String)

      The release version of Amazon EMR.

    • configurationOverrides — (map)

      The configuration settings that are used to override defaults configuration.

      • applicationConfiguration — (Array<map>)

        The configurations for the application running by the job run.

        • classification — required — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The configurations for monitoring.

        • persistentAppUI — (String)

          Monitoring configurations for the persistent application UI.

        • cloudWatchMonitoringConfiguration — (map)

          Monitoring configurations for CloudWatch.

          • logGroupName — (String)

            The name of the log group for log publishing.

          • logStreamNamePrefix — (String)

            The specified name prefix for log streams.

        • s3MonitoringConfiguration — (map)

          Amazon S3 configuration for monitoring log publishing.

          • logUri — (String)

            Amazon S3 destination URI for log publishing.

    • jobDriver — required — (map)

      Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.

      • sparkSubmitJobDriver — (map)

        The job driver parameters specified for spark submit.

        • entryPoint — required — (String)

          The entry point of job application.

        • entryPointArguments — (Array<String>)

          The arguments for job application.

        • sparkSubmitParameters — (String)

          The Spark submit parameters that are used for job runs.

      • sparkSqlJobDriver — (map)

        The job driver for job type.

        • entryPoint — (String)

          The SQL file to be executed.

        • sparkSqlParameters — (String)

          The Spark parameters to be included in the Spark SQL command.

    • parameterConfiguration — (map<map>)

      The configuration of parameters existing in the job template.

      • type — (String)

        The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

        Possible values include:
        • "NUMBER"
        • "STRING"
      • defaultValue — (String)

        The default value for the job template parameter.

    • jobTags — (map<String>)

      The tags assigned to jobs started using the job template.

  • tags — (map<String>)

    The tags that are associated with the job template.

  • kmsKeyArn — (String)

    The KMS key ARN used to encrypt the job template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      This output display the created job template ID.

    • name — (String)

      This output displays the name of the created job template.

    • arn — (String)

      This output display the ARN of the created job template.

    • createdAt — (Date)

      This output displays the date and time when the job template was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientToken: 'STRING_VALUE', /* required */
  executionRoleArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  releaseLabel: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE', /* required */
  certificateArn: 'STRING_VALUE',
  configurationOverrides: {
    applicationConfiguration: [ /* ConfigurationList */
      {
        classification: 'STRING_VALUE', /* required */
        configurations: /* recursive ConfigurationList */,
        properties: {
          '<String1024>': 'STRING_VALUE',
          /* '<String1024>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      cloudWatchMonitoringConfiguration: {
        logGroupName: 'STRING_VALUE', /* required */
        logStreamNamePrefix: 'STRING_VALUE'
      },
      containerLogRotationConfiguration: {
        maxFilesToKeep: 'NUMBER_VALUE', /* required */
        rotationSize: 'STRING_VALUE' /* required */
      },
      persistentAppUI: ENABLED | DISABLED,
      s3MonitoringConfiguration: {
        logUri: 'STRING_VALUE' /* required */
      }
    }
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createManagedEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the managed endpoint.

  • virtualClusterId — (String)

    The ID of the virtual cluster for which a managed endpoint is created.

  • type — (String)

    The type of the managed endpoint.

  • releaseLabel — (String)

    The Amazon EMR release version.

  • executionRoleArn — (String)

    The ARN of the execution role.

  • certificateArn — (String)

    The certificate ARN provided by users for the managed endpoint. This field is under deprecation and will be removed in future releases.

  • configurationOverrides — (map)

    The configuration settings that will be used to override existing configurations.

    • applicationConfiguration — (Array<map>)

      The configurations for the application running by the job run.

      • classification — required — (String)

        The classification within a configuration.

      • properties — (map<String>)

        A set of properties specified within a configuration classification.

    • monitoringConfiguration — (map)

      The configurations for monitoring.

      • persistentAppUI — (String)

        Monitoring configurations for the persistent application UI.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • cloudWatchMonitoringConfiguration — (map)

        Monitoring configurations for CloudWatch.

        • logGroupName — required — (String)

          The name of the log group for log publishing.

        • logStreamNamePrefix — (String)

          The specified name prefix for log streams.

      • s3MonitoringConfiguration — (map)

        Amazon S3 configuration for monitoring log publishing.

        • logUri — required — (String)

          Amazon S3 destination URI for log publishing.

      • containerLogRotationConfiguration — (map)

        Enable or disable container log rotation.

        • rotationSize — required — (String)

          The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

        • maxFilesToKeep — required — (Integer)

          The number of files to keep in container after rotation.

  • clientToken — (String)

    The client idempotency token for this create call.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

    The tags of the managed endpoint.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The output contains the ID of the managed endpoint.

    • name — (String)

      The output contains the name of the managed endpoint.

    • arn — (String)

      The output contains the ARN of the managed endpoint.

    • virtualClusterId — (String)

      The output contains the ID of the virtual cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  securityConfigurationData: { /* required */
    authorizationConfiguration: {
      encryptionConfiguration: {
        inTransitEncryptionConfiguration: {
          tlsCertificateConfiguration: {
            certificateProviderType: PEM,
            privateCertificateSecretArn: 'STRING_VALUE',
            publicCertificateSecretArn: 'STRING_VALUE'
          }
        }
      },
      lakeFormationConfiguration: {
        authorizedSessionTagValue: 'STRING_VALUE',
        queryEngineRoleArn: 'STRING_VALUE',
        secureNamespaceInfo: {
          clusterId: 'STRING_VALUE',
          namespace: 'STRING_VALUE'
        }
      }
    }
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createSecurityConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    The client idempotency token to use when creating the security configuration.

    If a token is not provided, the SDK will use a version 4 UUID.
  • name — (String)

    The name of the security configuration.

  • securityConfigurationData — (map)

    Security configuration input for the request.

    • authorizationConfiguration — (map)

      Authorization-related configuration input for the security configuration.

      • lakeFormationConfiguration — (map)

        Lake Formation related configuration inputs for the security configuration.

        • authorizedSessionTagValue — (String)

          The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

        • secureNamespaceInfo — (map)

          The namespace input of the system job.

          • clusterId — (String)

            The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

          • namespace — (String)

            The namespace of the Amazon EKS cluster where the system jobs run.

        • queryEngineRoleArn — (String)

          The query engine IAM role ARN that is tied to the secure Spark job. The QueryEngine role assumes the JobExecutionRole to execute all the Lake Formation calls.

      • encryptionConfiguration — (map)

        Encryption-related configuration input for the security configuration.

        • inTransitEncryptionConfiguration — (map)

          In-transit encryption-related input for the security configuration.

          • tlsCertificateConfiguration — (map)

            TLS certificate-related configuration input for the security configuration.

            • certificateProviderType — (String)

              The TLS certificate type. Acceptable values: PEM or Custom.

              Possible values include:
              • "PEM"
            • publicCertificateSecretArn — (String)

              Secrets Manager ARN that contains the public TLS certificate contents, used for communication between the user job and the system job.

            • privateCertificateSecretArn — (String)

              Secrets Manager ARN that contains the private TLS certificate contents, used for communication between the user job and the system job.

  • tags — (map<String>)

    The tags to add to the security configuration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The ID of the security configuration.

    • name — (String)

      The name of the security configuration.

    • arn — (String)

      The ARN (Amazon Resource Name) of the security configuration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientToken: 'STRING_VALUE', /* required */
  containerProvider: { /* required */
    id: 'STRING_VALUE', /* required */
    type: EKS, /* required */
    info: {
      eksInfo: {
        namespace: 'STRING_VALUE'
      }
    }
  },
  name: 'STRING_VALUE', /* required */
  securityConfigurationId: 'STRING_VALUE',
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createVirtualCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The specified name of the virtual cluster.

  • containerProvider — (map)

    The container provider of the virtual cluster.

    • type — required — (String)

      The type of the container provider. Amazon EKS is the only supported type as of now.

      Possible values include:
      • "EKS"
    • id — required — (String)

      The ID of the container cluster.

    • info — (map)

      The information about the container cluster.

      • eksInfo — (map)

        The information about the Amazon EKS cluster.

        • namespace — (String)

          The namespaces of the Amazon EKS cluster.

  • clientToken — (String)

    The client token of the virtual cluster.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

    The tags assigned to the virtual cluster.

  • securityConfigurationId — (String)

    The ID of the security configuration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      This output contains the virtual cluster ID.

    • name — (String)

      This output contains the name of the virtual cluster.

    • arn — (String)

      This output contains the ARN of virtual cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.deleteJobTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the job template that will be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      This output contains the ID of the job template that was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.deleteManagedEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the managed endpoint.

  • virtualClusterId — (String)

    The ID of the endpoint's virtual cluster.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The output displays the ID of the managed endpoint.

    • virtualClusterId — (String)

      The output displays the ID of the endpoint's virtual cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.deleteVirtualCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the virtual cluster that will be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      This output contains the ID of the virtual cluster that will be deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.describeJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the job run request.

  • virtualClusterId — (String)

    The ID of the virtual cluster for which the job run is submitted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobRun — (map)

      The output displays information about a job run.

      • id — (String)

        The ID of the job run.

      • name — (String)

        The name of the job run.

      • virtualClusterId — (String)

        The ID of the job run's virtual cluster.

      • arn — (String)

        The ARN of job run.

      • state — (String)

        The state of the job run.

        Possible values include:
        • "PENDING"
        • "SUBMITTED"
        • "RUNNING"
        • "FAILED"
        • "CANCELLED"
        • "CANCEL_PENDING"
        • "COMPLETED"
      • clientToken — (String)

        The client token used to start a job run.

      • executionRoleArn — (String)

        The execution role ARN of the job run.

      • releaseLabel — (String)

        The release version of Amazon EMR.

      • configurationOverrides — (map)

        The configuration settings that are used to override default configuration.

        • applicationConfiguration — (Array<map>)

          The configurations for the application running by the job run.

          • classification — required — (String)

            The classification within a configuration.

          • properties — (map<String>)

            A set of properties specified within a configuration classification.

        • monitoringConfiguration — (map)

          The configurations for monitoring.

          • persistentAppUI — (String)

            Monitoring configurations for the persistent application UI.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • cloudWatchMonitoringConfiguration — (map)

            Monitoring configurations for CloudWatch.

            • logGroupName — required — (String)

              The name of the log group for log publishing.

            • logStreamNamePrefix — (String)

              The specified name prefix for log streams.

          • s3MonitoringConfiguration — (map)

            Amazon S3 configuration for monitoring log publishing.

            • logUri — required — (String)

              Amazon S3 destination URI for log publishing.

          • containerLogRotationConfiguration — (map)

            Enable or disable container log rotation.

            • rotationSize — required — (String)

              The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

            • maxFilesToKeep — required — (Integer)

              The number of files to keep in container after rotation.

      • jobDriver — (map)

        Parameters of job driver for the job run.

        • sparkSubmitJobDriver — (map)

          The job driver parameters specified for spark submit.

          • entryPoint — required — (String)

            The entry point of job application.

          • entryPointArguments — (Array<String>)

            The arguments for job application.

          • sparkSubmitParameters — (String)

            The Spark submit parameters that are used for job runs.

        • sparkSqlJobDriver — (map)

          The job driver for job type.

          • entryPoint — (String)

            The SQL file to be executed.

          • sparkSqlParameters — (String)

            The Spark parameters to be included in the Spark SQL command.

      • createdAt — (Date)

        The date and time when the job run was created.

      • createdBy — (String)

        The user who created the job run.

      • finishedAt — (Date)

        The date and time when the job run has finished.

      • stateDetails — (String)

        Additional details of the job run state.

      • failureReason — (String)

        The reasons why the job run has failed.

        Possible values include:
        • "INTERNAL_ERROR"
        • "USER_ERROR"
        • "VALIDATION_ERROR"
        • "CLUSTER_UNAVAILABLE"
      • tags — (map<String>)

        The assigned tags of the job run.

      • retryPolicyConfiguration — (map)

        The configuration of the retry policy that the job runs on.

        • maxAttempts — required — (Integer)

          The maximum number of attempts on the job's driver.

      • retryPolicyExecution — (map)

        The current status of the retry policy executed on the job.

        • currentAttemptCount — required — (Integer)

          The current number of attempts made on the driver of the job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.describeJobTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the job template that will be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobTemplate — (map)

      This output displays information about the specified job template.

      • name — (String)

        The name of the job template.

      • id — (String)

        The ID of the job template.

      • arn — (String)

        The ARN of the job template.

      • createdAt — (Date)

        The date and time when the job template was created.

      • createdBy — (String)

        The user who created the job template.

      • tags — (map<String>)

        The tags assigned to the job template.

      • jobTemplateData — required — (map)

        The job template data which holds values of StartJobRun API request.

        • executionRoleArn — required — (String)

          The execution role ARN of the job run.

        • releaseLabel — required — (String)

          The release version of Amazon EMR.

        • configurationOverrides — (map)

          The configuration settings that are used to override defaults configuration.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classification — required — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupName — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUri — (String)

                Amazon S3 destination URI for log publishing.

        • jobDriver — required — (map)

          Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.

          • sparkSubmitJobDriver — (map)

            The job driver parameters specified for spark submit.

            • entryPoint — required — (String)

              The entry point of job application.

            • entryPointArguments — (Array<String>)

              The arguments for job application.

            • sparkSubmitParameters — (String)

              The Spark submit parameters that are used for job runs.

          • sparkSqlJobDriver — (map)

            The job driver for job type.

            • entryPoint — (String)

              The SQL file to be executed.

            • sparkSqlParameters — (String)

              The Spark parameters to be included in the Spark SQL command.

        • parameterConfiguration — (map<map>)

          The configuration of parameters existing in the job template.

          • type — (String)

            The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

            Possible values include:
            • "NUMBER"
            • "STRING"
          • defaultValue — (String)

            The default value for the job template parameter.

        • jobTags — (map<String>)

          The tags assigned to jobs started using the job template.

      • kmsKeyArn — (String)

        The KMS key ARN used to encrypt the job template.

      • decryptionError — (String)

        The error message in case the decryption of job template fails.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.describeManagedEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    This output displays ID of the managed endpoint.

  • virtualClusterId — (String)

    The ID of the endpoint's virtual cluster.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • endpoint — (map)

      This output displays information about a managed endpoint.

      • id — (String)

        The ID of the endpoint.

      • name — (String)

        The name of the endpoint.

      • arn — (String)

        The ARN of the endpoint.

      • virtualClusterId — (String)

        The ID of the endpoint's virtual cluster.

      • type — (String)

        The type of the endpoint.

      • state — (String)

        The state of the endpoint.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "TERMINATING"
        • "TERMINATED"
        • "TERMINATED_WITH_ERRORS"
      • releaseLabel — (String)

        The EMR release version to be used for the endpoint.

      • executionRoleArn — (String)

        The execution role ARN of the endpoint.

      • certificateArn — (String)

        The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

      • certificateAuthority — (map)

        The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

        • certificateArn — (String)

          The ARN of the certificate generated for managed endpoint.

        • certificateData — (String)

          The base64 encoded PEM certificate data generated for managed endpoint.

      • configurationOverrides — (map)

        The configuration settings that are used to override existing configurations for endpoints.

        • applicationConfiguration — (Array<map>)

          The configurations for the application running by the job run.

          • classification — required — (String)

            The classification within a configuration.

          • properties — (map<String>)

            A set of properties specified within a configuration classification.

        • monitoringConfiguration — (map)

          The configurations for monitoring.

          • persistentAppUI — (String)

            Monitoring configurations for the persistent application UI.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • cloudWatchMonitoringConfiguration — (map)

            Monitoring configurations for CloudWatch.

            • logGroupName — required — (String)

              The name of the log group for log publishing.

            • logStreamNamePrefix — (String)

              The specified name prefix for log streams.

          • s3MonitoringConfiguration — (map)

            Amazon S3 configuration for monitoring log publishing.

            • logUri — required — (String)

              Amazon S3 destination URI for log publishing.

          • containerLogRotationConfiguration — (map)

            Enable or disable container log rotation.

            • rotationSize — required — (String)

              The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

            • maxFilesToKeep — required — (Integer)

              The number of files to keep in container after rotation.

      • serverUrl — (String)

        The server URL of the endpoint.

      • createdAt — (Date)

        The date and time when the endpoint was created.

      • securityGroup — (String)

        The security group configuration of the endpoint.

      • subnetIds — (Array<String>)

        The subnet IDs of the endpoint.

      • stateDetails — (String)

        Additional details of the endpoint state.

      • failureReason — (String)

        The reasons why the endpoint has failed.

        Possible values include:
        • "INTERNAL_ERROR"
        • "USER_ERROR"
        • "VALIDATION_ERROR"
        • "CLUSTER_UNAVAILABLE"
      • tags — (map<String>)

        The tags of the endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.describeSecurityConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the security configuration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • securityConfiguration — (map)

      Details of the security configuration.

      • id — (String)

        The ID of the security configuration.

      • name — (String)

        The name of the security configuration.

      • arn — (String)

        The ARN (Amazon Resource Name) of the security configuration.

      • createdAt — (Date)

        The date and time that the job run was created.

      • createdBy — (String)

        The user who created the job run.

      • securityConfigurationData — (map)

        Security configuration inputs for the request.

        • authorizationConfiguration — (map)

          Authorization-related configuration input for the security configuration.

          • lakeFormationConfiguration — (map)

            Lake Formation related configuration inputs for the security configuration.

            • authorizedSessionTagValue — (String)

              The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

            • secureNamespaceInfo — (map)

              The namespace input of the system job.

              • clusterId — (String)

                The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

              • namespace — (String)

                The namespace of the Amazon EKS cluster where the system jobs run.

            • queryEngineRoleArn — (String)

              The query engine IAM role ARN that is tied to the secure Spark job. The QueryEngine role assumes the JobExecutionRole to execute all the Lake Formation calls.

          • encryptionConfiguration — (map)

            Encryption-related configuration input for the security configuration.

            • inTransitEncryptionConfiguration — (map)

              In-transit encryption-related input for the security configuration.

              • tlsCertificateConfiguration — (map)

                TLS certificate-related configuration input for the security configuration.

                • certificateProviderType — (String)

                  The TLS certificate type. Acceptable values: PEM or Custom.

                  Possible values include:
                  • "PEM"
                • publicCertificateSecretArn — (String)

                  Secrets Manager ARN that contains the public TLS certificate contents, used for communication between the user job and the system job.

                • privateCertificateSecretArn — (String)

                  Secrets Manager ARN that contains the private TLS certificate contents, used for communication between the user job and the system job.

      • tags — (map<String>)

        The tags to assign to the security configuration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.describeVirtualCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    The ID of the virtual cluster that will be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • virtualCluster — (map)

      This output displays information about the specified virtual cluster.

      • id — (String)

        The ID of the virtual cluster.

      • name — (String)

        The name of the virtual cluster.

      • arn — (String)

        The ARN of the virtual cluster.

      • state — (String)

        The state of the virtual cluster.

        Possible values include:
        • "RUNNING"
        • "TERMINATING"
        • "TERMINATED"
        • "ARRESTED"
      • containerProvider — (map)

        The container provider of the virtual cluster.

        • type — required — (String)

          The type of the container provider. Amazon EKS is the only supported type as of now.

          Possible values include:
          • "EKS"
        • id — required — (String)

          The ID of the container cluster.

        • info — (map)

          The information about the container cluster.

          • eksInfo — (map)

            The information about the Amazon EKS cluster.

            • namespace — (String)

              The namespaces of the Amazon EKS cluster.

      • createdAt — (Date)

        The date and time when the virtual cluster is created.

      • tags — (map<String>)

        The assigned tags of the virtual cluster.

      • securityConfigurationId — (String)

        The ID of the security configuration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  credentialType: 'STRING_VALUE', /* required */
  endpointIdentifier: 'STRING_VALUE', /* required */
  executionRoleArn: 'STRING_VALUE', /* required */
  virtualClusterIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  durationInSeconds: 'NUMBER_VALUE',
  logContext: 'STRING_VALUE'
};
emrcontainers.getManagedEndpointSessionCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • endpointIdentifier — (String)

    The ARN of the managed endpoint for which the request is submitted.

  • virtualClusterIdentifier — (String)

    The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

  • executionRoleArn — (String)

    The IAM Execution Role ARN that will be used by the job run.

  • credentialType — (String)

    Type of the token requested. Currently supported and default value of this field is “TOKEN.”

  • durationInSeconds — (Integer)

    Duration in seconds for which the session token is valid. The default duration is 15 minutes and the maximum is 12 hours.

  • logContext — (String)

    String identifier used to separate sections of the execution logs uploaded to S3.

  • clientToken — (String)

    The client idempotency token of the job run request.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The identifier of the session token returned.

    • credentials — (map)

      The structure containing the session credentials.

      • token — (String)

        The actual session token being returned.

    • expiresAt — (Date)

      The date and time when the session token will expire.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  virtualClusterId: 'STRING_VALUE', /* required */
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    PENDING | SUBMITTED | RUNNING | FAILED | CANCELLED | CANCEL_PENDING | COMPLETED,
    /* more items */
  ]
};
emrcontainers.listJobRuns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • virtualClusterId — (String)

    The ID of the virtual cluster for which to list the job run.

  • createdBefore — (Date)

    The date and time before which the job runs were submitted.

  • createdAfter — (Date)

    The date and time after which the job runs were submitted.

  • name — (String)

    The name of the job run.

  • states — (Array<String>)

    The states of the job run.

  • maxResults — (Integer)

    The maximum number of job runs that can be listed.

  • nextToken — (String)

    The token for the next set of job runs to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobRuns — (Array<map>)

      This output lists information about the specified job runs.

      • id — (String)

        The ID of the job run.

      • name — (String)

        The name of the job run.

      • virtualClusterId — (String)

        The ID of the job run's virtual cluster.

      • arn — (String)

        The ARN of job run.

      • state — (String)

        The state of the job run.

        Possible values include:
        • "PENDING"
        • "SUBMITTED"
        • "RUNNING"
        • "FAILED"
        • "CANCELLED"
        • "CANCEL_PENDING"
        • "COMPLETED"
      • clientToken — (String)

        The client token used to start a job run.

      • executionRoleArn — (String)

        The execution role ARN of the job run.

      • releaseLabel — (String)

        The release version of Amazon EMR.

      • configurationOverrides — (map)

        The configuration settings that are used to override default configuration.

        • applicationConfiguration — (Array<map>)

          The configurations for the application running by the job run.

          • classification — required — (String)

            The classification within a configuration.

          • properties — (map<String>)

            A set of properties specified within a configuration classification.

        • monitoringConfiguration — (map)

          The configurations for monitoring.

          • persistentAppUI — (String)

            Monitoring configurations for the persistent application UI.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • cloudWatchMonitoringConfiguration — (map)

            Monitoring configurations for CloudWatch.

            • logGroupName — required — (String)

              The name of the log group for log publishing.

            • logStreamNamePrefix — (String)

              The specified name prefix for log streams.

          • s3MonitoringConfiguration — (map)

            Amazon S3 configuration for monitoring log publishing.

            • logUri — required — (String)

              Amazon S3 destination URI for log publishing.

          • containerLogRotationConfiguration — (map)

            Enable or disable container log rotation.

            • rotationSize — required — (String)

              The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

            • maxFilesToKeep — required — (Integer)

              The number of files to keep in container after rotation.

      • jobDriver — (map)

        Parameters of job driver for the job run.

        • sparkSubmitJobDriver — (map)

          The job driver parameters specified for spark submit.

          • entryPoint — required — (String)

            The entry point of job application.

          • entryPointArguments — (Array<String>)

            The arguments for job application.

          • sparkSubmitParameters — (String)

            The Spark submit parameters that are used for job runs.

        • sparkSqlJobDriver — (map)

          The job driver for job type.

          • entryPoint — (String)

            The SQL file to be executed.

          • sparkSqlParameters — (String)

            The Spark parameters to be included in the Spark SQL command.

      • createdAt — (Date)

        The date and time when the job run was created.

      • createdBy — (String)

        The user who created the job run.

      • finishedAt — (Date)

        The date and time when the job run has finished.

      • stateDetails — (String)

        Additional details of the job run state.

      • failureReason — (String)

        The reasons why the job run has failed.

        Possible values include:
        • "INTERNAL_ERROR"
        • "USER_ERROR"
        • "VALIDATION_ERROR"
        • "CLUSTER_UNAVAILABLE"
      • tags — (map<String>)

        The assigned tags of the job run.

      • retryPolicyConfiguration — (map)

        The configuration of the retry policy that the job runs on.

        • maxAttempts — required — (Integer)

          The maximum number of attempts on the job's driver.

      • retryPolicyExecution — (map)

        The current status of the retry policy executed on the job.

        • currentAttemptCount — required — (Integer)

          The current number of attempts made on the driver of the job.

    • nextToken — (String)

      This output displays the token for the next set of job runs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
emrcontainers.listJobTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • createdAfter — (Date)

    The date and time after which the job templates were created.

  • createdBefore — (Date)

    The date and time before which the job templates were created.

  • maxResults — (Integer)

    The maximum number of job templates that can be listed.

  • nextToken — (String)

    The token for the next set of job templates to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • templates — (Array<map>)

      This output lists information about the specified job templates.

      • name — (String)

        The name of the job template.

      • id — (String)

        The ID of the job template.

      • arn — (String)

        The ARN of the job template.

      • createdAt — (Date)

        The date and time when the job template was created.

      • createdBy — (String)

        The user who created the job template.

      • tags — (map<String>)

        The tags assigned to the job template.

      • jobTemplateData — required — (map)

        The job template data which holds values of StartJobRun API request.

        • executionRoleArn — required — (String)

          The execution role ARN of the job run.

        • releaseLabel — required — (String)

          The release version of Amazon EMR.

        • configurationOverrides — (map)

          The configuration settings that are used to override defaults configuration.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classification — required — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupName — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUri — (String)

                Amazon S3 destination URI for log publishing.

        • jobDriver — required — (map)

          Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.

          • sparkSubmitJobDriver — (map)

            The job driver parameters specified for spark submit.

            • entryPoint — required — (String)

              The entry point of job application.

            • entryPointArguments — (Array<String>)

              The arguments for job application.

            • sparkSubmitParameters — (String)

              The Spark submit parameters that are used for job runs.

          • sparkSqlJobDriver — (map)

            The job driver for job type.

            • entryPoint — (String)

              The SQL file to be executed.

            • sparkSqlParameters — (String)

              The Spark parameters to be included in the Spark SQL command.

        • parameterConfiguration — (map<map>)

          The configuration of parameters existing in the job template.

          • type — (String)

            The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

            Possible values include:
            • "NUMBER"
            • "STRING"
          • defaultValue — (String)

            The default value for the job template parameter.

        • jobTags — (map<String>)

          The tags assigned to jobs started using the job template.

      • kmsKeyArn — (String)

        The KMS key ARN used to encrypt the job template.

      • decryptionError — (String)

        The error message in case the decryption of job template fails.

    • nextToken — (String)

      This output displays the token for the next set of job templates.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  virtualClusterId: 'STRING_VALUE', /* required */
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    CREATING | ACTIVE | TERMINATING | TERMINATED | TERMINATED_WITH_ERRORS,
    /* more items */
  ],
  types: [
    'STRING_VALUE',
    /* more items */
  ]
};
emrcontainers.listManagedEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • virtualClusterId — (String)

    The ID of the virtual cluster.

  • createdBefore — (Date)

    The date and time before which the endpoints are created.

  • createdAfter — (Date)

    The date and time after which the endpoints are created.

  • types — (Array<String>)

    The types of the managed endpoints.

  • states — (Array<String>)

    The states of the managed endpoints.

  • maxResults — (Integer)

    The maximum number of managed endpoints that can be listed.

  • nextToken — (String)

    The token for the next set of managed endpoints to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • endpoints — (Array<map>)

      The managed endpoints to be listed.

      • id — (String)

        The ID of the endpoint.

      • name — (String)

        The name of the endpoint.

      • arn — (String)

        The ARN of the endpoint.

      • virtualClusterId — (String)

        The ID of the endpoint's virtual cluster.

      • type — (String)

        The type of the endpoint.

      • state — (String)

        The state of the endpoint.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "TERMINATING"
        • "TERMINATED"
        • "TERMINATED_WITH_ERRORS"
      • releaseLabel — (String)

        The EMR release version to be used for the endpoint.

      • executionRoleArn — (String)

        The execution role ARN of the endpoint.

      • certificateArn — (String)

        The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

      • certificateAuthority — (map)

        The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

        • certificateArn — (String)

          The ARN of the certificate generated for managed endpoint.

        • certificateData — (String)

          The base64 encoded PEM certificate data generated for managed endpoint.

      • configurationOverrides — (map)

        The configuration settings that are used to override existing configurations for endpoints.

        • applicationConfiguration — (Array<map>)

          The configurations for the application running by the job run.

          • classification — required — (String)

            The classification within a configuration.

          • properties — (map<String>)

            A set of properties specified within a configuration classification.

        • monitoringConfiguration — (map)

          The configurations for monitoring.

          • persistentAppUI — (String)

            Monitoring configurations for the persistent application UI.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • cloudWatchMonitoringConfiguration — (map)

            Monitoring configurations for CloudWatch.

            • logGroupName — required — (String)

              The name of the log group for log publishing.

            • logStreamNamePrefix — (String)

              The specified name prefix for log streams.

          • s3MonitoringConfiguration — (map)

            Amazon S3 configuration for monitoring log publishing.

            • logUri — required — (String)

              Amazon S3 destination URI for log publishing.

          • containerLogRotationConfiguration — (map)

            Enable or disable container log rotation.

            • rotationSize — required — (String)

              The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

            • maxFilesToKeep — required — (Integer)

              The number of files to keep in container after rotation.

      • serverUrl — (String)

        The server URL of the endpoint.

      • createdAt — (Date)

        The date and time when the endpoint was created.

      • securityGroup — (String)

        The security group configuration of the endpoint.

      • subnetIds — (Array<String>)

        The subnet IDs of the endpoint.

      • stateDetails — (String)

        Additional details of the endpoint state.

      • failureReason — (String)

        The reasons why the endpoint has failed.

        Possible values include:
        • "INTERNAL_ERROR"
        • "USER_ERROR"
        • "VALIDATION_ERROR"
        • "CLUSTER_UNAVAILABLE"
      • tags — (map<String>)

        The tags of the endpoint.

    • nextToken — (String)

      The token for the next set of endpoints to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
emrcontainers.listSecurityConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • createdAfter — (Date)

    The date and time after which the security configuration was created.

  • createdBefore — (Date)

    The date and time before which the security configuration was created.

  • maxResults — (Integer)

    The maximum number of security configurations the operation can list.

  • nextToken — (String)

    The token for the next set of security configurations to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • securityConfigurations — (Array<map>)

      The list of returned security configurations.

      • id — (String)

        The ID of the security configuration.

      • name — (String)

        The name of the security configuration.

      • arn — (String)

        The ARN (Amazon Resource Name) of the security configuration.

      • createdAt — (Date)

        The date and time that the job run was created.

      • createdBy — (String)

        The user who created the job run.

      • securityConfigurationData — (map)

        Security configuration inputs for the request.

        • authorizationConfiguration — (map)

          Authorization-related configuration input for the security configuration.

          • lakeFormationConfiguration — (map)

            Lake Formation related configuration inputs for the security configuration.

            • authorizedSessionTagValue — (String)

              The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

            • secureNamespaceInfo — (map)

              The namespace input of the system job.

              • clusterId — (String)

                The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

              • namespace — (String)

                The namespace of the Amazon EKS cluster where the system jobs run.

            • queryEngineRoleArn — (String)

              The query engine IAM role ARN that is tied to the secure Spark job. The QueryEngine role assumes the JobExecutionRole to execute all the Lake Formation calls.

          • encryptionConfiguration — (map)

            Encryption-related configuration input for the security configuration.

            • inTransitEncryptionConfiguration — (map)

              In-transit encryption-related input for the security configuration.

              • tlsCertificateConfiguration — (map)

                TLS certificate-related configuration input for the security configuration.

                • certificateProviderType — (String)

                  The TLS certificate type. Acceptable values: PEM or Custom.

                  Possible values include:
                  • "PEM"
                • publicCertificateSecretArn — (String)

                  Secrets Manager ARN that contains the public TLS certificate contents, used for communication between the user job and the system job.

                • privateCertificateSecretArn — (String)

                  Secrets Manager ARN that contains the private TLS certificate contents, used for communication between the user job and the system job.

      • tags — (map<String>)

        The tags to assign to the security configuration.

    • nextToken — (String)

      The token for the next set of security configurations to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
emrcontainers.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of tagged resources.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The tags assigned to resources.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  containerProviderId: 'STRING_VALUE',
  containerProviderType: EKS,
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  eksAccessEntryIntegrated: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    RUNNING | TERMINATING | TERMINATED | ARRESTED,
    /* more items */
  ]
};
emrcontainers.listVirtualClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • containerProviderId — (String)

    The container provider ID of the virtual cluster.

  • containerProviderType — (String)

    The container provider type of the virtual cluster. Amazon EKS is the only supported type as of now.

    Possible values include:
    • "EKS"
  • createdAfter — (Date)

    The date and time after which the virtual clusters are created.

  • createdBefore — (Date)

    The date and time before which the virtual clusters are created.

  • states — (Array<String>)

    The states of the requested virtual clusters.

  • maxResults — (Integer)

    The maximum number of virtual clusters that can be listed.

  • nextToken — (String)

    The token for the next set of virtual clusters to return.

  • eksAccessEntryIntegrated — (Boolean)

    Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • virtualClusters — (Array<map>)

      This output lists the specified virtual clusters.

      • id — (String)

        The ID of the virtual cluster.

      • name — (String)

        The name of the virtual cluster.

      • arn — (String)

        The ARN of the virtual cluster.

      • state — (String)

        The state of the virtual cluster.

        Possible values include:
        • "RUNNING"
        • "TERMINATING"
        • "TERMINATED"
        • "ARRESTED"
      • containerProvider — (map)

        The container provider of the virtual cluster.

        • type — required — (String)

          The type of the container provider. Amazon EKS is the only supported type as of now.

          Possible values include:
          • "EKS"
        • id — required — (String)

          The ID of the container cluster.

        • info — (map)

          The information about the container cluster.

          • eksInfo — (map)

            The information about the Amazon EKS cluster.

            • namespace — (String)

              The namespaces of the Amazon EKS cluster.

      • createdAt — (Date)

        The date and time when the virtual cluster is created.

      • tags — (map<String>)

        The assigned tags of the virtual cluster.

      • securityConfigurationId — (String)

        The ID of the security configuration.

    • nextToken — (String)

      This output displays the token for the next set of virtual clusters.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientToken: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE', /* required */
  configurationOverrides: {
    applicationConfiguration: [ /* ConfigurationList */
      {
        classification: 'STRING_VALUE', /* required */
        configurations: /* recursive ConfigurationList */,
        properties: {
          '<String1024>': 'STRING_VALUE',
          /* '<String1024>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      cloudWatchMonitoringConfiguration: {
        logGroupName: 'STRING_VALUE', /* required */
        logStreamNamePrefix: 'STRING_VALUE'
      },
      containerLogRotationConfiguration: {
        maxFilesToKeep: 'NUMBER_VALUE', /* required */
        rotationSize: 'STRING_VALUE' /* required */
      },
      persistentAppUI: ENABLED | DISABLED,
      s3MonitoringConfiguration: {
        logUri: 'STRING_VALUE' /* required */
      }
    }
  },
  executionRoleArn: 'STRING_VALUE',
  jobDriver: {
    sparkSqlJobDriver: {
      entryPoint: 'STRING_VALUE',
      sparkSqlParameters: 'STRING_VALUE'
    },
    sparkSubmitJobDriver: {
      entryPoint: 'STRING_VALUE', /* required */
      entryPointArguments: [
        'STRING_VALUE',
        /* more items */
      ],
      sparkSubmitParameters: 'STRING_VALUE'
    }
  },
  jobTemplateId: 'STRING_VALUE',
  jobTemplateParameters: {
    '<TemplateParameterName>': 'STRING_VALUE',
    /* '<TemplateParameterName>': ... */
  },
  name: 'STRING_VALUE',
  releaseLabel: 'STRING_VALUE',
  retryPolicyConfiguration: {
    maxAttempts: 'NUMBER_VALUE' /* required */
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.startJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the job run.

  • virtualClusterId — (String)

    The virtual cluster ID for which the job run request is submitted.

  • clientToken — (String)

    The client idempotency token of the job run request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • executionRoleArn — (String)

    The execution role ARN for the job run.

  • releaseLabel — (String)

    The Amazon EMR release version to use for the job run.

  • jobDriver — (map)

    The job driver for the job run.

    • sparkSubmitJobDriver — (map)

      The job driver parameters specified for spark submit.

      • entryPoint — required — (String)

        The entry point of job application.

      • entryPointArguments — (Array<String>)

        The arguments for job application.

      • sparkSubmitParameters — (String)

        The Spark submit parameters that are used for job runs.

    • sparkSqlJobDriver — (map)

      The job driver for job type.

      • entryPoint — (String)

        The SQL file to be executed.

      • sparkSqlParameters — (String)

        The Spark parameters to be included in the Spark SQL command.

  • configurationOverrides — (map)

    The configuration overrides for the job run.

    • applicationConfiguration — (Array<map>)

      The configurations for the application running by the job run.

      • classification — required — (String)

        The classification within a configuration.

      • properties — (map<String>)

        A set of properties specified within a configuration classification.

    • monitoringConfiguration — (map)

      The configurations for monitoring.

      • persistentAppUI — (String)

        Monitoring configurations for the persistent application UI.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • cloudWatchMonitoringConfiguration — (map)

        Monitoring configurations for CloudWatch.

        • logGroupName — required — (String)

          The name of the log group for log publishing.

        • logStreamNamePrefix — (String)

          The specified name prefix for log streams.

      • s3MonitoringConfiguration — (map)

        Amazon S3 configuration for monitoring log publishing.

        • logUri — required — (String)

          Amazon S3 destination URI for log publishing.

      • containerLogRotationConfiguration — (map)

        Enable or disable container log rotation.

        • rotationSize — required — (String)

          The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

        • maxFilesToKeep — required — (Integer)

          The number of files to keep in container after rotation.

  • tags — (map<String>)

    The tags assigned to job runs.

  • jobTemplateId — (String)

    The job template ID to be used to start the job run.

  • jobTemplateParameters — (map<String>)

    The values of job template parameters to start a job run.

  • retryPolicyConfiguration — (map)

    The retry policy configuration for the job run.

    • maxAttempts — required — (Integer)

      The maximum number of attempts on the job's driver.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      This output displays the started job run ID.

    • name — (String)

      This output displays the name of the started job run.

    • arn — (String)

      This output lists the ARN of job run.

    • virtualClusterId — (String)

      This output displays the virtual cluster ID for which the job run was submitted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of resources.

  • tags — (map<String>)

    The tags assigned to resources.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
emrcontainers.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of resources.

  • tagKeys — (Array<String>)

    The tag keys of the resources.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.