amazonka-emr-serverless-2.0: Amazon EMR Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EMRServerless.Lens

Description

 
Synopsis

Operations

CancelJobRun

cancelJobRun_applicationId :: Lens' CancelJobRun Text Source #

The ID of the application on which the job run will be canceled.

cancelJobRun_jobRunId :: Lens' CancelJobRun Text Source #

The ID of the job run to cancel.

cancelJobRunResponse_applicationId :: Lens' CancelJobRunResponse Text Source #

The output contains the application ID on which the job run is cancelled.

cancelJobRunResponse_jobRunId :: Lens' CancelJobRunResponse Text Source #

The output contains the ID of the cancelled job run.

CreateApplication

createApplication_autoStartConfiguration :: Lens' CreateApplication (Maybe AutoStartConfig) Source #

The configuration for an application to automatically start on job submission.

createApplication_autoStopConfiguration :: Lens' CreateApplication (Maybe AutoStopConfig) Source #

The configuration for an application to automatically stop after a certain amount of time being idle.

createApplication_imageConfiguration :: Lens' CreateApplication (Maybe ImageConfigurationInput) Source #

The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications.

createApplication_initialCapacity :: Lens' CreateApplication (Maybe (HashMap Text InitialCapacityConfig)) Source #

The capacity to initialize when the application is created.

createApplication_maximumCapacity :: Lens' CreateApplication (Maybe MaximumAllowedResources) Source #

The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.

createApplication_networkConfiguration :: Lens' CreateApplication (Maybe NetworkConfiguration) Source #

The network configuration for customer VPC connectivity.

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #

The tags assigned to the application.

createApplication_workerTypeSpecifications :: Lens' CreateApplication (Maybe (HashMap Text WorkerTypeSpecificationInput)) Source #

The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

createApplication_releaseLabel :: Lens' CreateApplication Text Source #

The EMR release associated with the application.

createApplication_type :: Lens' CreateApplication Text Source #

The type of application you want to start, such as Spark or Hive.

createApplication_clientToken :: Lens' CreateApplication Text Source #

The client idempotency token of the application to create. Its value must be unique for each request.

createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text) Source #

The output contains the name of the application.

createApplicationResponse_arn :: Lens' CreateApplicationResponse Text Source #

The output contains the ARN of the application.

DeleteApplication

deleteApplication_applicationId :: Lens' DeleteApplication Text Source #

The ID of the application that will be deleted.

GetApplication

getApplication_applicationId :: Lens' GetApplication Text Source #

The ID of the application that will be described.

getApplicationResponse_application :: Lens' GetApplicationResponse Application Source #

The output displays information about the specified application.

GetDashboardForJobRun

GetJobRun

getJobRun_applicationId :: Lens' GetJobRun Text Source #

The ID of the application on which the job run is submitted.

getJobRun_jobRunId :: Lens' GetJobRun Text Source #

The ID of the job run.

getJobRunResponse_httpStatus :: Lens' GetJobRunResponse Int Source #

The response's http status code.

getJobRunResponse_jobRun :: Lens' GetJobRunResponse JobRun Source #

The output displays information about the job run.

ListApplications

listApplications_maxResults :: Lens' ListApplications (Maybe Natural) Source #

The maximum number of applications that can be listed.

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

The token for the next set of application results.

listApplications_states :: Lens' ListApplications (Maybe (NonEmpty ApplicationState)) Source #

An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

ListJobRuns

listJobRuns_createdAtAfter :: Lens' ListJobRuns (Maybe UTCTime) Source #

The lower bound of the option to filter by creation date and time.

listJobRuns_createdAtBefore :: Lens' ListJobRuns (Maybe UTCTime) Source #

The upper bound of the option to filter by creation date and time.

listJobRuns_maxResults :: Lens' ListJobRuns (Maybe Natural) Source #

The maximum number of job runs that can be listed.

listJobRuns_nextToken :: Lens' ListJobRuns (Maybe Text) Source #

The token for the next set of job run results.

listJobRuns_states :: Lens' ListJobRuns (Maybe [JobRunState]) Source #

An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

listJobRuns_applicationId :: Lens' ListJobRuns Text Source #

The ID of the application for which to list the job run.

listJobRunsResponse_nextToken :: Lens' ListJobRunsResponse (Maybe Text) Source #

The output displays the token for the next set of job run results. This is required for pagination and is available as a response of the previous request.

listJobRunsResponse_jobRuns :: Lens' ListJobRunsResponse [JobRunSummary] Source #

The output lists information about the specified job runs.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

StartApplication

startApplication_applicationId :: Lens' StartApplication Text Source #

The ID of the application to start.

StartJobRun

startJobRun_executionTimeoutMinutes :: Lens' StartJobRun (Maybe Natural) Source #

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

startJobRun_jobDriver :: Lens' StartJobRun (Maybe JobDriver) Source #

The job driver for the job run.

startJobRun_name :: Lens' StartJobRun (Maybe Text) Source #

The optional job run name. This doesn't have to be unique.

startJobRun_tags :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #

The tags assigned to the job run.

startJobRun_applicationId :: Lens' StartJobRun Text Source #

The ID of the application on which to run the job.

startJobRun_clientToken :: Lens' StartJobRun Text Source #

The client idempotency token of the job run to start. Its value must be unique for each request.

startJobRun_executionRoleArn :: Lens' StartJobRun Text Source #

The execution role ARN for the job run.

startJobRunResponse_applicationId :: Lens' StartJobRunResponse Text Source #

This output displays the application ID on which the job run was submitted.

startJobRunResponse_jobRunId :: Lens' StartJobRunResponse Text Source #

The output contains the ID of the started job run.

startJobRunResponse_arn :: Lens' StartJobRunResponse Text Source #

The output lists the execution role ARN of the job run.

StopApplication

stopApplication_applicationId :: Lens' StopApplication Text Source #

The ID of the application to stop.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to add to the resource. A tag is an array of key-value pairs.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the tags to be removed.

UpdateApplication

updateApplication_autoStartConfiguration :: Lens' UpdateApplication (Maybe AutoStartConfig) Source #

The configuration for an application to automatically start on job submission.

updateApplication_autoStopConfiguration :: Lens' UpdateApplication (Maybe AutoStopConfig) Source #

The configuration for an application to automatically stop after a certain amount of time being idle.

updateApplication_imageConfiguration :: Lens' UpdateApplication (Maybe ImageConfigurationInput) Source #

The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput.

updateApplication_initialCapacity :: Lens' UpdateApplication (Maybe (HashMap Text InitialCapacityConfig)) Source #

The capacity to initialize when the application is updated.

updateApplication_maximumCapacity :: Lens' UpdateApplication (Maybe MaximumAllowedResources) Source #

The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.

updateApplication_workerTypeSpecifications :: Lens' UpdateApplication (Maybe (HashMap Text WorkerTypeSpecificationInput)) Source #

The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

updateApplication_applicationId :: Lens' UpdateApplication Text Source #

The ID of the application to update.

updateApplication_clientToken :: Lens' UpdateApplication Text Source #

The client idempotency token of the application to update. Its value must be unique for each request.

Types

Application

application_architecture :: Lens' Application (Maybe Architecture) Source #

The CPU architecture of an application.

application_autoStartConfiguration :: Lens' Application (Maybe AutoStartConfig) Source #

The configuration for an application to automatically start on job submission.

application_autoStopConfiguration :: Lens' Application (Maybe AutoStopConfig) Source #

The configuration for an application to automatically stop after a certain amount of time being idle.

application_imageConfiguration :: Lens' Application (Maybe ImageConfiguration) Source #

The image configuration applied to all worker types.

application_maximumCapacity :: Lens' Application (Maybe MaximumAllowedResources) Source #

The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

application_name :: Lens' Application (Maybe Text) Source #

The name of the application.

application_networkConfiguration :: Lens' Application (Maybe NetworkConfiguration) Source #

The network configuration for customer VPC connectivity for the application.

application_stateDetails :: Lens' Application (Maybe Text) Source #

The state details of the application.

application_tags :: Lens' Application (Maybe (HashMap Text Text)) Source #

The tags assigned to the application.

application_arn :: Lens' Application Text Source #

The ARN of the application.

application_releaseLabel :: Lens' Application Text Source #

The EMR release associated with the application.

application_type :: Lens' Application Text Source #

The type of application, such as Spark or Hive.

application_createdAt :: Lens' Application UTCTime Source #

The date and time when the application run was created.

application_updatedAt :: Lens' Application UTCTime Source #

The date and time when the application run was last updated.

ApplicationSummary

applicationSummary_stateDetails :: Lens' ApplicationSummary (Maybe Text) Source #

The state details of the application.

applicationSummary_releaseLabel :: Lens' ApplicationSummary Text Source #

The EMR release associated with the application.

applicationSummary_type :: Lens' ApplicationSummary Text Source #

The type of application, such as Spark or Hive.

applicationSummary_createdAt :: Lens' ApplicationSummary UTCTime Source #

The date and time when the application was created.

applicationSummary_updatedAt :: Lens' ApplicationSummary UTCTime Source #

The date and time when the application was last updated.

AutoStartConfig

autoStartConfig_enabled :: Lens' AutoStartConfig (Maybe Bool) Source #

Enables the application to automatically start on job submission. Defaults to true.

AutoStopConfig

autoStopConfig_enabled :: Lens' AutoStopConfig (Maybe Bool) Source #

Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

autoStopConfig_idleTimeoutMinutes :: Lens' AutoStopConfig (Maybe Natural) Source #

The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

Configuration

configuration_configurations :: Lens' Configuration (Maybe [Configuration]) Source #

A list of additional configurations to apply within a configuration object.

configuration_properties :: Lens' Configuration (Maybe (HashMap Text Text)) Source #

A set of properties specified within a configuration classification.

configuration_classification :: Lens' Configuration Text Source #

The classification within a configuration.

ConfigurationOverrides

Hive

hive_initQueryFile :: Lens' Hive (Maybe Text) Source #

The query file for the Hive job run.

hive_parameters :: Lens' Hive (Maybe Text) Source #

The parameters for the Hive job run.

hive_query :: Lens' Hive Text Source #

The query for the Hive job run.

ImageConfiguration

imageConfiguration_resolvedImageDigest :: Lens' ImageConfiguration (Maybe Text) Source #

The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.

ImageConfigurationInput

imageConfigurationInput_imageUri :: Lens' ImageConfigurationInput (Maybe Text) Source #

The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

InitialCapacityConfig

initialCapacityConfig_workerConfiguration :: Lens' InitialCapacityConfig (Maybe WorkerResourceConfig) Source #

The resource configuration of the initial capacity configuration.

initialCapacityConfig_workerCount :: Lens' InitialCapacityConfig Natural Source #

The number of workers in the initial capacity configuration.

JobDriver

jobDriver_hive :: Lens' JobDriver (Maybe Hive) Source #

The job driver parameters specified for Hive.

jobDriver_sparkSubmit :: Lens' JobDriver (Maybe SparkSubmit) Source #

The job driver parameters specified for Spark.

JobRun

jobRun_configurationOverrides :: Lens' JobRun (Maybe ConfigurationOverrides) Source #

The configuration settings that are used to override default configuration.

jobRun_name :: Lens' JobRun (Maybe Text) Source #

The optional job run name. This doesn't have to be unique.

jobRun_tags :: Lens' JobRun (Maybe (HashMap Text Text)) Source #

The tags assigned to the job run.

jobRun_totalExecutionDurationSeconds :: Lens' JobRun (Maybe Int) Source #

The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED, FAILED, or CANCELLED state.

jobRun_totalResourceUtilization :: Lens' JobRun (Maybe TotalResourceUtilization) Source #

The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated, rounded up to the nearest second.

jobRun_applicationId :: Lens' JobRun Text Source #

The ID of the application the job is running on.

jobRun_jobRunId :: Lens' JobRun Text Source #

The ID of the job run.

jobRun_arn :: Lens' JobRun Text Source #

The execution role ARN of the job run.

jobRun_createdBy :: Lens' JobRun Text Source #

The user who created the job run.

jobRun_createdAt :: Lens' JobRun UTCTime Source #

The date and time when the job run was created.

jobRun_updatedAt :: Lens' JobRun UTCTime Source #

The date and time when the job run was updated.

jobRun_executionRole :: Lens' JobRun Text Source #

The execution role ARN of the job run.

jobRun_state :: Lens' JobRun JobRunState Source #

The state of the job run.

jobRun_stateDetails :: Lens' JobRun Text Source #

The state details of the job run.

jobRun_releaseLabel :: Lens' JobRun Text Source #

The EMR release associated with the application your job is running on.

jobRun_jobDriver :: Lens' JobRun JobDriver Source #

The job driver for the job run.

JobRunSummary

jobRunSummary_name :: Lens' JobRunSummary (Maybe Text) Source #

The optional job run name. This doesn't have to be unique.

jobRunSummary_type :: Lens' JobRunSummary (Maybe Text) Source #

The type of job run, such as Spark or Hive.

jobRunSummary_applicationId :: Lens' JobRunSummary Text Source #

The ID of the application the job is running on.

jobRunSummary_id :: Lens' JobRunSummary Text Source #

The ID of the job run.

jobRunSummary_arn :: Lens' JobRunSummary Text Source #

The ARN of the job run.

jobRunSummary_createdBy :: Lens' JobRunSummary Text Source #

The user who created the job run.

jobRunSummary_createdAt :: Lens' JobRunSummary UTCTime Source #

The date and time when the job run was created.

jobRunSummary_updatedAt :: Lens' JobRunSummary UTCTime Source #

The date and time when the job run was last updated.

jobRunSummary_executionRole :: Lens' JobRunSummary Text Source #

The execution role ARN of the job run.

jobRunSummary_stateDetails :: Lens' JobRunSummary Text Source #

The state details of the job run.

jobRunSummary_releaseLabel :: Lens' JobRunSummary Text Source #

The EMR release associated with the application your job is running on.

ManagedPersistenceMonitoringConfiguration

managedPersistenceMonitoringConfiguration_enabled :: Lens' ManagedPersistenceMonitoringConfiguration (Maybe Bool) Source #

Enables managed logging and defaults to true. If set to false, managed logging will be turned off.

managedPersistenceMonitoringConfiguration_encryptionKeyArn :: Lens' ManagedPersistenceMonitoringConfiguration (Maybe Text) Source #

The KMS key ARN to encrypt the logs stored in managed log persistence.

MaximumAllowedResources

maximumAllowedResources_disk :: Lens' MaximumAllowedResources (Maybe Text) Source #

The maximum allowed disk for an application.

maximumAllowedResources_cpu :: Lens' MaximumAllowedResources Text Source #

The maximum allowed CPU for an application.

maximumAllowedResources_memory :: Lens' MaximumAllowedResources Text Source #

The maximum allowed resources for an application.

MonitoringConfiguration

NetworkConfiguration

networkConfiguration_securityGroupIds :: Lens' NetworkConfiguration (Maybe [Text]) Source #

The array of security group Ids for customer VPC connectivity.

networkConfiguration_subnetIds :: Lens' NetworkConfiguration (Maybe [Text]) Source #

The array of subnet Ids for customer VPC connectivity.

S3MonitoringConfiguration

s3MonitoringConfiguration_encryptionKeyArn :: Lens' S3MonitoringConfiguration (Maybe Text) Source #

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

s3MonitoringConfiguration_logUri :: Lens' S3MonitoringConfiguration (Maybe Text) Source #

The Amazon S3 destination URI for log publishing.

SparkSubmit

sparkSubmit_entryPointArguments :: Lens' SparkSubmit (Maybe [Text]) Source #

The arguments for the Spark submit job run.

sparkSubmit_sparkSubmitParameters :: Lens' SparkSubmit (Maybe Text) Source #

The parameters for the Spark submit job run.

sparkSubmit_entryPoint :: Lens' SparkSubmit Text Source #

The entry point for the Spark submit job run.

TotalResourceUtilization

totalResourceUtilization_memoryGBHour :: Lens' TotalResourceUtilization (Maybe Double) Source #

The aggregated memory used per hour from the time job start executing till the time job is terminated.

totalResourceUtilization_storageGBHour :: Lens' TotalResourceUtilization (Maybe Double) Source #

The aggregated storage used per hour from the time job start executing till the time job is terminated.

totalResourceUtilization_vCPUHour :: Lens' TotalResourceUtilization (Maybe Double) Source #

The aggregated vCPU used per hour from the time job start executing till the time job is terminated.

WorkerResourceConfig

workerResourceConfig_disk :: Lens' WorkerResourceConfig (Maybe Text) Source #

The disk requirements for every worker instance of the worker type.

workerResourceConfig_cpu :: Lens' WorkerResourceConfig Text Source #

The CPU requirements for every worker instance of the worker type.

workerResourceConfig_memory :: Lens' WorkerResourceConfig Text Source #

The memory requirements for every worker instance of the worker type.

WorkerTypeSpecification

WorkerTypeSpecificationInput