Skip to content

EMRContainersClient#

Index > EMRContainers > EMRContainersClient

Auto-generated documentation for EMRContainers type annotations stubs module mypy-boto3-emr-containers.

EMRContainersClient#

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

# EMRContainersClient usage example

from boto3.session import Session
from mypy_boto3_emr_containers.client import EMRContainersClient

def get_emr-containers_client() -> EMRContainersClient:
    return Session().client("emr-containers")

Exceptions#

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

# Exceptions.exceptions usage example

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

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

from mypy_boto3_emr_containers.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

cancel_job_run#

Cancels a job run.

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

# cancel_job_run method definition

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

kwargs: CancelJobRunRequestRequestTypeDef = {  # (1)
    "id": ...,
    "virtualClusterId": ...,
}

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

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

create_job_template#

Creates a job template.

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

# create_job_template method definition

def create_job_template(
    self,
    *,
    name: str,
    clientToken: str,
    jobTemplateData: JobTemplateDataTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
    kmsKeyArn: str = ...,
) -> CreateJobTemplateResponseTypeDef:  # (2)
    ...
  1. See JobTemplateDataTypeDef
  2. See CreateJobTemplateResponseTypeDef 
# create_job_template method usage example with argument unpacking

kwargs: CreateJobTemplateRequestRequestTypeDef = {  # (1)
    "name": ...,
    "clientToken": ...,
    "jobTemplateData": ...,
}

parent.create_job_template(**kwargs)
  1. See CreateJobTemplateRequestRequestTypeDef

create_managed_endpoint#

Creates a managed endpoint.

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

# create_managed_endpoint method definition

def create_managed_endpoint(
    self,
    *,
    name: str,
    virtualClusterId: str,
    type: str,
    releaseLabel: str,
    executionRoleArn: str,
    clientToken: str,
    certificateArn: str = ...,
    configurationOverrides: ConfigurationOverridesTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateManagedEndpointResponseTypeDef:  # (2)
    ...
  1. See ConfigurationOverridesTypeDef
  2. See CreateManagedEndpointResponseTypeDef 
# create_managed_endpoint method usage example with argument unpacking

kwargs: CreateManagedEndpointRequestRequestTypeDef = {  # (1)
    "name": ...,
    "virtualClusterId": ...,
    "type": ...,
    "releaseLabel": ...,
    "executionRoleArn": ...,
    "clientToken": ...,
}

parent.create_managed_endpoint(**kwargs)
  1. See CreateManagedEndpointRequestRequestTypeDef

create_virtual_cluster#

Creates a virtual cluster.

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

# create_virtual_cluster method definition

def create_virtual_cluster(
    self,
    *,
    name: str,
    containerProvider: ContainerProviderTypeDef,  # (1)
    clientToken: str,
    tags: Mapping[str, str] = ...,
) -> CreateVirtualClusterResponseTypeDef:  # (2)
    ...
  1. See ContainerProviderTypeDef
  2. See CreateVirtualClusterResponseTypeDef 
# create_virtual_cluster method usage example with argument unpacking

kwargs: CreateVirtualClusterRequestRequestTypeDef = {  # (1)
    "name": ...,
    "containerProvider": ...,
    "clientToken": ...,
}

parent.create_virtual_cluster(**kwargs)
  1. See CreateVirtualClusterRequestRequestTypeDef

delete_job_template#

Deletes a job template.

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

# delete_job_template method definition

def delete_job_template(
    self,
    *,
    id: str,
) -> DeleteJobTemplateResponseTypeDef:  # (1)
    ...
  1. See DeleteJobTemplateResponseTypeDef 
# delete_job_template method usage example with argument unpacking

kwargs: DeleteJobTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_job_template(**kwargs)
  1. See DeleteJobTemplateRequestRequestTypeDef

delete_managed_endpoint#

Deletes a managed endpoint.

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

# delete_managed_endpoint method definition

def delete_managed_endpoint(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DeleteManagedEndpointResponseTypeDef:  # (1)
    ...
  1. See DeleteManagedEndpointResponseTypeDef 
# delete_managed_endpoint method usage example with argument unpacking

kwargs: DeleteManagedEndpointRequestRequestTypeDef = {  # (1)
    "id": ...,
    "virtualClusterId": ...,
}

parent.delete_managed_endpoint(**kwargs)
  1. See DeleteManagedEndpointRequestRequestTypeDef

delete_virtual_cluster#

Deletes a virtual cluster.

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

# delete_virtual_cluster method definition

def delete_virtual_cluster(
    self,
    *,
    id: str,
) -> DeleteVirtualClusterResponseTypeDef:  # (1)
    ...
  1. See DeleteVirtualClusterResponseTypeDef 
# delete_virtual_cluster method usage example with argument unpacking

kwargs: DeleteVirtualClusterRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_virtual_cluster(**kwargs)
  1. See DeleteVirtualClusterRequestRequestTypeDef

describe_job_run#

Displays detailed information about a job run.

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

# describe_job_run method definition

def describe_job_run(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DescribeJobRunResponseTypeDef:  # (1)
    ...
  1. See DescribeJobRunResponseTypeDef 
# describe_job_run method usage example with argument unpacking

kwargs: DescribeJobRunRequestRequestTypeDef = {  # (1)
    "id": ...,
    "virtualClusterId": ...,
}

parent.describe_job_run(**kwargs)
  1. See DescribeJobRunRequestRequestTypeDef

describe_job_template#

Displays detailed information about a specified job template.

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

# describe_job_template method definition

def describe_job_template(
    self,
    *,
    id: str,
) -> DescribeJobTemplateResponseTypeDef:  # (1)
    ...
  1. See DescribeJobTemplateResponseTypeDef 
# describe_job_template method usage example with argument unpacking

kwargs: DescribeJobTemplateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.describe_job_template(**kwargs)
  1. See DescribeJobTemplateRequestRequestTypeDef

describe_managed_endpoint#

Displays detailed information about a managed endpoint.

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

# describe_managed_endpoint method definition

def describe_managed_endpoint(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DescribeManagedEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeManagedEndpointResponseTypeDef 
# describe_managed_endpoint method usage example with argument unpacking

kwargs: DescribeManagedEndpointRequestRequestTypeDef = {  # (1)
    "id": ...,
    "virtualClusterId": ...,
}

parent.describe_managed_endpoint(**kwargs)
  1. See DescribeManagedEndpointRequestRequestTypeDef

describe_virtual_cluster#

Displays detailed information about a specified virtual cluster.

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

# describe_virtual_cluster method definition

def describe_virtual_cluster(
    self,
    *,
    id: str,
) -> DescribeVirtualClusterResponseTypeDef:  # (1)
    ...
  1. See DescribeVirtualClusterResponseTypeDef 
# describe_virtual_cluster method usage example with argument unpacking

kwargs: DescribeVirtualClusterRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.describe_virtual_cluster(**kwargs)
  1. See DescribeVirtualClusterRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("emr-containers").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:
    ...

get_managed_endpoint_session_credentials#

Generate a session token to connect to a managed endpoint.

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

# get_managed_endpoint_session_credentials method definition

def get_managed_endpoint_session_credentials(
    self,
    *,
    endpointIdentifier: str,
    virtualClusterIdentifier: str,
    executionRoleArn: str,
    credentialType: str,
    durationInSeconds: int = ...,
    logContext: str = ...,
    clientToken: str = ...,
) -> GetManagedEndpointSessionCredentialsResponseTypeDef:  # (1)
    ...
  1. See GetManagedEndpointSessionCredentialsResponseTypeDef 
# get_managed_endpoint_session_credentials method usage example with argument unpacking

kwargs: GetManagedEndpointSessionCredentialsRequestRequestTypeDef = {  # (1)
    "endpointIdentifier": ...,
    "virtualClusterIdentifier": ...,
    "executionRoleArn": ...,
    "credentialType": ...,
}

parent.get_managed_endpoint_session_credentials(**kwargs)
  1. See GetManagedEndpointSessionCredentialsRequestRequestTypeDef

list_job_runs#

Lists job runs based on a set of parameters.

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

# list_job_runs method definition

def list_job_runs(
    self,
    *,
    virtualClusterId: str,
    createdBefore: Union[datetime, str] = ...,
    createdAfter: Union[datetime, str] = ...,
    name: str = ...,
    states: Sequence[JobRunStateType] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListJobRunsResponseTypeDef:  # (2)
    ...
  1. See JobRunStateType
  2. See ListJobRunsResponseTypeDef 
# list_job_runs method usage example with argument unpacking

kwargs: ListJobRunsRequestRequestTypeDef = {  # (1)
    "virtualClusterId": ...,
}

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

list_job_templates#

Lists job templates based on a set of parameters.

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

# list_job_templates method definition

def list_job_templates(
    self,
    *,
    createdAfter: Union[datetime, str] = ...,
    createdBefore: Union[datetime, str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListJobTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListJobTemplatesResponseTypeDef 
# list_job_templates method usage example with argument unpacking

kwargs: ListJobTemplatesRequestRequestTypeDef = {  # (1)
    "createdAfter": ...,
}

parent.list_job_templates(**kwargs)
  1. See ListJobTemplatesRequestRequestTypeDef

list_managed_endpoints#

Lists managed endpoints based on a set of parameters.

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

# list_managed_endpoints method definition

def list_managed_endpoints(
    self,
    *,
    virtualClusterId: str,
    createdBefore: Union[datetime, str] = ...,
    createdAfter: Union[datetime, str] = ...,
    types: Sequence[str] = ...,
    states: Sequence[EndpointStateType] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListManagedEndpointsResponseTypeDef:  # (2)
    ...
  1. See EndpointStateType
  2. See ListManagedEndpointsResponseTypeDef 
# list_managed_endpoints method usage example with argument unpacking

kwargs: ListManagedEndpointsRequestRequestTypeDef = {  # (1)
    "virtualClusterId": ...,
}

parent.list_managed_endpoints(**kwargs)
  1. See ListManagedEndpointsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags assigned to the resources.

Type annotations and code completion for boto3.client("emr-containers").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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

list_virtual_clusters#

Lists information about the specified virtual cluster.

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

# list_virtual_clusters method definition

def list_virtual_clusters(
    self,
    *,
    containerProviderId: str = ...,
    containerProviderType: ContainerProviderTypeType = ...,  # (1)
    createdAfter: Union[datetime, str] = ...,
    createdBefore: Union[datetime, str] = ...,
    states: Sequence[VirtualClusterStateType] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListVirtualClustersResponseTypeDef:  # (3)
    ...
  1. See ContainerProviderTypeType
  2. See VirtualClusterStateType
  3. See ListVirtualClustersResponseTypeDef 
# list_virtual_clusters method usage example with argument unpacking

kwargs: ListVirtualClustersRequestRequestTypeDef = {  # (1)
    "containerProviderId": ...,
}

parent.list_virtual_clusters(**kwargs)
  1. See ListVirtualClustersRequestRequestTypeDef

start_job_run#

Starts a job run.

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

# start_job_run method definition

def start_job_run(
    self,
    *,
    virtualClusterId: str,
    clientToken: str,
    name: str = ...,
    executionRoleArn: str = ...,
    releaseLabel: str = ...,
    jobDriver: JobDriverTypeDef = ...,  # (1)
    configurationOverrides: ConfigurationOverridesTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    jobTemplateId: str = ...,
    jobTemplateParameters: Mapping[str, str] = ...,
    retryPolicyConfiguration: RetryPolicyConfigurationTypeDef = ...,  # (3)
) -> StartJobRunResponseTypeDef:  # (4)
    ...
  1. See JobDriverTypeDef
  2. See ConfigurationOverridesTypeDef
  3. See RetryPolicyConfigurationTypeDef
  4. See StartJobRunResponseTypeDef 
# start_job_run method usage example with argument unpacking

kwargs: StartJobRunRequestRequestTypeDef = {  # (1)
    "virtualClusterId": ...,
    "clientToken": ...,
}

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

tag_resource#

Assigns tags to resources.

Type annotations and code completion for boto3.client("emr-containers").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: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

untag_resource#

Removes tags from resources.

Type annotations and code completion for boto3.client("emr-containers").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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

get_paginator#

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