AWS SDK for PHP 3.x

Client: Aws\EMRServerless\EMRServerlessClient

Service ID: emr-serverless

Version: 2021-07-13

This page describes the parameters and results for the operations of the EMR Serverless (2021-07-13), and shows how to use the Aws\EMRServerless\EMRServerlessClient object to call the described operations. This documentation is specific to the 2021-07-13 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelJobRun ( array $params = [] )
Cancels a job run.
CreateApplication ( array $params = [] )
Creates an application.
DeleteApplication ( array $params = [] )
Deletes an application.
GetApplication ( array $params = [] )
Displays detailed information about a specified application.
GetDashboardForJobRun ( array $params = [] )
Creates and returns a URL that you can use to access the application UIs for a job run.
GetJobRun ( array $params = [] )
Displays detailed information about a job run.
ListApplications ( array $params = [] )
Lists applications based on a set of parameters.
ListJobRuns ( array $params = [] )
Lists job runs based on a set of parameters.
ListTagsForResource ( array $params = [] )
Lists the tags assigned to the resources.
StartApplication ( array $params = [] )
Starts a specified application and initializes initial capacity if configured.
StartJobRun ( array $params = [] )
Starts a job run.
StopApplication ( array $params = [] )
Stops a specified application and releases initial capacity if configured.
TagResource ( array $params = [] )
Assigns tags to resources.
UntagResource ( array $params = [] )
Removes tags from resources.
UpdateApplication ( array $params = [] )
Updates a specified application.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplications
ListJobRuns

Operations

CancelJobRun

$result = $client->cancelJobRun([/* ... */]);
$promise = $client->cancelJobRunAsync([/* ... */]);

Cancels a job run.

Parameter Syntax

$result = $client->cancelJobRun([
    'applicationId' => '<string>', // REQUIRED
    'jobRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

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

jobRunId

Required: Yes
Type: string

The ID of the job run to cancel.

Result Syntax

[
    'applicationId' => '<string>',
    'jobRunId' => '<string>',
]

Result Details

Members

applicationId

Required: Yes
Type: string

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

jobRunId

Required: Yes
Type: string

The output contains the ID of the cancelled job run.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an application.

Parameter Syntax

$result = $client->createApplication([
    'architecture' => 'ARM64|X86_64',
    'autoStartConfiguration' => [
        'enabled' => true || false,
    ],
    'autoStopConfiguration' => [
        'enabled' => true || false,
        'idleTimeoutMinutes' => <integer>,
    ],
    'clientToken' => '<string>', // REQUIRED
    'imageConfiguration' => [
        'imageUri' => '<string>',
    ],
    'initialCapacity' => [
        '<WorkerTypeString>' => [
            'workerConfiguration' => [
                'cpu' => '<string>', // REQUIRED
                'disk' => '<string>',
                'memory' => '<string>', // REQUIRED
            ],
            'workerCount' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'maximumCapacity' => [
        'cpu' => '<string>', // REQUIRED
        'disk' => '<string>',
        'memory' => '<string>', // REQUIRED
    ],
    'monitoringConfiguration' => [
        'cloudWatchLoggingConfiguration' => [
            'enabled' => true || false, // REQUIRED
            'encryptionKeyArn' => '<string>',
            'logGroupName' => '<string>',
            'logStreamNamePrefix' => '<string>',
            'logTypes' => [
                '<WorkerTypeString>' => ['<string>', ...],
                // ...
            ],
        ],
        'managedPersistenceMonitoringConfiguration' => [
            'enabled' => true || false,
            'encryptionKeyArn' => '<string>',
        ],
        's3MonitoringConfiguration' => [
            'encryptionKeyArn' => '<string>',
            'logUri' => '<string>',
        ],
    ],
    'name' => '<string>',
    'networkConfiguration' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'releaseLabel' => '<string>', // REQUIRED
    'runtimeConfiguration' => [
        [
            'classification' => '<string>', // REQUIRED
            'configurations' => [...], // RECURSIVE
            'properties' => ['<string>', ...],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'type' => '<string>', // REQUIRED
    'workerTypeSpecifications' => [
        '<WorkerTypeString>' => [
            'imageConfiguration' => [
                'imageUri' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

architecture

Type: string

The CPU architecture of an application.

autoStartConfiguration

Type: AutoStartConfig structure

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

autoStopConfiguration

Type: AutoStopConfig structure

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

clientToken

Required: Yes
Type: string

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

imageConfiguration

Type: ImageConfigurationInput structure

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

initialCapacity

Type: Associative array of custom strings keys (WorkerTypeString) to InitialCapacityConfig structures

The capacity to initialize when the application is created.

maximumCapacity

Type: MaximumAllowedResources structure

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.

monitoringConfiguration

Type: MonitoringConfiguration structure

The configuration setting for monitoring.

name

Type: string

The name of the application.

networkConfiguration

Type: NetworkConfiguration structure

The network configuration for customer VPC connectivity.

releaseLabel

Required: Yes
Type: string

The Amazon EMR release associated with the application.

runtimeConfiguration

Type: Array of Configuration structures

The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under the application.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags assigned to the application.

type

Required: Yes
Type: string

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

workerTypeSpecifications

Type: Associative array of custom strings keys (WorkerTypeString) to WorkerTypeSpecificationInput structures

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.

Result Syntax

[
    'applicationId' => '<string>',
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members

applicationId

Required: Yes
Type: string

The output contains the application ID.

arn

Required: Yes
Type: string

The output contains the ARN of the application.

name

Type: string

The output contains the name of the application.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application that will be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Displays detailed information about a specified application.

Parameter Syntax

$result = $client->getApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application that will be described.

Result Syntax

[
    'application' => [
        'applicationId' => '<string>',
        'architecture' => 'ARM64|X86_64',
        'arn' => '<string>',
        'autoStartConfiguration' => [
            'enabled' => true || false,
        ],
        'autoStopConfiguration' => [
            'enabled' => true || false,
            'idleTimeoutMinutes' => <integer>,
        ],
        'createdAt' => <DateTime>,
        'imageConfiguration' => [
            'imageUri' => '<string>',
            'resolvedImageDigest' => '<string>',
        ],
        'initialCapacity' => [
            '<WorkerTypeString>' => [
                'workerConfiguration' => [
                    'cpu' => '<string>',
                    'disk' => '<string>',
                    'memory' => '<string>',
                ],
                'workerCount' => <integer>,
            ],
            // ...
        ],
        'maximumCapacity' => [
            'cpu' => '<string>',
            'disk' => '<string>',
            'memory' => '<string>',
        ],
        'monitoringConfiguration' => [
            'cloudWatchLoggingConfiguration' => [
                'enabled' => true || false,
                'encryptionKeyArn' => '<string>',
                'logGroupName' => '<string>',
                'logStreamNamePrefix' => '<string>',
                'logTypes' => [
                    '<WorkerTypeString>' => ['<string>', ...],
                    // ...
                ],
            ],
            'managedPersistenceMonitoringConfiguration' => [
                'enabled' => true || false,
                'encryptionKeyArn' => '<string>',
            ],
            's3MonitoringConfiguration' => [
                'encryptionKeyArn' => '<string>',
                'logUri' => '<string>',
            ],
        ],
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'releaseLabel' => '<string>',
        'runtimeConfiguration' => [
            [
                'classification' => '<string>',
                'configurations' => [...], // RECURSIVE
                'properties' => ['<string>', ...],
            ],
            // ...
        ],
        'state' => 'CREATING|CREATED|STARTING|STARTED|STOPPING|STOPPED|TERMINATED',
        'stateDetails' => '<string>',
        'tags' => ['<string>', ...],
        'type' => '<string>',
        'updatedAt' => <DateTime>,
        'workerTypeSpecifications' => [
            '<WorkerTypeString>' => [
                'imageConfiguration' => [
                    'imageUri' => '<string>',
                    'resolvedImageDigest' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

application

Required: Yes
Type: Application structure

The output displays information about the specified application.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

GetDashboardForJobRun

$result = $client->getDashboardForJobRun([/* ... */]);
$promise = $client->getDashboardForJobRunAsync([/* ... */]);

Creates and returns a URL that you can use to access the application UIs for a job run.

For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

Parameter Syntax

$result = $client->getDashboardForJobRun([
    'applicationId' => '<string>', // REQUIRED
    'jobRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application.

jobRunId

Required: Yes
Type: string

The ID of the job run.

Result Syntax

[
    'url' => '<string>',
]

Result Details

Members

url

Type: string

The URL to view job run's dashboard.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

GetJobRun

$result = $client->getJobRun([/* ... */]);
$promise = $client->getJobRunAsync([/* ... */]);

Displays detailed information about a job run.

Parameter Syntax

$result = $client->getJobRun([
    'applicationId' => '<string>', // REQUIRED
    'jobRunId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

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

jobRunId

Required: Yes
Type: string

The ID of the job run.

Result Syntax

[
    'jobRun' => [
        'applicationId' => '<string>',
        'arn' => '<string>',
        'billedResourceUtilization' => [
            'memoryGBHour' => <float>,
            'storageGBHour' => <float>,
            'vCPUHour' => <float>,
        ],
        'configurationOverrides' => [
            'applicationConfiguration' => [
                [
                    'classification' => '<string>',
                    'configurations' => [...], // RECURSIVE
                    'properties' => ['<string>', ...],
                ],
                // ...
            ],
            'monitoringConfiguration' => [
                'cloudWatchLoggingConfiguration' => [
                    'enabled' => true || false,
                    'encryptionKeyArn' => '<string>',
                    'logGroupName' => '<string>',
                    'logStreamNamePrefix' => '<string>',
                    'logTypes' => [
                        '<WorkerTypeString>' => ['<string>', ...],
                        // ...
                    ],
                ],
                'managedPersistenceMonitoringConfiguration' => [
                    'enabled' => true || false,
                    'encryptionKeyArn' => '<string>',
                ],
                's3MonitoringConfiguration' => [
                    'encryptionKeyArn' => '<string>',
                    'logUri' => '<string>',
                ],
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'executionRole' => '<string>',
        'executionTimeoutMinutes' => <integer>,
        'jobDriver' => [
            'hive' => [
                'initQueryFile' => '<string>',
                'parameters' => '<string>',
                'query' => '<string>',
            ],
            'sparkSubmit' => [
                'entryPoint' => '<string>',
                'entryPointArguments' => ['<string>', ...],
                'sparkSubmitParameters' => '<string>',
            ],
        ],
        'jobRunId' => '<string>',
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'releaseLabel' => '<string>',
        'state' => 'SUBMITTED|PENDING|SCHEDULED|RUNNING|SUCCESS|FAILED|CANCELLING|CANCELLED',
        'stateDetails' => '<string>',
        'tags' => ['<string>', ...],
        'totalExecutionDurationSeconds' => <integer>,
        'totalResourceUtilization' => [
            'memoryGBHour' => <float>,
            'storageGBHour' => <float>,
            'vCPUHour' => <float>,
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

jobRun

Required: Yes
Type: JobRun structure

The output displays information about the job run.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Lists applications based on a set of parameters.

Parameter Syntax

$result = $client->listApplications([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'states' => ['<string>', ...],
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of applications that can be listed.

nextToken

Type: string

The token for the next set of application results.

states

Type: Array of strings

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

Result Syntax

[
    'applications' => [
        [
            'architecture' => 'ARM64|X86_64',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'name' => '<string>',
            'releaseLabel' => '<string>',
            'state' => 'CREATING|CREATED|STARTING|STARTED|STOPPING|STOPPED|TERMINATED',
            'stateDetails' => '<string>',
            'type' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

applications

Required: Yes
Type: Array of ApplicationSummary structures

The output lists the specified applications.

nextToken

Type: 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.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
Request processing failed because of an error or failure with the service.

ListJobRuns

$result = $client->listJobRuns([/* ... */]);
$promise = $client->listJobRunsAsync([/* ... */]);

Lists job runs based on a set of parameters.

Parameter Syntax

$result = $client->listJobRuns([
    'applicationId' => '<string>', // REQUIRED
    'createdAtAfter' => <integer || string || DateTime>,
    'createdAtBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'states' => ['<string>', ...],
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

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

createdAtAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

createdAtBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

maxResults

Type: int

The maximum number of job runs that can be listed.

nextToken

Type: string

The token for the next set of job run results.

states

Type: Array of strings

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

Result Syntax

[
    'jobRuns' => [
        [
            'applicationId' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'executionRole' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'releaseLabel' => '<string>',
            'state' => 'SUBMITTED|PENDING|SCHEDULED|RUNNING|SUCCESS|FAILED|CANCELLING|CANCELLED',
            'stateDetails' => '<string>',
            'type' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

jobRuns

Required: Yes
Type: Array of JobRunSummary structures

The output lists information about the specified job runs.

nextToken

Type: 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.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:
Request processing failed because of an error or failure with the service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags assigned to the resources.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

StartApplication

$result = $client->startApplication([/* ... */]);
$promise = $client->startApplicationAsync([/* ... */]);

Starts a specified application and initializes initial capacity if configured.

Parameter Syntax

$result = $client->startApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application to start.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.
ServiceQuotaExceededException:
The maximum number of resources per account has been reached.

StartJobRun

$result = $client->startJobRun([/* ... */]);
$promise = $client->startJobRunAsync([/* ... */]);

Starts a job run.

Parameter Syntax

$result = $client->startJobRun([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>', // REQUIRED
    'configurationOverrides' => [
        'applicationConfiguration' => [
            [
                'classification' => '<string>', // REQUIRED
                'configurations' => [...], // RECURSIVE
                'properties' => ['<string>', ...],
            ],
            // ...
        ],
        'monitoringConfiguration' => [
            'cloudWatchLoggingConfiguration' => [
                'enabled' => true || false, // REQUIRED
                'encryptionKeyArn' => '<string>',
                'logGroupName' => '<string>',
                'logStreamNamePrefix' => '<string>',
                'logTypes' => [
                    '<WorkerTypeString>' => ['<string>', ...],
                    // ...
                ],
            ],
            'managedPersistenceMonitoringConfiguration' => [
                'enabled' => true || false,
                'encryptionKeyArn' => '<string>',
            ],
            's3MonitoringConfiguration' => [
                'encryptionKeyArn' => '<string>',
                'logUri' => '<string>',
            ],
        ],
    ],
    'executionRoleArn' => '<string>', // REQUIRED
    'executionTimeoutMinutes' => <integer>,
    'jobDriver' => [
        'hive' => [
            'initQueryFile' => '<string>',
            'parameters' => '<string>',
            'query' => '<string>', // REQUIRED
        ],
        'sparkSubmit' => [
            'entryPoint' => '<string>', // REQUIRED
            'entryPointArguments' => ['<string>', ...],
            'sparkSubmitParameters' => '<string>',
        ],
    ],
    'name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

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

clientToken

Required: Yes
Type: string

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

configurationOverrides

Type: ConfigurationOverrides structure

The configuration overrides for the job run.

executionRoleArn

Required: Yes
Type: string

The execution role ARN for the job run.

executionTimeoutMinutes

Type: long (int|float)

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

jobDriver

Type: JobDriver structure

The job driver for the job run.

name

Type: string

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags assigned to the job run.

Result Syntax

[
    'applicationId' => '<string>',
    'arn' => '<string>',
    'jobRunId' => '<string>',
]

Result Details

Members

applicationId

Required: Yes
Type: string

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

arn

Required: Yes
Type: string

This output displays the ARN of the job run..

jobRunId

Required: Yes
Type: string

The output contains the ID of the started job run.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.

StopApplication

$result = $client->stopApplication([/* ... */]);
$promise = $client->stopApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->stopApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services 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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from resources.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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.

tagKeys

Required: Yes
Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateApplication([
    'applicationId' => '<string>', // REQUIRED
    'architecture' => 'ARM64|X86_64',
    'autoStartConfiguration' => [
        'enabled' => true || false,
    ],
    'autoStopConfiguration' => [
        'enabled' => true || false,
        'idleTimeoutMinutes' => <integer>,
    ],
    'clientToken' => '<string>', // REQUIRED
    'imageConfiguration' => [
        'imageUri' => '<string>',
    ],
    'initialCapacity' => [
        '<WorkerTypeString>' => [
            'workerConfiguration' => [
                'cpu' => '<string>', // REQUIRED
                'disk' => '<string>',
                'memory' => '<string>', // REQUIRED
            ],
            'workerCount' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'maximumCapacity' => [
        'cpu' => '<string>', // REQUIRED
        'disk' => '<string>',
        'memory' => '<string>', // REQUIRED
    ],
    'monitoringConfiguration' => [
        'cloudWatchLoggingConfiguration' => [
            'enabled' => true || false, // REQUIRED
            'encryptionKeyArn' => '<string>',
            'logGroupName' => '<string>',
            'logStreamNamePrefix' => '<string>',
            'logTypes' => [
                '<WorkerTypeString>' => ['<string>', ...],
                // ...
            ],
        ],
        'managedPersistenceMonitoringConfiguration' => [
            'enabled' => true || false,
            'encryptionKeyArn' => '<string>',
        ],
        's3MonitoringConfiguration' => [
            'encryptionKeyArn' => '<string>',
            'logUri' => '<string>',
        ],
    ],
    'networkConfiguration' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'releaseLabel' => '<string>',
    'runtimeConfiguration' => [
        [
            'classification' => '<string>', // REQUIRED
            'configurations' => [...], // RECURSIVE
            'properties' => ['<string>', ...],
        ],
        // ...
    ],
    'workerTypeSpecifications' => [
        '<WorkerTypeString>' => [
            'imageConfiguration' => [
                'imageUri' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

applicationId

Required: Yes
Type: string

The ID of the application to update.

architecture

Type: string

The CPU architecture of an application.

autoStartConfiguration

Type: AutoStartConfig structure

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

autoStopConfiguration

Type: AutoStopConfig structure

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

clientToken

Required: Yes
Type: string

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

imageConfiguration

Type: ImageConfigurationInput structure

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

initialCapacity

Type: Associative array of custom strings keys (WorkerTypeString) to InitialCapacityConfig structures

The capacity to initialize when the application is updated.

maximumCapacity

Type: MaximumAllowedResources structure

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.

monitoringConfiguration

Type: MonitoringConfiguration structure

The configuration setting for monitoring.

networkConfiguration

Type: NetworkConfiguration structure

The network configuration for customer VPC connectivity.

releaseLabel

Type: string

The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.

runtimeConfiguration

Type: Array of Configuration structures

The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under the application.

workerTypeSpecifications

Type: Associative array of custom strings keys (WorkerTypeString) to WorkerTypeSpecificationInput structures

Result Syntax

[
    'application' => [
        'applicationId' => '<string>',
        'architecture' => 'ARM64|X86_64',
        'arn' => '<string>',
        'autoStartConfiguration' => [
            'enabled' => true || false,
        ],
        'autoStopConfiguration' => [
            'enabled' => true || false,
            'idleTimeoutMinutes' => <integer>,
        ],
        'createdAt' => <DateTime>,
        'imageConfiguration' => [
            'imageUri' => '<string>',
            'resolvedImageDigest' => '<string>',
        ],
        'initialCapacity' => [
            '<WorkerTypeString>' => [
                'workerConfiguration' => [
                    'cpu' => '<string>',
                    'disk' => '<string>',
                    'memory' => '<string>',
                ],
                'workerCount' => <integer>,
            ],
            // ...
        ],
        'maximumCapacity' => [
            'cpu' => '<string>',
            'disk' => '<string>',
            'memory' => '<string>',
        ],
        'monitoringConfiguration' => [
            'cloudWatchLoggingConfiguration' => [
                'enabled' => true || false,
                'encryptionKeyArn' => '<string>',
                'logGroupName' => '<string>',
                'logStreamNamePrefix' => '<string>',
                'logTypes' => [
                    '<WorkerTypeString>' => ['<string>', ...],
                    // ...
                ],
            ],
            'managedPersistenceMonitoringConfiguration' => [
                'enabled' => true || false,
                'encryptionKeyArn' => '<string>',
            ],
            's3MonitoringConfiguration' => [
                'encryptionKeyArn' => '<string>',
                'logUri' => '<string>',
            ],
        ],
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'releaseLabel' => '<string>',
        'runtimeConfiguration' => [
            [
                'classification' => '<string>',
                'configurations' => [...], // RECURSIVE
                'properties' => ['<string>', ...],
            ],
            // ...
        ],
        'state' => 'CREATING|CREATED|STARTING|STARTED|STOPPING|STOPPED|TERMINATED',
        'stateDetails' => '<string>',
        'tags' => ['<string>', ...],
        'type' => '<string>',
        'updatedAt' => <DateTime>,
        'workerTypeSpecifications' => [
            '<WorkerTypeString>' => [
                'imageConfiguration' => [
                    'imageUri' => '<string>',
                    'resolvedImageDigest' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

application

Required: Yes
Type: Application structure

Information about the updated application.

Errors

ValidationException:
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException:
The specified resource was not found.
InternalServerException:
Request processing failed because of an error or failure with the service.

Shapes

Application

Description

Information about an application. Amazon EMR Serverless uses applications to run jobs.

Members

applicationId

Required: Yes
Type: string

The ID of the application.

architecture

Type: string

The CPU architecture of an application.

arn

Required: Yes
Type: string

The ARN of the application.

autoStartConfiguration

Type: AutoStartConfig structure

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

autoStopConfiguration

Type: AutoStopConfig structure

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

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the application run was created.

imageConfiguration

Type: ImageConfiguration structure

The image configuration applied to all worker types.

initialCapacity

Type: Associative array of custom strings keys (WorkerTypeString) to InitialCapacityConfig structures

The initial capacity of the application.

maximumCapacity

Type: MaximumAllowedResources structure

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.

monitoringConfiguration

Type: MonitoringConfiguration structure

The configuration setting for monitoring.

name

Type: string

The name of the application.

networkConfiguration

Type: NetworkConfiguration structure

The network configuration for customer VPC connectivity for the application.

releaseLabel

Required: Yes
Type: string

The Amazon EMR release associated with the application.

runtimeConfiguration

Type: Array of Configuration structures

The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.

state

Required: Yes
Type: string

The state of the application.

stateDetails

Type: string

The state details of the application.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags assigned to the application.

type

Required: Yes
Type: string

The type of application, such as Spark or Hive.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

workerTypeSpecifications

Type: Associative array of custom strings keys (WorkerTypeString) to WorkerTypeSpecification structures

The specification applied to each worker type.

ApplicationSummary

Description

The summary of attributes associated with an application.

Members

architecture

Type: string

The CPU architecture of an application.

arn

Required: Yes
Type: string

The ARN of the application.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the application was created.

id

Required: Yes
Type: string

The ID of the application.

name

Type: string

The name of the application.

releaseLabel

Required: Yes
Type: string

The Amazon EMR release associated with the application.

state

Required: Yes
Type: string

The state of the application.

stateDetails

Type: string

The state details of the application.

type

Required: Yes
Type: string

The type of application, such as Spark or Hive.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the application was last updated.

AutoStartConfig

Description

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

Members

enabled

Type: boolean

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

AutoStopConfig

Description

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

Members

enabled

Type: boolean

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

idleTimeoutMinutes

Type: int

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

CloudWatchLoggingConfiguration

Description

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

Members

enabled

Required: Yes
Type: boolean

Enables CloudWatch logging.

encryptionKeyArn

Type: string

The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

logGroupName

Type: string

The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

logStreamNamePrefix

Type: string

Prefix for the CloudWatch log stream name.

logTypes

Type: Associative array of custom strings keys (WorkerTypeString) to stringss

The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK
Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

Configuration

Description

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.

Members

classification

Required: Yes
Type: string

The classification within a configuration.

configurations

Type: Array of Configuration structures

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

properties

Type: Associative array of custom strings keys (String1024) to strings

A set of properties specified within a configuration classification.

ConfigurationOverrides

Description

A configuration specification to be used to override existing configurations.

Members

applicationConfiguration

Type: Array of Configuration structures

The override configurations for the application.

monitoringConfiguration

Type: MonitoringConfiguration structure

The override configurations for monitoring.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members

message

Required: Yes
Type: string

Hive

Description

The configurations for the Hive job driver.

Members

initQueryFile

Type: string

The query file for the Hive job run.

parameters

Type: string

The parameters for the Hive job run.

query

Required: Yes
Type: string

The query for the Hive job run.

ImageConfiguration

Description

The applied image configuration.

Members

imageUri

Required: Yes
Type: string

The image URI.

resolvedImageDigest

Type: string

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

Description

The image configuration.

Members

imageUri

Type: string

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

Description

The initial capacity configuration per worker.

Members

workerConfiguration

Type: WorkerResourceConfig structure

The resource configuration of the initial capacity configuration.

workerCount

Required: Yes
Type: long (int|float)

The number of workers in the initial capacity configuration.

InternalServerException

Description

Request processing failed because of an error or failure with the service.

Members

message

Required: Yes
Type: string

JobDriver

Description

The driver that the job runs on.

Members

hive

Type: Hive structure

The job driver parameters specified for Hive.

sparkSubmit

Type: SparkSubmit structure

The job driver parameters specified for Spark.

JobRun

Description

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive query, or SparkSQL query, that you submit to an Amazon EMR Serverless application.

Members

applicationId

Required: Yes
Type: string

The ID of the application the job is running on.

arn

Required: Yes
Type: string

The execution role ARN of the job run.

billedResourceUtilization

Type: ResourceUtilization structure

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job run. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.

configurationOverrides

Type: ConfigurationOverrides structure

The configuration settings that are used to override default configuration.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the job run was created.

createdBy

Required: Yes
Type: string

The user who created the job run.

executionRole

Required: Yes
Type: string

The execution role ARN of the job run.

executionTimeoutMinutes

Type: long (int|float)

Returns the job run timeout value from the StartJobRun call. If no timeout was specified, then it returns the default timeout of 720 minutes.

jobDriver

Required: Yes
Type: JobDriver structure

The job driver for the job run.

jobRunId

Required: Yes
Type: string

The ID of the job run.

name

Type: string

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

networkConfiguration

Type: NetworkConfiguration structure

The network configuration for customer VPC connectivity.

releaseLabel

Required: Yes
Type: string

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

state

Required: Yes
Type: string

The state of the job run.

stateDetails

Required: Yes
Type: string

The state details of the job run.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags assigned to the job run.

totalExecutionDurationSeconds

Type: int

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

totalResourceUtilization

Type: TotalResourceUtilization structure

The aggregate vCPU, memory, and storage resources used from the time the job starts to execute, until the time the job terminates, rounded up to the nearest second.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the job run was updated.

JobRunSummary

Description

The summary of attributes associated with a job run.

Members

applicationId

Required: Yes
Type: string

The ID of the application the job is running on.

arn

Required: Yes
Type: string

The ARN of the job run.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the job run was created.

createdBy

Required: Yes
Type: string

The user who created the job run.

executionRole

Required: Yes
Type: string

The execution role ARN of the job run.

id

Required: Yes
Type: string

The ID of the job run.

name

Type: string

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

releaseLabel

Required: Yes
Type: string

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

state

Required: Yes
Type: string

The state of the job run.

stateDetails

Required: Yes
Type: string

The state details of the job run.

type

Type: string

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

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ManagedPersistenceMonitoringConfiguration

Description

The managed log persistence configuration for a job run.

Members

enabled

Type: boolean

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

encryptionKeyArn

Type: string

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

MaximumAllowedResources

Description

The maximum allowed cumulative resources for an application. No new resources will be created once the limit is hit.

Members

cpu

Required: Yes
Type: string

The maximum allowed CPU for an application.

disk

Type: string

The maximum allowed disk for an application.

memory

Required: Yes
Type: string

The maximum allowed resources for an application.

MonitoringConfiguration

Description

The configuration setting for monitoring.

Members

cloudWatchLoggingConfiguration

Type: CloudWatchLoggingConfiguration structure

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

managedPersistenceMonitoringConfiguration

Type: ManagedPersistenceMonitoringConfiguration structure

The managed log persistence configuration for a job run.

s3MonitoringConfiguration

Type: S3MonitoringConfiguration structure

The Amazon S3 configuration for monitoring log publishing.

NetworkConfiguration

Description

The network configuration for customer VPC connectivity.

Members

securityGroupIds

Type: Array of strings

The array of security group Ids for customer VPC connectivity.

subnetIds

Type: Array of strings

The array of subnet Ids for customer VPC connectivity.

ResourceNotFoundException

Description

The specified resource was not found.

Members

message

Required: Yes
Type: string

ResourceUtilization

Description

The resource utilization for memory, storage, and vCPU for jobs.

Members

memoryGBHour

Type: double

The aggregated memory used per hour from the time the job starts executing until the job is terminated.

storageGBHour

Type: double

The aggregated storage used per hour from the time the job starts executing until the job is terminated.

vCPUHour

Type: double

The aggregated vCPU used per hour from the time the job starts executing until the job is terminated.

S3MonitoringConfiguration

Description

The Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.

Members

encryptionKeyArn

Type: string

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

logUri

Type: string

The Amazon S3 destination URI for log publishing.

ServiceQuotaExceededException

Description

The maximum number of resources per account has been reached.

Members

message

Required: Yes
Type: string

SparkSubmit

Description

The configurations for the Spark submit job driver.

Members

entryPoint

Required: Yes
Type: string

The entry point for the Spark submit job run.

entryPointArguments

Type: Array of strings

The arguments for the Spark submit job run.

sparkSubmitParameters

Type: string

The parameters for the Spark submit job run.

TotalResourceUtilization

Description

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.

Members

memoryGBHour

Type: double

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

storageGBHour

Type: double

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

vCPUHour

Type: double

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

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members

message

Required: Yes
Type: string

WorkerResourceConfig

Description

The cumulative configuration requirements for every worker instance of the worker type.

Members

cpu

Required: Yes
Type: string

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

disk

Type: string

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

memory

Required: Yes
Type: string

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

WorkerTypeSpecification

Description

The specifications for a worker type.

Members

imageConfiguration

Type: ImageConfiguration structure

The image configuration for a worker type.

WorkerTypeSpecificationInput

Description

The specifications for a worker type.

Members

imageConfiguration

Type: ImageConfigurationInput structure

The image configuration for a worker type.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

EMR Serverless 2021-07-13

Operation Summary

Paginators

Operations

CancelJobRun

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDashboardForJobRun

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetJobRun

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListApplications

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListJobRuns

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members