EMR Serverless 2021-07-13
- 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 = [] )
Returns a URL to access the job run dashboard.
- 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:
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
Result Syntax
[
'applicationId' => '<string>',
'jobRunId' => '<string>',
]
Result Details
Members
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
],
'name' => '<string>',
'networkConfiguration' => [
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...],
],
'releaseLabel' => '<string>', // REQUIRED
'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
imageConfigurationfor each worker type inworkerTypeSpecifications. - 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.
- 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 EMR release associated with 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 includeDriverandExecutorfor Spark applications andHiveDriverandTezTaskfor Hive applications. You can either set image details in this parameter for each worker type, or inimageConfigurationfor all worker types.
Result Syntax
[
'applicationId' => '<string>',
'arn' => '<string>',
'name' => '<string>',
]
Result Details
Members
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
Request processing failed because of an error or failure with the service.
-
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
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
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>',
],
'name' => '<string>',
'networkConfiguration' => [
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...],
],
'releaseLabel' => '<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
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
Request processing failed because of an error or failure with the service.
GetDashboardForJobRun
$result = $client->getDashboardForJobRun([/* ... */]); $promise = $client->getDashboardForJobRunAsync([/* ... */]);
Returns a URL to access the job run dashboard.
Parameter Syntax
$result = $client->getDashboardForJobRun([
'applicationId' => '<string>', // REQUIRED
'jobRunId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'url' => '<string>',
]
Result Details
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
Result Syntax
[
'jobRun' => [
'applicationId' => '<string>',
'arn' => '<string>',
'configurationOverrides' => [
'applicationConfiguration' => [
[
'classification' => '<string>',
'configurations' => [...], // RECURSIVE
'properties' => ['<string>', ...],
],
// ...
],
'monitoringConfiguration' => [
'managedPersistenceMonitoringConfiguration' => [
'enabled' => true || false,
'encryptionKeyArn' => '<string>',
],
's3MonitoringConfiguration' => [
'encryptionKeyArn' => '<string>',
'logUri' => '<string>',
],
],
],
'createdAt' => <DateTime>,
'createdBy' => '<string>',
'executionRole' => '<string>',
'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
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
-
The input fails to satisfy the constraints specified by an AWS service.
-
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
-
The input fails to satisfy the constraints specified by an AWS service.
-
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
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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' => [
'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
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
Request processing failed because of an error or failure with the service.
-
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
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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 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.
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
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
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
],
'networkConfiguration' => [
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<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
imageConfigurationfor each worker type inWorkerTypeSpecificationInput. - 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.
- networkConfiguration
-
- Type: NetworkConfiguration structure
The network configuration for customer VPC connectivity.
- 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 includeDriverandExecutorfor Spark applications andHiveDriverandTezTaskfor Hive applications. You can either set image details in this parameter for each worker type, or inimageConfigurationfor all worker types.
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>',
],
'name' => '<string>',
'networkConfiguration' => [
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...],
],
'releaseLabel' => '<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
-
The input fails to satisfy the constraints specified by an AWS service.
-
The specified resource was not found.
-
Request processing failed because of an error or failure with the service.
Shapes
Application
Description
Information about an application. 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.
- 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 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.
- 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 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
AutoStopConfig
Description
The configuration for an application to automatically stop after a certain amount of time being idle.
Members
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
Hive
Description
The configurations for the Hive job driver.
Members
ImageConfiguration
Description
The applied image configuration.
Members
ImageConfigurationInput
Description
The image configuration.
Members
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
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 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.
- 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.
- 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 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, orCANCELLEDstate. - totalResourceUtilization
-
- Type: TotalResourceUtilization structure
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.
- 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 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
MaximumAllowedResources
Description
The maximum allowed cumulative resources for an application. No new resources will be created once the limit is hit.
Members
MonitoringConfiguration
Description
The configuration setting for monitoring.
Members
- 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
ResourceNotFoundException
S3MonitoringConfiguration
Description
The Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.
Members
ServiceQuotaExceededException
Description
The maximum number of resources per account has been reached.
Members
SparkSubmit
Description
The configurations for the Spark submit job driver.
Members
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 AWS service.
Members
WorkerResourceConfig
Description
The cumulative configuration requirements for every worker instance of the worker type.
Members
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.