EMRContainersClient

Index > EMRContainers > EMRContainersClient

Auto-generated documentation for EMRContainers type annotations stubs module types-aiobotocore-emr-containers.

EMRContainersClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_emr_containers.client import EMRContainersClient

session = Session()
async with session.client("emr-containers") as client:
    client: EMRContainersClient

Exceptions

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

Usage example

async with session.client("emr-containers") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ValidationException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("emr-containers").can_paginate method. boto3 documentation

Method definition

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

cancel_job_run

Cancels a job run.

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

Method definition

await def cancel_job_run(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> CancelJobRunResponseTypeDef:  # (1)
    ...

1. See CancelJobRunResponseTypeDef

Usage example with kwargs

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

parent.cancel_job_run(**kwargs)

1. See CancelJobRunRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

Method definition

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

create_managed_endpoint

Creates a managed endpoint.

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

Method definition

await 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

Usage example with kwargs

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 session.client("emr-containers").create_virtual_cluster method. boto3 documentation

Method definition

await def create_virtual_cluster(
    self,
    *,
    name: str,
    containerProvider: ContainerProviderTypeDef,  # (1)
    clientToken: str,
    tags: Mapping[str, str] = ...,
) -> CreateVirtualClusterResponseTypeDef:  # (2)
    ...

1. See ContainerProviderTypeDef
2. See CreateVirtualClusterResponseTypeDef

Usage example with kwargs

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

parent.create_virtual_cluster(**kwargs)

1. See CreateVirtualClusterRequestRequestTypeDef

delete_managed_endpoint

Deletes a managed endpoint.

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

Method definition

await def delete_managed_endpoint(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DeleteManagedEndpointResponseTypeDef:  # (1)
    ...

1. See DeleteManagedEndpointResponseTypeDef

Usage example with kwargs

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 session.client("emr-containers").delete_virtual_cluster method. boto3 documentation

Method definition

await def delete_virtual_cluster(
    self,
    *,
    id: str,
) -> DeleteVirtualClusterResponseTypeDef:  # (1)
    ...

1. See DeleteVirtualClusterResponseTypeDef

Usage example with kwargs

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 session.client("emr-containers").describe_job_run method. boto3 documentation

Method definition

await def describe_job_run(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DescribeJobRunResponseTypeDef:  # (1)
    ...

1. See DescribeJobRunResponseTypeDef

Usage example with kwargs

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

parent.describe_job_run(**kwargs)

1. See DescribeJobRunRequestRequestTypeDef

describe_managed_endpoint

Displays detailed information about a managed endpoint.

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

Method definition

await def describe_managed_endpoint(
    self,
    *,
    id: str,
    virtualClusterId: str,
) -> DescribeManagedEndpointResponseTypeDef:  # (1)
    ...

1. See DescribeManagedEndpointResponseTypeDef

Usage example with kwargs

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 session.client("emr-containers").describe_virtual_cluster method. boto3 documentation

Method definition

await def describe_virtual_cluster(
    self,
    *,
    id: str,
) -> DescribeVirtualClusterResponseTypeDef:  # (1)
    ...

1. See DescribeVirtualClusterResponseTypeDef

Usage example with kwargs

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 session.client("emr-containers").generate_presigned_url method. boto3 documentation

Method definition

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

list_job_runs

Lists job runs based on a set of parameters.

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

Method definition

await 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

Usage example with kwargs

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

parent.list_job_runs(**kwargs)

1. See ListJobRunsRequestRequestTypeDef

list_managed_endpoints

Lists managed endpoints based on a set of parameters.

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

Method definition

await 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

Usage example with kwargs

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 session.client("emr-containers").list_tags_for_resource method. boto3 documentation

Method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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 session.client("emr-containers").list_virtual_clusters method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("emr-containers").start_job_run method. boto3 documentation

Method definition

await def start_job_run(
    self,
    *,
    virtualClusterId: str,
    clientToken: str,
    executionRoleArn: str,
    releaseLabel: str,
    jobDriver: JobDriverTypeDef,  # (1)
    name: str = ...,
    configurationOverrides: ConfigurationOverridesTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> StartJobRunResponseTypeDef:  # (3)
    ...

1. See JobDriverTypeDef
2. See ConfigurationOverridesTypeDef
3. See StartJobRunResponseTypeDef

Usage example with kwargs

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

parent.start_job_run(**kwargs)

1. See StartJobRunRequestRequestTypeDef

tag_resource

Assigns tags to resources.

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

Method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from resources.

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

Method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> EMRContainersClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("list_job_runs") -> ListJobRunsPaginator
• client.get_paginator("list_managed_endpoints") -> ListManagedEndpointsPaginator
• client.get_paginator("list_virtual_clusters") -> ListVirtualClustersPaginator