EMR Serverless Web Service

2022/05/26 - EMR Serverless Web Service - 14 new api methods

Changes  This release adds support for Amazon EMR Serverless, a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive.

CancelJobRun (new) Link ¶

Cancels a job run.

See also: AWS API Documentation

Request Syntax

client.cancel_job_run(
    applicationId='string',
    jobRunId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

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

type jobRunId

string

param jobRunId

[REQUIRED]

The ID of the job run to cancel.

rtype

dict

returns

Response Syntax

{
    'applicationId': 'string',
    'jobRunId': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

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

    • jobRunId (string) --

      The output contains the ID of the cancelled job run.

TagResource (new) Link ¶

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn

string

param resourceArn

[REQUIRED]

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.

type tags

dict

param tags

[REQUIRED]

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

StartApplication (new) Link ¶

Starts a specified application and initializes initial capacity if configured.

See also: AWS API Documentation

Request Syntax

client.start_application(
    applicationId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

The ID of the application to start.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

StartJobRun (new) Link ¶

Starts a job run.

See also: AWS API Documentation

Request Syntax

client.start_job_run(
    applicationId='string',
    clientToken='string',
    executionRoleArn='string',
    jobDriver={
        'sparkSubmit': {
            'entryPoint': 'string',
            'entryPointArguments': [
                'string',
            ],
            'sparkSubmitParameters': 'string'
        },
        'hive': {
            'query': 'string',
            'initQueryFile': 'string',
            'parameters': 'string'
        }
    },
    configurationOverrides={
        'applicationConfiguration': [
            {
                'classification': 'string',
                'properties': {
                    'string': 'string'
                },
                'configurations': {'... recursive ...'}
            },
        ],
        'monitoringConfiguration': {
            's3MonitoringConfiguration': {
                'logUri': 'string',
                'encryptionKeyArn': 'string'
            },
            'managedPersistenceMonitoringConfiguration': {
                'enabled': True|False,
                'encryptionKeyArn': 'string'
            }
        }
    },
    tags={
        'string': 'string'
    },
    executionTimeoutMinutes=123,
    name='string'
)
type applicationId

string

param applicationId

[REQUIRED]

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

type clientToken

string

param clientToken

[REQUIRED]

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

This field is autopopulated if not provided.

type executionRoleArn

string

param executionRoleArn

[REQUIRED]

The execution role ARN for the job run.

type jobDriver

dict

param jobDriver

The job driver for the job run.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: sparkSubmit, hive.

  • sparkSubmit (dict) --

    The job driver parameters specified for Spark.

    • entryPoint (string) -- [REQUIRED]

      The entry point for the Spark submit job run.

    • entryPointArguments (list) --

      The arguments for the Spark submit job run.

      • (string) --

    • sparkSubmitParameters (string) --

      The parameters for the Spark submit job run.

  • hive (dict) --

    The job driver parameters specified for Hive.

    • query (string) -- [REQUIRED]

      The query for the Hive job run.

    • initQueryFile (string) --

      The query file for the Hive job run.

    • parameters (string) --

      The parameters for the Hive job run.

type configurationOverrides

dict

param configurationOverrides

The configuration overrides for the job run.

  • applicationConfiguration (list) --

    The override configurations for the application.

    • (dict) --

      A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

      • classification (string) -- [REQUIRED]

        The classification within a configuration.

      • properties (dict) --

        A set of properties specified within a configuration classification.

        • (string) --

          • (string) --

      • configurations (list) --

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

  • monitoringConfiguration (dict) --

    The override configurations for monitoring.

    • s3MonitoringConfiguration (dict) --

      The Amazon S3 configuration for monitoring log publishing.

      • logUri (string) --

        The Amazon S3 destination URI for log publishing.

      • encryptionKeyArn (string) --

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

    • managedPersistenceMonitoringConfiguration (dict) --

      The managed log persistence configuration for a job run.

      • enabled (boolean) --

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

      • encryptionKeyArn (string) --

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

type tags

dict

param tags

The tags assigned to the job run.

  • (string) --

    • (string) --

type executionTimeoutMinutes

integer

param executionTimeoutMinutes

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

type name

string

param name

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

rtype

dict

returns

Response Syntax

{
    'applicationId': 'string',
    'jobRunId': 'string',
    'arn': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

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

    • jobRunId (string) --

      The output contains the ID of the started job run.

    • arn (string) --

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

GetJobRun (new) Link ¶

Displays detailed information about a job run.

See also: AWS API Documentation

Request Syntax

client.get_job_run(
    applicationId='string',
    jobRunId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

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

type jobRunId

string

param jobRunId

[REQUIRED]

The ID of the job run.

rtype

dict

returns

Response Syntax

{
    'jobRun': {
        'applicationId': 'string',
        'jobRunId': 'string',
        'name': 'string',
        'arn': 'string',
        'createdBy': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'executionRole': 'string',
        'state': 'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
        'stateDetails': 'string',
        'releaseLabel': 'string',
        'configurationOverrides': {
            'applicationConfiguration': [
                {
                    'classification': 'string',
                    'properties': {
                        'string': 'string'
                    },
                    'configurations': {'... recursive ...'}
                },
            ],
            'monitoringConfiguration': {
                's3MonitoringConfiguration': {
                    'logUri': 'string',
                    'encryptionKeyArn': 'string'
                },
                'managedPersistenceMonitoringConfiguration': {
                    'enabled': True|False,
                    'encryptionKeyArn': 'string'
                }
            }
        },
        'jobDriver': {
            'sparkSubmit': {
                'entryPoint': 'string',
                'entryPointArguments': [
                    'string',
                ],
                'sparkSubmitParameters': 'string'
            },
            'hive': {
                'query': 'string',
                'initQueryFile': 'string',
                'parameters': 'string'
            }
        },
        'tags': {
            'string': 'string'
        },
        'totalResourceUtilization': {
            'vCPUHour': 123.0,
            'memoryGBHour': 123.0,
            'storageGBHour': 123.0
        },
        'networkConfiguration': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ]
        },
        'totalExecutionDurationSeconds': 123
    }
}

Response Structure

  • (dict) --

    • jobRun (dict) --

      The output displays information about the job run.

      • applicationId (string) --

        The ID of the application the job is running on.

      • jobRunId (string) --

        The ID of the job run.

      • name (string) --

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

      • arn (string) --

        The execution role ARN of the job run.

      • createdBy (string) --

        The user who created the job run.

      • createdAt (datetime) --

        The date and time when the job run was created.

      • updatedAt (datetime) --

        The date and time when the job run was updated.

      • executionRole (string) --

        The execution role ARN of the job run.

      • state (string) --

        The state of the job run.

      • stateDetails (string) --

        The state details of the job run.

      • releaseLabel (string) --

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

      • configurationOverrides (dict) --

        The configuration settings that are used to override default configuration.

        • applicationConfiguration (list) --

          The override configurations for the application.

          • (dict) --

            A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

            • classification (string) --

              The classification within a configuration.

            • properties (dict) --

              A set of properties specified within a configuration classification.

              • (string) --

                • (string) --

            • configurations (list) --

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

        • monitoringConfiguration (dict) --

          The override configurations for monitoring.

          • s3MonitoringConfiguration (dict) --

            The Amazon S3 configuration for monitoring log publishing.

            • logUri (string) --

              The Amazon S3 destination URI for log publishing.

            • encryptionKeyArn (string) --

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

          • managedPersistenceMonitoringConfiguration (dict) --

            The managed log persistence configuration for a job run.

            • enabled (boolean) --

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

            • encryptionKeyArn (string) --

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

      • jobDriver (dict) --

        The job driver for the job run.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: sparkSubmit, hive. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • sparkSubmit (dict) --

          The job driver parameters specified for Spark.

          • entryPoint (string) --

            The entry point for the Spark submit job run.

          • entryPointArguments (list) --

            The arguments for the Spark submit job run.

            • (string) --

          • sparkSubmitParameters (string) --

            The parameters for the Spark submit job run.

        • hive (dict) --

          The job driver parameters specified for Hive.

          • query (string) --

            The query for the Hive job run.

          • initQueryFile (string) --

            The query file for the Hive job run.

          • parameters (string) --

            The parameters for the Hive job run.

      • tags (dict) --

        The tags assigned to the job run.

        • (string) --

          • (string) --

      • totalResourceUtilization (dict) --

        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.

        • vCPUHour (float) --

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

        • memoryGBHour (float) --

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

        • storageGBHour (float) --

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

      • networkConfiguration (dict) --

        The network configuration for customer VPC connectivity.

        • subnetIds (list) --

          The array of subnet Ids for customer VPC connectivity.

          • (string) --

        • securityGroupIds (list) --

          The array of security group Ids for customer VPC connectivity.

          • (string) --

      • totalExecutionDurationSeconds (integer) --

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

DeleteApplication (new) Link ¶

Deletes an application. An application has to be in a stopped or created state in order to be deleted.

See also: AWS API Documentation

Request Syntax

client.delete_application(
    applicationId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

The ID of the application that will be deleted.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListApplications (new) Link ¶

Lists applications based on a set of parameters.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    nextToken='string',
    maxResults=123,
    states=[
        'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
    ]
)
type nextToken

string

param nextToken

The token for the next set of application results.

type maxResults

integer

param maxResults

The maximum number of applications that can be listed.

type states

list

param states

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

  • (string) --

rtype

dict

returns

Response Syntax

{
    'applications': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'releaseLabel': 'string',
            'type': 'string',
            'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
            'stateDetails': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • applications (list) --

      The output lists the specified applications.

      • (dict) --

        The summary of attributes associated with an application.

        • id (string) --

          The ID of the application.

        • name (string) --

          The name of the application.

        • arn (string) --

          The ARN of the application.

        • releaseLabel (string) --

          The EMR release version associated with the application.

        • type (string) --

          The type of application, such as Spark or Hive.

        • state (string) --

          The state of the application.

        • stateDetails (string) --

          The state details of the application.

        • createdAt (datetime) --

          The date and time when the application was created.

        • updatedAt (datetime) --

          The date and time when the application was last updated.

    • nextToken (string) --

      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.

StopApplication (new) Link ¶

Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.

See also: AWS API Documentation

Request Syntax

client.stop_application(
    applicationId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

The ID of the application to stop.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UpdateApplication (new) Link ¶

Updates a specified application. An application has to be in a stopped or created state in order to be updated.

See also: AWS API Documentation

Request Syntax

client.update_application(
    applicationId='string',
    clientToken='string',
    initialCapacity={
        'string': {
            'workerCount': 123,
            'workerConfiguration': {
                'cpu': 'string',
                'memory': 'string',
                'disk': 'string'
            }
        }
    },
    maximumCapacity={
        'cpu': 'string',
        'memory': 'string',
        'disk': 'string'
    },
    autoStartConfiguration={
        'enabled': True|False
    },
    autoStopConfiguration={
        'enabled': True|False,
        'idleTimeoutMinutes': 123
    },
    networkConfiguration={
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    }
)
type applicationId

string

param applicationId

[REQUIRED]

The ID of the application to update.

type clientToken

string

param clientToken

[REQUIRED]

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

This field is autopopulated if not provided.

type initialCapacity

dict

param initialCapacity

The capacity to initialize when the application is updated.

  • (string) --

    • (dict) --

      The initial capacity configuration per worker.

      • workerCount (integer) -- [REQUIRED]

        The number of workers in the initial capacity configuration.

      • workerConfiguration (dict) --

        The resource configuration of the initial capacity configuration.

        • cpu (string) -- [REQUIRED]

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

        • memory (string) -- [REQUIRED]

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

        • disk (string) --

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

type maximumCapacity

dict

param maximumCapacity

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.

  • cpu (string) -- [REQUIRED]

    The maximum allowed CPU for an application.

  • memory (string) -- [REQUIRED]

    The maximum allowed resources for an application.

  • disk (string) --

    The maximum allowed disk for an application.

type autoStartConfiguration

dict

param autoStartConfiguration

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

  • enabled (boolean) --

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

type autoStopConfiguration

dict

param autoStopConfiguration

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

  • enabled (boolean) --

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

  • idleTimeoutMinutes (integer) --

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

type networkConfiguration

dict

param networkConfiguration

The network configuration for customer VPC connectivity.

  • subnetIds (list) --

    The array of subnet Ids for customer VPC connectivity.

    • (string) --

  • securityGroupIds (list) --

    The array of security group Ids for customer VPC connectivity.

    • (string) --

rtype

dict

returns

Response Syntax

{
    'application': {
        'applicationId': 'string',
        'name': 'string',
        'arn': 'string',
        'releaseLabel': 'string',
        'type': 'string',
        'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
        'stateDetails': 'string',
        'initialCapacity': {
            'string': {
                'workerCount': 123,
                'workerConfiguration': {
                    'cpu': 'string',
                    'memory': 'string',
                    'disk': 'string'
                }
            }
        },
        'maximumCapacity': {
            'cpu': 'string',
            'memory': 'string',
            'disk': 'string'
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'autoStartConfiguration': {
            'enabled': True|False
        },
        'autoStopConfiguration': {
            'enabled': True|False,
            'idleTimeoutMinutes': 123
        },
        'networkConfiguration': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) --

    • application (dict) --

      Information about the updated application.

      • applicationId (string) --

        The ID of the application.

      • name (string) --

        The name of the application.

      • arn (string) --

        The ARN of the application.

      • releaseLabel (string) --

        The EMR release version associated with the application.

      • type (string) --

        The type of application, such as Spark or Hive.

      • state (string) --

        The state of the application.

      • stateDetails (string) --

        The state details of the application.

      • initialCapacity (dict) --

        The initial capacity of the application.

        • (string) --

          • (dict) --

            The initial capacity configuration per worker.

            • workerCount (integer) --

              The number of workers in the initial capacity configuration.

            • workerConfiguration (dict) --

              The resource configuration of the initial capacity configuration.

              • cpu (string) --

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

              • memory (string) --

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

              • disk (string) --

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

      • maximumCapacity (dict) --

        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.

        • cpu (string) --

          The maximum allowed CPU for an application.

        • memory (string) --

          The maximum allowed resources for an application.

        • disk (string) --

          The maximum allowed disk for an application.

      • createdAt (datetime) --

        The date and time when the application run was created.

      • updatedAt (datetime) --

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

      • tags (dict) --

        The tags assigned to the application.

        • (string) --

          • (string) --

      • autoStartConfiguration (dict) --

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

        • enabled (boolean) --

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

      • autoStopConfiguration (dict) --

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

        • enabled (boolean) --

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

        • idleTimeoutMinutes (integer) --

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

      • networkConfiguration (dict) --

        The network configuration for customer VPC connectivity for the application.

        • subnetIds (list) --

          The array of subnet Ids for customer VPC connectivity.

          • (string) --

        • securityGroupIds (list) --

          The array of security group Ids for customer VPC connectivity.

          • (string) --

CreateApplication (new) Link ¶

Creates an application.

See also: AWS API Documentation

Request Syntax

client.create_application(
    name='string',
    releaseLabel='string',
    type='string',
    clientToken='string',
    initialCapacity={
        'string': {
            'workerCount': 123,
            'workerConfiguration': {
                'cpu': 'string',
                'memory': 'string',
                'disk': 'string'
            }
        }
    },
    maximumCapacity={
        'cpu': 'string',
        'memory': 'string',
        'disk': 'string'
    },
    tags={
        'string': 'string'
    },
    autoStartConfiguration={
        'enabled': True|False
    },
    autoStopConfiguration={
        'enabled': True|False,
        'idleTimeoutMinutes': 123
    },
    networkConfiguration={
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    }
)
type name

string

param name

The name of the application.

type releaseLabel

string

param releaseLabel

[REQUIRED]

The EMR release version associated with the application.

type type

string

param type

[REQUIRED]

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

type clientToken

string

param clientToken

[REQUIRED]

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

This field is autopopulated if not provided.

type initialCapacity

dict

param initialCapacity

The capacity to initialize when the application is created.

  • (string) --

    • (dict) --

      The initial capacity configuration per worker.

      • workerCount (integer) -- [REQUIRED]

        The number of workers in the initial capacity configuration.

      • workerConfiguration (dict) --

        The resource configuration of the initial capacity configuration.

        • cpu (string) -- [REQUIRED]

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

        • memory (string) -- [REQUIRED]

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

        • disk (string) --

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

type maximumCapacity

dict

param maximumCapacity

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.

  • cpu (string) -- [REQUIRED]

    The maximum allowed CPU for an application.

  • memory (string) -- [REQUIRED]

    The maximum allowed resources for an application.

  • disk (string) --

    The maximum allowed disk for an application.

type tags

dict

param tags

The tags assigned to the application.

  • (string) --

    • (string) --

type autoStartConfiguration

dict

param autoStartConfiguration

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

  • enabled (boolean) --

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

type autoStopConfiguration

dict

param autoStopConfiguration

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

  • enabled (boolean) --

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

  • idleTimeoutMinutes (integer) --

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

type networkConfiguration

dict

param networkConfiguration

The network configuration for customer VPC connectivity.

  • subnetIds (list) --

    The array of subnet Ids for customer VPC connectivity.

    • (string) --

  • securityGroupIds (list) --

    The array of security group Ids for customer VPC connectivity.

    • (string) --

rtype

dict

returns

Response Syntax

{
    'applicationId': 'string',
    'name': 'string',
    'arn': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

      The output contains the application ID.

    • name (string) --

      The output contains the name of the application.

    • arn (string) --

      The output contains the ARN of the application.

ListTagsForResource (new) Link ¶

Lists the tags assigned to the resources.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

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.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      The tags for the resource.

      • (string) --

        • (string) --

UntagResource (new) Link ¶

Removes tags from resources.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

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.

type tagKeys

list

param tagKeys

[REQUIRED]

The keys of the tags to be removed.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListJobRuns (new) Link ¶

Lists job runs based on a set of parameters.

See also: AWS API Documentation

Request Syntax

client.list_job_runs(
    applicationId='string',
    nextToken='string',
    maxResults=123,
    createdAtAfter=datetime(2015, 1, 1),
    createdAtBefore=datetime(2015, 1, 1),
    states=[
        'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
    ]
)
type applicationId

string

param applicationId

[REQUIRED]

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

type nextToken

string

param nextToken

The token for the next set of job run results.

type maxResults

integer

param maxResults

The maximum number of job runs that can be listed.

type createdAtAfter

datetime

param createdAtAfter

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

type createdAtBefore

datetime

param createdAtBefore

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

type states

list

param states

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

  • (string) --

rtype

dict

returns

Response Syntax

{
    'jobRuns': [
        {
            'applicationId': 'string',
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'executionRole': 'string',
            'state': 'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
            'stateDetails': 'string',
            'releaseLabel': 'string',
            'type': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • jobRuns (list) --

      The output lists information about the specified job runs.

      • (dict) --

        The summary of attributes associated with a job run.

        • applicationId (string) --

          The ID of the application the job is running on.

        • id (string) --

          The ID of the job run.

        • name (string) --

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

        • arn (string) --

          The ARN of the job run.

        • createdBy (string) --

          The user who created the job run.

        • createdAt (datetime) --

          The date and time when the job run was created.

        • updatedAt (datetime) --

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

        • executionRole (string) --

          The execution role ARN of the job run.

        • state (string) --

          The state of the job run.

        • stateDetails (string) --

          The state details of the job run.

        • releaseLabel (string) --

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

        • type (string) --

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

    • nextToken (string) --

      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.

GetApplication (new) Link ¶

Displays detailed information about a specified application.

See also: AWS API Documentation

Request Syntax

client.get_application(
    applicationId='string'
)
type applicationId

string

param applicationId

[REQUIRED]

The ID of the application that will be described.

rtype

dict

returns

Response Syntax

{
    'application': {
        'applicationId': 'string',
        'name': 'string',
        'arn': 'string',
        'releaseLabel': 'string',
        'type': 'string',
        'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
        'stateDetails': 'string',
        'initialCapacity': {
            'string': {
                'workerCount': 123,
                'workerConfiguration': {
                    'cpu': 'string',
                    'memory': 'string',
                    'disk': 'string'
                }
            }
        },
        'maximumCapacity': {
            'cpu': 'string',
            'memory': 'string',
            'disk': 'string'
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'autoStartConfiguration': {
            'enabled': True|False
        },
        'autoStopConfiguration': {
            'enabled': True|False,
            'idleTimeoutMinutes': 123
        },
        'networkConfiguration': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) --

    • application (dict) --

      The output displays information about the specified application.

      • applicationId (string) --

        The ID of the application.

      • name (string) --

        The name of the application.

      • arn (string) --

        The ARN of the application.

      • releaseLabel (string) --

        The EMR release version associated with the application.

      • type (string) --

        The type of application, such as Spark or Hive.

      • state (string) --

        The state of the application.

      • stateDetails (string) --

        The state details of the application.

      • initialCapacity (dict) --

        The initial capacity of the application.

        • (string) --

          • (dict) --

            The initial capacity configuration per worker.

            • workerCount (integer) --

              The number of workers in the initial capacity configuration.

            • workerConfiguration (dict) --

              The resource configuration of the initial capacity configuration.

              • cpu (string) --

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

              • memory (string) --

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

              • disk (string) --

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

      • maximumCapacity (dict) --

        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.

        • cpu (string) --

          The maximum allowed CPU for an application.

        • memory (string) --

          The maximum allowed resources for an application.

        • disk (string) --

          The maximum allowed disk for an application.

      • createdAt (datetime) --

        The date and time when the application run was created.

      • updatedAt (datetime) --

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

      • tags (dict) --

        The tags assigned to the application.

        • (string) --

          • (string) --

      • autoStartConfiguration (dict) --

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

        • enabled (boolean) --

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

      • autoStopConfiguration (dict) --

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

        • enabled (boolean) --

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

        • idleTimeoutMinutes (integer) --

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

      • networkConfiguration (dict) --

        The network configuration for customer VPC connectivity for the application.

        • subnetIds (list) --

          The array of subnet Ids for customer VPC connectivity.

          • (string) --

        • securityGroupIds (list) --

          The array of security group Ids for customer VPC connectivity.

          • (string) --