amazonka-emr-containers-2.0: Amazon EMR Containers 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.EMRContainers.Lens

Description

 
Synopsis

Operations

CancelJobRun

cancelJobRun_id :: Lens' CancelJobRun Text Source #

The ID of the job run to cancel.

cancelJobRun_virtualClusterId :: Lens' CancelJobRun Text Source #

The ID of the virtual cluster for which the job run will be canceled.

cancelJobRunResponse_id :: Lens' CancelJobRunResponse (Maybe Text) Source #

The output contains the ID of the cancelled job run.

cancelJobRunResponse_virtualClusterId :: Lens' CancelJobRunResponse (Maybe Text) Source #

The output contains the virtual cluster ID for which the job run is cancelled.

CreateJobTemplate

createJobTemplate_kmsKeyArn :: Lens' CreateJobTemplate (Maybe Text) Source #

The KMS key ARN used to encrypt the job template.

createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe (HashMap Text Text)) Source #

The tags that are associated with the job template.

createJobTemplate_name :: Lens' CreateJobTemplate Text Source #

The specified name of the job template.

createJobTemplate_clientToken :: Lens' CreateJobTemplate Text Source #

The client token of the job template.

createJobTemplate_jobTemplateData :: Lens' CreateJobTemplate JobTemplateData Source #

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

createJobTemplateResponse_arn :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

This output display the ARN of the created job template.

createJobTemplateResponse_createdAt :: Lens' CreateJobTemplateResponse (Maybe UTCTime) Source #

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

createJobTemplateResponse_id :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

This output display the created job template ID.

createJobTemplateResponse_name :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

This output displays the name of the created job template.

CreateManagedEndpoint

createManagedEndpoint_certificateArn :: Lens' CreateManagedEndpoint (Maybe Text) Source #

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

createManagedEndpoint_configurationOverrides :: Lens' CreateManagedEndpoint (Maybe ConfigurationOverrides) Source #

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

createManagedEndpoint_virtualClusterId :: Lens' CreateManagedEndpoint Text Source #

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

createManagedEndpoint_clientToken :: Lens' CreateManagedEndpoint Text Source #

The client idempotency token for this create call.

createManagedEndpointResponse_arn :: Lens' CreateManagedEndpointResponse (Maybe Text) Source #

The output contains the ARN of the managed endpoint.

createManagedEndpointResponse_id :: Lens' CreateManagedEndpointResponse (Maybe Text) Source #

The output contains the ID of the managed endpoint.

createManagedEndpointResponse_name :: Lens' CreateManagedEndpointResponse (Maybe Text) Source #

The output contains the name of the managed endpoint.

CreateVirtualCluster

createVirtualCluster_tags :: Lens' CreateVirtualCluster (Maybe (HashMap Text Text)) Source #

The tags assigned to the virtual cluster.

createVirtualCluster_name :: Lens' CreateVirtualCluster Text Source #

The specified name of the virtual cluster.

createVirtualCluster_clientToken :: Lens' CreateVirtualCluster Text Source #

The client token of the virtual cluster.

createVirtualClusterResponse_arn :: Lens' CreateVirtualClusterResponse (Maybe Text) Source #

This output contains the ARN of virtual cluster.

createVirtualClusterResponse_id :: Lens' CreateVirtualClusterResponse (Maybe Text) Source #

This output contains the virtual cluster ID.

createVirtualClusterResponse_name :: Lens' CreateVirtualClusterResponse (Maybe Text) Source #

This output contains the name of the virtual cluster.

DeleteJobTemplate

deleteJobTemplate_id :: Lens' DeleteJobTemplate Text Source #

The ID of the job template that will be deleted.

deleteJobTemplateResponse_id :: Lens' DeleteJobTemplateResponse (Maybe Text) Source #

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

DeleteManagedEndpoint

deleteManagedEndpointResponse_id :: Lens' DeleteManagedEndpointResponse (Maybe Text) Source #

The output displays the ID of the managed endpoint.

deleteManagedEndpointResponse_virtualClusterId :: Lens' DeleteManagedEndpointResponse (Maybe Text) Source #

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

DeleteVirtualCluster

deleteVirtualCluster_id :: Lens' DeleteVirtualCluster Text Source #

The ID of the virtual cluster that will be deleted.

deleteVirtualClusterResponse_id :: Lens' DeleteVirtualClusterResponse (Maybe Text) Source #

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

DescribeJobRun

describeJobRun_id :: Lens' DescribeJobRun Text Source #

The ID of the job run request.

describeJobRun_virtualClusterId :: Lens' DescribeJobRun Text Source #

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

describeJobRunResponse_jobRun :: Lens' DescribeJobRunResponse (Maybe JobRun) Source #

The output displays information about a job run.

DescribeJobTemplate

describeJobTemplate_id :: Lens' DescribeJobTemplate Text Source #

The ID of the job template that will be described.

describeJobTemplateResponse_jobTemplate :: Lens' DescribeJobTemplateResponse (Maybe JobTemplate) Source #

This output displays information about the specified job template.

DescribeManagedEndpoint

describeManagedEndpoint_id :: Lens' DescribeManagedEndpoint Text Source #

This output displays ID of the managed endpoint.

describeManagedEndpointResponse_endpoint :: Lens' DescribeManagedEndpointResponse (Maybe Endpoint) Source #

This output displays information about a managed endpoint.

DescribeVirtualCluster

describeVirtualCluster_id :: Lens' DescribeVirtualCluster Text Source #

The ID of the virtual cluster that will be described.

describeVirtualClusterResponse_virtualCluster :: Lens' DescribeVirtualClusterResponse (Maybe VirtualCluster) Source #

This output displays information about the specified virtual cluster.

ListJobRuns

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

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

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

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

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

The maximum number of job runs that can be listed.

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

The name of the job run.

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

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

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

The states of the job run.

listJobRuns_virtualClusterId :: Lens' ListJobRuns Text Source #

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

listJobRunsResponse_jobRuns :: Lens' ListJobRunsResponse (Maybe [JobRun]) Source #

This output lists information about the specified job runs.

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

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

ListJobTemplates

listJobTemplates_createdAfter :: Lens' ListJobTemplates (Maybe UTCTime) Source #

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

listJobTemplates_createdBefore :: Lens' ListJobTemplates (Maybe UTCTime) Source #

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

listJobTemplates_maxResults :: Lens' ListJobTemplates (Maybe Int) Source #

The maximum number of job templates that can be listed.

listJobTemplates_nextToken :: Lens' ListJobTemplates (Maybe Text) Source #

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

listJobTemplatesResponse_nextToken :: Lens' ListJobTemplatesResponse (Maybe Text) Source #

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

listJobTemplatesResponse_templates :: Lens' ListJobTemplatesResponse (Maybe [JobTemplate]) Source #

This output lists information about the specified job templates.

ListManagedEndpoints

listManagedEndpoints_createdAfter :: Lens' ListManagedEndpoints (Maybe UTCTime) Source #

The date and time after which the endpoints are created.

listManagedEndpoints_createdBefore :: Lens' ListManagedEndpoints (Maybe UTCTime) Source #

The date and time before which the endpoints are created.

listManagedEndpoints_maxResults :: Lens' ListManagedEndpoints (Maybe Int) Source #

The maximum number of managed endpoints that can be listed.

listManagedEndpoints_nextToken :: Lens' ListManagedEndpoints (Maybe Text) Source #

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

listManagedEndpoints_types :: Lens' ListManagedEndpoints (Maybe [Text]) Source #

The types of the managed endpoints.

listManagedEndpointsResponse_nextToken :: Lens' ListManagedEndpointsResponse (Maybe Text) Source #

The token for the next set of endpoints to return.

ListTagsForResource

ListVirtualClusters

listVirtualClusters_containerProviderId :: Lens' ListVirtualClusters (Maybe Text) Source #

The container provider ID of the virtual cluster.

listVirtualClusters_containerProviderType :: Lens' ListVirtualClusters (Maybe ContainerProviderType) Source #

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

listVirtualClusters_createdAfter :: Lens' ListVirtualClusters (Maybe UTCTime) Source #

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

listVirtualClusters_createdBefore :: Lens' ListVirtualClusters (Maybe UTCTime) Source #

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

listVirtualClusters_maxResults :: Lens' ListVirtualClusters (Maybe Int) Source #

The maximum number of virtual clusters that can be listed.

listVirtualClusters_nextToken :: Lens' ListVirtualClusters (Maybe Text) Source #

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

listVirtualClusters_states :: Lens' ListVirtualClusters (Maybe [VirtualClusterState]) Source #

The states of the requested virtual clusters.

listVirtualClustersResponse_nextToken :: Lens' ListVirtualClustersResponse (Maybe Text) Source #

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

StartJobRun

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

The execution role ARN for the job run.

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

The job driver for the job run.

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

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

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

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

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

The name of the job run.

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

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

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

The tags assigned to job runs.

startJobRun_virtualClusterId :: Lens' StartJobRun Text Source #

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

startJobRun_clientToken :: Lens' StartJobRun Text Source #

The client idempotency token of the job run request.

startJobRunResponse_arn :: Lens' StartJobRunResponse (Maybe Text) Source #

This output lists the ARN of job run.

startJobRunResponse_id :: Lens' StartJobRunResponse (Maybe Text) Source #

This output displays the started job run ID.

startJobRunResponse_name :: Lens' StartJobRunResponse (Maybe Text) Source #

This output displays the name of the started job run.

startJobRunResponse_virtualClusterId :: Lens' StartJobRunResponse (Maybe Text) Source #

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

TagResource

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

The tags assigned to resources.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys of the resources.

Types

Certificate

certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #

The ARN of the certificate generated for managed endpoint.

certificate_certificateData :: Lens' Certificate (Maybe Text) Source #

The base64 encoded PEM certificate data generated for managed endpoint.

CloudWatchMonitoringConfiguration

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

configurationOverrides_applicationConfiguration :: Lens' ConfigurationOverrides (Maybe [Configuration]) Source #

The configurations for the application running by the job run.

ContainerInfo

containerInfo_eksInfo :: Lens' ContainerInfo (Maybe EksInfo) Source #

The information about the EKS cluster.

ContainerProvider

containerProvider_info :: Lens' ContainerProvider (Maybe ContainerInfo) Source #

The information about the container cluster.

containerProvider_type :: Lens' ContainerProvider ContainerProviderType Source #

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

containerProvider_id :: Lens' ContainerProvider Text Source #

The ID of the container cluster.

EksInfo

eksInfo_namespace :: Lens' EksInfo (Maybe Text) Source #

The namespaces of the EKS cluster.

Endpoint

endpoint_arn :: Lens' Endpoint (Maybe Text) Source #

The ARN of the endpoint.

endpoint_certificateArn :: Lens' Endpoint (Maybe Text) Source #

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

endpoint_certificateAuthority :: Lens' Endpoint (Maybe Certificate) Source #

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

endpoint_configurationOverrides :: Lens' Endpoint (Maybe ConfigurationOverrides) Source #

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

endpoint_createdAt :: Lens' Endpoint (Maybe UTCTime) Source #

The date and time when the endpoint was created.

endpoint_executionRoleArn :: Lens' Endpoint (Maybe Text) Source #

The execution role ARN of the endpoint.

endpoint_failureReason :: Lens' Endpoint (Maybe FailureReason) Source #

The reasons why the endpoint has failed.

endpoint_id :: Lens' Endpoint (Maybe Text) Source #

The ID of the endpoint.

endpoint_name :: Lens' Endpoint (Maybe Text) Source #

The name of the endpoint.

endpoint_releaseLabel :: Lens' Endpoint (Maybe Text) Source #

The EMR release version to be used for the endpoint.

endpoint_securityGroup :: Lens' Endpoint (Maybe Text) Source #

The security group configuration of the endpoint.

endpoint_serverUrl :: Lens' Endpoint (Maybe Text) Source #

The server URL of the endpoint.

endpoint_state :: Lens' Endpoint (Maybe EndpointState) Source #

The state of the endpoint.

endpoint_stateDetails :: Lens' Endpoint (Maybe Text) Source #

Additional details of the endpoint state.

endpoint_subnetIds :: Lens' Endpoint (Maybe [Text]) Source #

The subnet IDs of the endpoint.

endpoint_tags :: Lens' Endpoint (Maybe (HashMap Text Text)) Source #

The tags of the endpoint.

endpoint_type :: Lens' Endpoint (Maybe Text) Source #

The type of the endpoint.

endpoint_virtualClusterId :: Lens' Endpoint (Maybe Text) Source #

The ID of the endpoint's virtual cluster.

JobDriver

jobDriver_sparkSubmitJobDriver :: Lens' JobDriver (Maybe SparkSubmitJobDriver) Source #

The job driver parameters specified for spark submit.

JobRun

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

The ARN of job run.

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

The client token used to start a job run.

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

The configuration settings that are used to override default configuration.

jobRun_createdAt :: Lens' JobRun (Maybe UTCTime) Source #

The date and time when the job run was created.

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

The user who created the job run.

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

The execution role ARN of the job run.

jobRun_failureReason :: Lens' JobRun (Maybe FailureReason) Source #

The reasons why the job run has failed.

jobRun_finishedAt :: Lens' JobRun (Maybe UTCTime) Source #

The date and time when the job run has finished.

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

The ID of the job run.

jobRun_jobDriver :: Lens' JobRun (Maybe JobDriver) Source #

Parameters of job driver for the job run.

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

The name of the job run.

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

The release version of Amazon EMR.

jobRun_state :: Lens' JobRun (Maybe JobRunState) Source #

The state of the job run.

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

Additional details of the job run state.

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

The assigned tags of the job run.

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

The ID of the job run's virtual cluster.

JobTemplate

jobTemplate_arn :: Lens' JobTemplate (Maybe Text) Source #

The ARN of the job template.

jobTemplate_createdAt :: Lens' JobTemplate (Maybe UTCTime) Source #

The date and time when the job template was created.

jobTemplate_createdBy :: Lens' JobTemplate (Maybe Text) Source #

The user who created the job template.

jobTemplate_decryptionError :: Lens' JobTemplate (Maybe Text) Source #

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

jobTemplate_id :: Lens' JobTemplate (Maybe Text) Source #

The ID of the job template.

jobTemplate_kmsKeyArn :: Lens' JobTemplate (Maybe Text) Source #

The KMS key ARN used to encrypt the job template.

jobTemplate_name :: Lens' JobTemplate (Maybe Text) Source #

The name of the job template.

jobTemplate_tags :: Lens' JobTemplate (Maybe (HashMap Text Text)) Source #

The tags assigned to the job template.

jobTemplate_jobTemplateData :: Lens' JobTemplate JobTemplateData Source #

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

JobTemplateData

jobTemplateData_configurationOverrides :: Lens' JobTemplateData (Maybe ParametricConfigurationOverrides) Source #

The configuration settings that are used to override defaults configuration.

jobTemplateData_jobTags :: Lens' JobTemplateData (Maybe (HashMap Text Text)) Source #

The tags assigned to jobs started using the job template.

jobTemplateData_parameterConfiguration :: Lens' JobTemplateData (Maybe (HashMap Text TemplateParameterConfiguration)) Source #

The configuration of parameters existing in the job template.

jobTemplateData_executionRoleArn :: Lens' JobTemplateData Text Source #

The execution role ARN of the job run.

jobTemplateData_releaseLabel :: Lens' JobTemplateData Text Source #

The release version of Amazon EMR.

MonitoringConfiguration

monitoringConfiguration_persistentAppUI :: Lens' MonitoringConfiguration (Maybe PersistentAppUI) Source #

Monitoring configurations for the persistent application UI.

ParametricCloudWatchMonitoringConfiguration

ParametricConfigurationOverrides

ParametricMonitoringConfiguration

parametricMonitoringConfiguration_persistentAppUI :: Lens' ParametricMonitoringConfiguration (Maybe Text) Source #

Monitoring configurations for the persistent application UI.

ParametricS3MonitoringConfiguration

S3MonitoringConfiguration

s3MonitoringConfiguration_logUri :: Lens' S3MonitoringConfiguration Text Source #

Amazon S3 destination URI for log publishing.

SparkSqlJobDriver

sparkSqlJobDriver_sparkSqlParameters :: Lens' SparkSqlJobDriver (Maybe Text) Source #

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

SparkSubmitJobDriver

sparkSubmitJobDriver_sparkSubmitParameters :: Lens' SparkSubmitJobDriver (Maybe Text) Source #

The Spark submit parameters that are used for job runs.

TemplateParameterConfiguration

templateParameterConfiguration_type :: Lens' TemplateParameterConfiguration (Maybe TemplateParameterDataType) Source #

The type of the job template parameter. Allowed values are: ‘String’, ‘Number’.

VirtualCluster

virtualCluster_arn :: Lens' VirtualCluster (Maybe Text) Source #

The ARN of the virtual cluster.

virtualCluster_containerProvider :: Lens' VirtualCluster (Maybe ContainerProvider) Source #

The container provider of the virtual cluster.

virtualCluster_createdAt :: Lens' VirtualCluster (Maybe UTCTime) Source #

The date and time when the virtual cluster is created.

virtualCluster_id :: Lens' VirtualCluster (Maybe Text) Source #

The ID of the virtual cluster.

virtualCluster_name :: Lens' VirtualCluster (Maybe Text) Source #

The name of the virtual cluster.

virtualCluster_tags :: Lens' VirtualCluster (Maybe (HashMap Text Text)) Source #

The assigned tags of the virtual cluster.