CancelJobRun

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

Cancels a job run.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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>',
                'diskType' => '<string>',
                'memory' => '<string>', // REQUIRED
            ],
            'workerCount' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'interactiveConfiguration' => [
        'livyEndpointEnabled' => true || false,
        'studioEnabled' => true || false,
    ],
    '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>',
        ],
        'prometheusMonitoringConfiguration' => [
            'remoteWriteUrl' => '<string>',
        ],
        's3MonitoringConfiguration' => [
            'encryptionKeyArn' => '<string>',
            'logUri' => '<string>',
        ],
    ],
    'name' => '<string>',
    'networkConfiguration' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'releaseLabel' => '<string>', // REQUIRED
    'runtimeConfiguration' => [
        [
            'classification' => '<string>', // REQUIRED
            'configurations' => [...], // RECURSIVE
            'properties' => ['<string>', ...],
        ],
        // ...
    ],
    'schedulerConfiguration' => [
        'maxConcurrentRuns' => <integer>,
        'queueTimeoutMinutes' => <integer>,
    ],
    'tags' => ['<string>', ...],
    'type' => '<string>', // REQUIRED
    'workerTypeSpecifications' => [
        '<WorkerTypeString>' => [
            'imageConfiguration' => [
                'imageUri' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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>',
                    'diskType' => '<string>',
                    'memory' => '<string>',
                ],
                'workerCount' => <integer>,
            ],
            // ...
        ],
        'interactiveConfiguration' => [
            'livyEndpointEnabled' => true || false,
            'studioEnabled' => true || false,
        ],
        '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>',
            ],
            'prometheusMonitoringConfiguration' => [
                'remoteWriteUrl' => '<string>',
            ],
            's3MonitoringConfiguration' => [
                'encryptionKeyArn' => '<string>',
                'logUri' => '<string>',
            ],
        ],
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'releaseLabel' => '<string>',
        'runtimeConfiguration' => [
            [
                'classification' => '<string>',
                'configurations' => [...], // RECURSIVE
                'properties' => ['<string>', ...],
            ],
            // ...
        ],
        'schedulerConfiguration' => [
            'maxConcurrentRuns' => <integer>,
            'queueTimeoutMinutes' => <integer>,
        ],
        '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

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.

Parameter Syntax

$result = $client->getDashboardForJobRun([
    'accessSystemProfileLogs' => true || false,
    'applicationId' => '<string>', // REQUIRED
    'attempt' => <integer>,
    'jobRunId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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
    'attempt' => <integer>,
    'jobRunId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobRun' => [
        'applicationId' => '<string>',
        'arn' => '<string>',
        'attempt' => <integer>,
        'attemptCreatedAt' => <DateTime>,
        'attemptUpdatedAt' => <DateTime>,
        '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>',
                ],
                'prometheusMonitoringConfiguration' => [
                    'remoteWriteUrl' => '<string>',
                ],
                's3MonitoringConfiguration' => [
                    'encryptionKeyArn' => '<string>',
                    'logUri' => '<string>',
                ],
            ],
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'endedAt' => <DateTime>,
        'executionRole' => '<string>',
        'executionTimeoutMinutes' => <integer>,
        'jobDriver' => [
            'hive' => [
                'initQueryFile' => '<string>',
                'parameters' => '<string>',
                'query' => '<string>',
            ],
            'sparkSubmit' => [
                'entryPoint' => '<string>',
                'entryPointArguments' => ['<string>', ...],
                'sparkSubmitParameters' => '<string>',
            ],
        ],
        'jobRunId' => '<string>',
        'mode' => 'BATCH|STREAMING',
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'queuedDurationMilliseconds' => <integer>,
        'releaseLabel' => '<string>',
        'retryPolicy' => [
            'maxAttempts' => <integer>,
            'maxFailedAttemptsPerHour' => <integer>,
        ],
        'startedAt' => <DateTime>,
        'state' => 'SUBMITTED|PENDING|SCHEDULED|RUNNING|SUCCESS|FAILED|CANCELLING|CANCELLED|QUEUED',
        'stateDetails' => '<string>',
        'tags' => ['<string>', ...],
        'totalExecutionDurationSeconds' => <integer>,
        'totalResourceUtilization' => [
            'memoryGBHour' => <float>,
            'storageGBHour' => <float>,
            'vCPUHour' => <float>,
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

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

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

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.

ListJobRunAttempts

$result = $client->listJobRunAttempts([/* ... */]);
$promise = $client->listJobRunAttemptsAsync([/* ... */]);

Lists all attempt of a job run.

Parameter Syntax

$result = $client->listJobRunAttempts([
    'applicationId' => '<string>', // REQUIRED
    'jobRunId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'jobRunAttempts' => [
        [
            'applicationId' => '<string>',
            'arn' => '<string>',
            'attempt' => <integer>,
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'executionRole' => '<string>',
            'id' => '<string>',
            'jobCreatedAt' => <DateTime>,
            'mode' => 'BATCH|STREAMING',
            'name' => '<string>',
            'releaseLabel' => '<string>',
            'state' => 'SUBMITTED|PENDING|SCHEDULED|RUNNING|SUCCESS|FAILED|CANCELLING|CANCELLED|QUEUED',
            'stateDetails' => '<string>',
            'type' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

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.

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>,
    'mode' => 'BATCH|STREAMING',
    'nextToken' => '<string>',
    'states' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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>',
            ],
            'prometheusMonitoringConfiguration' => [
                'remoteWriteUrl' => '<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>',
        ],
    ],
    'mode' => 'BATCH|STREAMING',
    'name' => '<string>',
    'retryPolicy' => [
        'maxAttempts' => <integer>,
        'maxFailedAttemptsPerHour' => <integer>,
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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>',
                'diskType' => '<string>',
                'memory' => '<string>', // REQUIRED
            ],
            'workerCount' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'interactiveConfiguration' => [
        'livyEndpointEnabled' => true || false,
        'studioEnabled' => true || false,
    ],
    '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>',
        ],
        'prometheusMonitoringConfiguration' => [
            'remoteWriteUrl' => '<string>',
        ],
        's3MonitoringConfiguration' => [
            'encryptionKeyArn' => '<string>',
            'logUri' => '<string>',
        ],
    ],
    'networkConfiguration' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
    'releaseLabel' => '<string>',
    'runtimeConfiguration' => [
        [
            'classification' => '<string>', // REQUIRED
            'configurations' => [...], // RECURSIVE
            'properties' => ['<string>', ...],
        ],
        // ...
    ],
    'schedulerConfiguration' => [
        'maxConcurrentRuns' => <integer>,
        'queueTimeoutMinutes' => <integer>,
    ],
    'workerTypeSpecifications' => [
        '<WorkerTypeString>' => [
            'imageConfiguration' => [
                'imageUri' => '<string>',
            ],
        ],
        // ...
    ],
]);

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>',
                    'diskType' => '<string>',
                    'memory' => '<string>',
                ],
                'workerCount' => <integer>,
            ],
            // ...
        ],
        'interactiveConfiguration' => [
            'livyEndpointEnabled' => true || false,
            'studioEnabled' => true || false,
        ],
        '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>',
            ],
            'prometheusMonitoringConfiguration' => [
                'remoteWriteUrl' => '<string>',
            ],
            's3MonitoringConfiguration' => [
                'encryptionKeyArn' => '<string>',
                'logUri' => '<string>',
            ],
        ],
        'name' => '<string>',
        'networkConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'releaseLabel' => '<string>',
        'runtimeConfiguration' => [
            [
                'classification' => '<string>',
                'configurations' => [...], // RECURSIVE
                'properties' => ['<string>', ...],
            ],
            // ...
        ],
        'schedulerConfiguration' => [
            'maxConcurrentRuns' => <integer>,
            'queueTimeoutMinutes' => <integer>,
        ],
        '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

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.