Skip to content

EMRServerlessClient#

Index > EMRServerless > EMRServerlessClient

Auto-generated documentation for EMRServerless type annotations stubs module types-boto3-emr-serverless.

EMRServerlessClient#

Type annotations and code completion for boto3.client("emr-serverless"). boto3 documentation

# EMRServerlessClient usage example

from boto3.session import Session
from types_boto3_emr_serverless.client import EMRServerlessClient

def get_emr-serverless_client() -> EMRServerlessClient:
    return Session().client("emr-serverless")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("emr-serverless").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("emr-serverless")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_emr_serverless.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("emr-serverless").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("emr-serverless").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_job_run#

Cancels a job run.

Type annotations and code completion for boto3.client("emr-serverless").cancel_job_run method. boto3 documentation

# cancel_job_run method definition

def cancel_job_run(
    self,
    *,
    applicationId: str,
    jobRunId: str,
) -> CancelJobRunResponseTypeDef:  # (1)
    ...
  1. See CancelJobRunResponseTypeDef
# cancel_job_run method usage example with argument unpacking

kwargs: CancelJobRunRequestTypeDef = {  # (1)
    "applicationId": ...,
    "jobRunId": ...,
}

parent.cancel_job_run(**kwargs)
  1. See CancelJobRunRequestTypeDef

create_application#

Creates an application.

Type annotations and code completion for boto3.client("emr-serverless").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    releaseLabel: str,
    type: str,
    clientToken: str,
    name: str = ...,
    initialCapacity: Mapping[str, InitialCapacityConfigTypeDef] = ...,  # (1)
    maximumCapacity: MaximumAllowedResourcesTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    autoStartConfiguration: AutoStartConfigTypeDef = ...,  # (3)
    autoStopConfiguration: AutoStopConfigTypeDef = ...,  # (4)
    networkConfiguration: NetworkConfigurationUnionTypeDef = ...,  # (5)
    architecture: ArchitectureType = ...,  # (6)
    imageConfiguration: ImageConfigurationInputTypeDef = ...,  # (7)
    workerTypeSpecifications: Mapping[str, WorkerTypeSpecificationInputTypeDef] = ...,  # (8)
    runtimeConfiguration: Sequence[ConfigurationUnionTypeDef] = ...,  # (9)
    monitoringConfiguration: MonitoringConfigurationUnionTypeDef = ...,  # (10)
    interactiveConfiguration: InteractiveConfigurationTypeDef = ...,  # (11)
    schedulerConfiguration: SchedulerConfigurationTypeDef = ...,  # (12)
) -> CreateApplicationResponseTypeDef:  # (13)
    ...
  1. See Mapping[str, InitialCapacityConfigTypeDef]
  2. See MaximumAllowedResourcesTypeDef
  3. See AutoStartConfigTypeDef
  4. See AutoStopConfigTypeDef
  5. See NetworkConfigurationUnionTypeDef
  6. See ArchitectureType
  7. See ImageConfigurationInputTypeDef
  8. See Mapping[str, WorkerTypeSpecificationInputTypeDef]
  9. See Sequence[ConfigurationUnionTypeDef]
  10. See MonitoringConfigurationUnionTypeDef
  11. See InteractiveConfigurationTypeDef
  12. See SchedulerConfigurationTypeDef
  13. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestTypeDef = {  # (1)
    "releaseLabel": ...,
    "type": ...,
    "clientToken": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestTypeDef

delete_application#

Deletes an application.

Type annotations and code completion for boto3.client("emr-serverless").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestTypeDef

get_application#

Displays detailed information about a specified application.

Type annotations and code completion for boto3.client("emr-serverless").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    applicationId: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef
# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestTypeDef

get_dashboard_for_job_run#

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

Type annotations and code completion for boto3.client("emr-serverless").get_dashboard_for_job_run method. boto3 documentation

# get_dashboard_for_job_run method definition

def get_dashboard_for_job_run(
    self,
    *,
    applicationId: str,
    jobRunId: str,
    attempt: int = ...,
    accessSystemProfileLogs: bool = ...,
) -> GetDashboardForJobRunResponseTypeDef:  # (1)
    ...
  1. See GetDashboardForJobRunResponseTypeDef
# get_dashboard_for_job_run method usage example with argument unpacking

kwargs: GetDashboardForJobRunRequestTypeDef = {  # (1)
    "applicationId": ...,
    "jobRunId": ...,
}

parent.get_dashboard_for_job_run(**kwargs)
  1. See GetDashboardForJobRunRequestTypeDef

get_job_run#

Displays detailed information about a job run.

Type annotations and code completion for boto3.client("emr-serverless").get_job_run method. boto3 documentation

# get_job_run method definition

def get_job_run(
    self,
    *,
    applicationId: str,
    jobRunId: str,
    attempt: int = ...,
) -> GetJobRunResponseTypeDef:  # (1)
    ...
  1. See GetJobRunResponseTypeDef
# get_job_run method usage example with argument unpacking

kwargs: GetJobRunRequestTypeDef = {  # (1)
    "applicationId": ...,
    "jobRunId": ...,
}

parent.get_job_run(**kwargs)
  1. See GetJobRunRequestTypeDef

list_applications#

Lists applications based on a set of parameters.

Type annotations and code completion for boto3.client("emr-serverless").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    states: Sequence[ApplicationStateType] = ...,  # (1)
) -> ListApplicationsResponseTypeDef:  # (2)
    ...
  1. See Sequence[ApplicationStateType]
  2. See ListApplicationsResponseTypeDef
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestTypeDef

list_job_run_attempts#

Lists all attempt of a job run.

Type annotations and code completion for boto3.client("emr-serverless").list_job_run_attempts method. boto3 documentation

# list_job_run_attempts method definition

def list_job_run_attempts(
    self,
    *,
    applicationId: str,
    jobRunId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListJobRunAttemptsResponseTypeDef:  # (1)
    ...
  1. See ListJobRunAttemptsResponseTypeDef
# list_job_run_attempts method usage example with argument unpacking

kwargs: ListJobRunAttemptsRequestTypeDef = {  # (1)
    "applicationId": ...,
    "jobRunId": ...,
}

parent.list_job_run_attempts(**kwargs)
  1. See ListJobRunAttemptsRequestTypeDef

list_job_runs#

Lists job runs based on a set of parameters.

Type annotations and code completion for boto3.client("emr-serverless").list_job_runs method. boto3 documentation

# list_job_runs method definition

def list_job_runs(
    self,
    *,
    applicationId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    createdAtAfter: TimestampTypeDef = ...,
    createdAtBefore: TimestampTypeDef = ...,
    states: Sequence[JobRunStateType] = ...,  # (1)
    mode: JobRunModeType = ...,  # (2)
) -> ListJobRunsResponseTypeDef:  # (3)
    ...
  1. See Sequence[JobRunStateType]
  2. See JobRunModeType
  3. See ListJobRunsResponseTypeDef
# list_job_runs method usage example with argument unpacking

kwargs: ListJobRunsRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_job_runs(**kwargs)
  1. See ListJobRunsRequestTypeDef

list_tags_for_resource#

Lists the tags assigned to the resources.

Type annotations and code completion for boto3.client("emr-serverless").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

start_application#

Starts a specified application and initializes initial capacity if configured.

Type annotations and code completion for boto3.client("emr-serverless").start_application method. boto3 documentation

# start_application method definition

def start_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
# start_application method usage example with argument unpacking

kwargs: StartApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.start_application(**kwargs)
  1. See StartApplicationRequestTypeDef

start_job_run#

Starts a job run.

Type annotations and code completion for boto3.client("emr-serverless").start_job_run method. boto3 documentation

# start_job_run method definition

def start_job_run(
    self,
    *,
    applicationId: str,
    clientToken: str,
    executionRoleArn: str,
    jobDriver: JobDriverUnionTypeDef = ...,  # (1)
    configurationOverrides: ConfigurationOverridesUnionTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    executionTimeoutMinutes: int = ...,
    name: str = ...,
    mode: JobRunModeType = ...,  # (3)
    retryPolicy: RetryPolicyTypeDef = ...,  # (4)
) -> StartJobRunResponseTypeDef:  # (5)
    ...
  1. See JobDriverUnionTypeDef
  2. See ConfigurationOverridesUnionTypeDef
  3. See JobRunModeType
  4. See RetryPolicyTypeDef
  5. See StartJobRunResponseTypeDef
# start_job_run method usage example with argument unpacking

kwargs: StartJobRunRequestTypeDef = {  # (1)
    "applicationId": ...,
    "clientToken": ...,
    "executionRoleArn": ...,
}

parent.start_job_run(**kwargs)
  1. See StartJobRunRequestTypeDef

stop_application#

Stops a specified application and releases initial capacity if configured.

Type annotations and code completion for boto3.client("emr-serverless").stop_application method. boto3 documentation

# stop_application method definition

def stop_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...
# stop_application method usage example with argument unpacking

kwargs: StopApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.stop_application(**kwargs)
  1. See StopApplicationRequestTypeDef

tag_resource#

Assigns tags to resources.

Type annotations and code completion for boto3.client("emr-serverless").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from resources.

Type annotations and code completion for boto3.client("emr-serverless").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_application#

Updates a specified application.

Type annotations and code completion for boto3.client("emr-serverless").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    applicationId: str,
    clientToken: str,
    initialCapacity: Mapping[str, InitialCapacityConfigTypeDef] = ...,  # (1)
    maximumCapacity: MaximumAllowedResourcesTypeDef = ...,  # (2)
    autoStartConfiguration: AutoStartConfigTypeDef = ...,  # (3)
    autoStopConfiguration: AutoStopConfigTypeDef = ...,  # (4)
    networkConfiguration: NetworkConfigurationUnionTypeDef = ...,  # (5)
    architecture: ArchitectureType = ...,  # (6)
    imageConfiguration: ImageConfigurationInputTypeDef = ...,  # (7)
    workerTypeSpecifications: Mapping[str, WorkerTypeSpecificationInputTypeDef] = ...,  # (8)
    interactiveConfiguration: InteractiveConfigurationTypeDef = ...,  # (9)
    releaseLabel: str = ...,
    runtimeConfiguration: Sequence[ConfigurationUnionTypeDef] = ...,  # (10)
    monitoringConfiguration: MonitoringConfigurationUnionTypeDef = ...,  # (11)
    schedulerConfiguration: SchedulerConfigurationTypeDef = ...,  # (12)
) -> UpdateApplicationResponseTypeDef:  # (13)
    ...
  1. See Mapping[str, InitialCapacityConfigTypeDef]
  2. See MaximumAllowedResourcesTypeDef
  3. See AutoStartConfigTypeDef
  4. See AutoStopConfigTypeDef
  5. See NetworkConfigurationUnionTypeDef
  6. See ArchitectureType
  7. See ImageConfigurationInputTypeDef
  8. See Mapping[str, WorkerTypeSpecificationInputTypeDef]
  9. See InteractiveConfigurationTypeDef
  10. See Sequence[ConfigurationUnionTypeDef]
  11. See MonitoringConfigurationUnionTypeDef
  12. See SchedulerConfigurationTypeDef
  13. See UpdateApplicationResponseTypeDef
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
    "clientToken": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("emr-serverless").get_paginator method with overloads.