EMRClient

Index > EMR > EMRClient

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

EMRClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_emr.client import EMRClient

session = Session()
async with session.client("emr") as client:
    client: EMRClient

Exceptions

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

Usage example

async with session.client("emr") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.InternalServerError,
        client.InternalServerException,
        client.InvalidRequestException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_emr.client import Exceptions

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

Methods

add_instance_fleet

Adds an instance fleet to a running cluster.

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

Method definition

await def add_instance_fleet(
    self,
    *,
    ClusterId: str,
    InstanceFleet: InstanceFleetConfigTypeDef,  # (1)
) -> AddInstanceFleetOutputTypeDef:  # (2)
    ...

1. See InstanceFleetConfigTypeDef
2. See AddInstanceFleetOutputTypeDef

Usage example with kwargs

kwargs: AddInstanceFleetInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceFleet": ...,
}

parent.add_instance_fleet(**kwargs)

1. See AddInstanceFleetInputRequestTypeDef

add_instance_groups

Adds one or more instance groups to a running cluster.

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

Method definition

await def add_instance_groups(
    self,
    *,
    InstanceGroups: Sequence[InstanceGroupConfigTypeDef],  # (1)
    JobFlowId: str,
) -> AddInstanceGroupsOutputTypeDef:  # (2)
    ...

1. See InstanceGroupConfigTypeDef
2. See AddInstanceGroupsOutputTypeDef

Usage example with kwargs

kwargs: AddInstanceGroupsInputRequestTypeDef = {  # (1)
    "InstanceGroups": ...,
    "JobFlowId": ...,
}

parent.add_instance_groups(**kwargs)

1. See AddInstanceGroupsInputRequestTypeDef

add_job_flow_steps

AddJobFlowSteps adds new steps to a running cluster.

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

Method definition

await def add_job_flow_steps(
    self,
    *,
    JobFlowId: str,
    Steps: Sequence[StepConfigTypeDef],  # (1)
    ExecutionRoleArn: str = ...,
) -> AddJobFlowStepsOutputTypeDef:  # (2)
    ...

1. See StepConfigTypeDef
2. See AddJobFlowStepsOutputTypeDef

Usage example with kwargs

kwargs: AddJobFlowStepsInputRequestTypeDef = {  # (1)
    "JobFlowId": ...,
    "Steps": ...,
}

parent.add_job_flow_steps(**kwargs)

1. See AddJobFlowStepsInputRequestTypeDef

add_tags

Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio.

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

Method definition

await def add_tags(
    self,
    *,
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: AddTagsInputRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Tags": ...,
}

parent.add_tags(**kwargs)

1. See AddTagsInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

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

cancel_steps

Cancels a pending step or steps in a running cluster.

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

Method definition

await def cancel_steps(
    self,
    *,
    ClusterId: str,
    StepIds: Sequence[str],
    StepCancellationOption: StepCancellationOptionType = ...,  # (1)
) -> CancelStepsOutputTypeDef:  # (2)
    ...

1. See StepCancellationOptionType
2. See CancelStepsOutputTypeDef

Usage example with kwargs

kwargs: CancelStepsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "StepIds": ...,
}

parent.cancel_steps(**kwargs)

1. See CancelStepsInputRequestTypeDef

close

Closes underlying endpoint connections.

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

Method definition

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

create_security_configuration

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

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

Method definition

await def create_security_configuration(
    self,
    *,
    Name: str,
    SecurityConfiguration: str,
) -> CreateSecurityConfigurationOutputTypeDef:  # (1)
    ...

1. See CreateSecurityConfigurationOutputTypeDef

Usage example with kwargs

kwargs: CreateSecurityConfigurationInputRequestTypeDef = {  # (1)
    "Name": ...,
    "SecurityConfiguration": ...,
}

parent.create_security_configuration(**kwargs)

1. See CreateSecurityConfigurationInputRequestTypeDef

create_studio

Creates a new Amazon EMR Studio.

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

Method definition

await def create_studio(
    self,
    *,
    Name: str,
    AuthMode: AuthModeType,  # (1)
    VpcId: str,
    SubnetIds: Sequence[str],
    ServiceRole: str,
    WorkspaceSecurityGroupId: str,
    EngineSecurityGroupId: str,
    DefaultS3Location: str,
    Description: str = ...,
    UserRole: str = ...,
    IdpAuthUrl: str = ...,
    IdpRelayStateParameterName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateStudioOutputTypeDef:  # (3)
    ...

1. See AuthModeType
2. See TagTypeDef
3. See CreateStudioOutputTypeDef

Usage example with kwargs

kwargs: CreateStudioInputRequestTypeDef = {  # (1)
    "Name": ...,
    "AuthMode": ...,
    "VpcId": ...,
    "SubnetIds": ...,
    "ServiceRole": ...,
    "WorkspaceSecurityGroupId": ...,
    "EngineSecurityGroupId": ...,
    "DefaultS3Location": ...,
}

parent.create_studio(**kwargs)

1. See CreateStudioInputRequestTypeDef

create_studio_session_mapping

Maps a user or group to the Amazon EMR Studio specified by StudioId , and applies a session policy to refine Studio permissions for that user or group.

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

Method definition

await def create_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    SessionPolicyArn: str,
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See IdentityTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CreateStudioSessionMappingInputRequestTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
    "SessionPolicyArn": ...,
}

parent.create_studio_session_mapping(**kwargs)

1. See CreateStudioSessionMappingInputRequestTypeDef

delete_security_configuration

Deletes a security configuration.

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

Method definition

await def delete_security_configuration(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteSecurityConfigurationInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_security_configuration(**kwargs)

1. See DeleteSecurityConfigurationInputRequestTypeDef

delete_studio

Removes an Amazon EMR Studio from the Studio metadata store.

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

Method definition

await def delete_studio(
    self,
    *,
    StudioId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteStudioInputRequestTypeDef = {  # (1)
    "StudioId": ...,
}

parent.delete_studio(**kwargs)

1. See DeleteStudioInputRequestTypeDef

delete_studio_session_mapping

Removes a user or group from an Amazon EMR Studio.

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

Method definition

await def delete_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See IdentityTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteStudioSessionMappingInputRequestTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
}

parent.delete_studio_session_mapping(**kwargs)

1. See DeleteStudioSessionMappingInputRequestTypeDef

describe_cluster

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

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

Method definition

await def describe_cluster(
    self,
    *,
    ClusterId: str,
) -> DescribeClusterOutputTypeDef:  # (1)
    ...

1. See DescribeClusterOutputTypeDef

Usage example with kwargs

kwargs: DescribeClusterInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.describe_cluster(**kwargs)

1. See DescribeClusterInputRequestTypeDef

describe_job_flows

This API is no longer supported and will eventually be removed.

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

Method definition

await def describe_job_flows(
    self,
    *,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    JobFlowIds: Sequence[str] = ...,
    JobFlowStates: Sequence[JobFlowExecutionStateType] = ...,  # (1)
) -> DescribeJobFlowsOutputTypeDef:  # (2)
    ...

1. See JobFlowExecutionStateType
2. See DescribeJobFlowsOutputTypeDef

Usage example with kwargs

kwargs: DescribeJobFlowsInputRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.describe_job_flows(**kwargs)

1. See DescribeJobFlowsInputRequestTypeDef

describe_notebook_execution

Provides details of a notebook execution.

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

Method definition

await def describe_notebook_execution(
    self,
    *,
    NotebookExecutionId: str,
) -> DescribeNotebookExecutionOutputTypeDef:  # (1)
    ...

1. See DescribeNotebookExecutionOutputTypeDef

Usage example with kwargs

kwargs: DescribeNotebookExecutionInputRequestTypeDef = {  # (1)
    "NotebookExecutionId": ...,
}

parent.describe_notebook_execution(**kwargs)

1. See DescribeNotebookExecutionInputRequestTypeDef

describe_release_label

.

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

Method definition

await def describe_release_label(
    self,
    *,
    ReleaseLabel: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeReleaseLabelOutputTypeDef:  # (1)
    ...

1. See DescribeReleaseLabelOutputTypeDef

Usage example with kwargs

kwargs: DescribeReleaseLabelInputRequestTypeDef = {  # (1)
    "ReleaseLabel": ...,
}

parent.describe_release_label(**kwargs)

1. See DescribeReleaseLabelInputRequestTypeDef

describe_security_configuration

Provides the details of a security configuration by returning the configuration JSON.

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

Method definition

await def describe_security_configuration(
    self,
    *,
    Name: str,
) -> DescribeSecurityConfigurationOutputTypeDef:  # (1)
    ...

1. See DescribeSecurityConfigurationOutputTypeDef

Usage example with kwargs

kwargs: DescribeSecurityConfigurationInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_security_configuration(**kwargs)

1. See DescribeSecurityConfigurationInputRequestTypeDef

describe_step

Provides more detail about the cluster step.

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

Method definition

await def describe_step(
    self,
    *,
    ClusterId: str,
    StepId: str,
) -> DescribeStepOutputTypeDef:  # (1)
    ...

1. See DescribeStepOutputTypeDef

Usage example with kwargs

kwargs: DescribeStepInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "StepId": ...,
}

parent.describe_step(**kwargs)

1. See DescribeStepInputRequestTypeDef

describe_studio

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.

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

Method definition

await def describe_studio(
    self,
    *,
    StudioId: str,
) -> DescribeStudioOutputTypeDef:  # (1)
    ...

1. See DescribeStudioOutputTypeDef

Usage example with kwargs

kwargs: DescribeStudioInputRequestTypeDef = {  # (1)
    "StudioId": ...,
}

parent.describe_studio(**kwargs)

1. See DescribeStudioInputRequestTypeDef

generate_presigned_url

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

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

get_auto_termination_policy

Returns the auto-termination policy for an Amazon EMR cluster.

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

Method definition

await def get_auto_termination_policy(
    self,
    *,
    ClusterId: str,
) -> GetAutoTerminationPolicyOutputTypeDef:  # (1)
    ...

1. See GetAutoTerminationPolicyOutputTypeDef

Usage example with kwargs

kwargs: GetAutoTerminationPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.get_auto_termination_policy(**kwargs)

1. See GetAutoTerminationPolicyInputRequestTypeDef

get_block_public_access_configuration

Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region.

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

Method definition

await def get_block_public_access_configuration(
    self,
) -> GetBlockPublicAccessConfigurationOutputTypeDef:  # (1)
    ...

1. See GetBlockPublicAccessConfigurationOutputTypeDef

get_managed_scaling_policy

Fetches the attached managed scaling policy for an Amazon EMR cluster.

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

Method definition

await def get_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
) -> GetManagedScalingPolicyOutputTypeDef:  # (1)
    ...

1. See GetManagedScalingPolicyOutputTypeDef

Usage example with kwargs

kwargs: GetManagedScalingPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.get_managed_scaling_policy(**kwargs)

1. See GetManagedScalingPolicyInputRequestTypeDef

get_studio_session_mapping

Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).

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

Method definition

await def get_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> GetStudioSessionMappingOutputTypeDef:  # (2)
    ...

1. See IdentityTypeType
2. See GetStudioSessionMappingOutputTypeDef

Usage example with kwargs

kwargs: GetStudioSessionMappingInputRequestTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
}

parent.get_studio_session_mapping(**kwargs)

1. See GetStudioSessionMappingInputRequestTypeDef

list_bootstrap_actions

Provides information about the bootstrap actions associated with a cluster.

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

Method definition

await def list_bootstrap_actions(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListBootstrapActionsOutputTypeDef:  # (1)
    ...

1. See ListBootstrapActionsOutputTypeDef

Usage example with kwargs

kwargs: ListBootstrapActionsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_bootstrap_actions(**kwargs)

1. See ListBootstrapActionsInputRequestTypeDef

list_clusters

Provides the status of all clusters visible to this Amazon Web Services account.

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

Method definition

await def list_clusters(
    self,
    *,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    ClusterStates: Sequence[ClusterStateType] = ...,  # (1)
    Marker: str = ...,
) -> ListClustersOutputTypeDef:  # (2)
    ...

1. See ClusterStateType
2. See ListClustersOutputTypeDef

Usage example with kwargs

kwargs: ListClustersInputRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersInputRequestTypeDef

list_instance_fleets

Lists all available details about the instance fleets in a cluster.

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

Method definition

await def list_instance_fleets(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListInstanceFleetsOutputTypeDef:  # (1)
    ...

1. See ListInstanceFleetsOutputTypeDef

Usage example with kwargs

kwargs: ListInstanceFleetsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_instance_fleets(**kwargs)

1. See ListInstanceFleetsInputRequestTypeDef

list_instance_groups

Provides all available details about the instance groups in a cluster.

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

Method definition

await def list_instance_groups(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListInstanceGroupsOutputTypeDef:  # (1)
    ...

1. See ListInstanceGroupsOutputTypeDef

Usage example with kwargs

kwargs: ListInstanceGroupsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_instance_groups(**kwargs)

1. See ListInstanceGroupsInputRequestTypeDef

list_instances

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000.

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

Method definition

await def list_instances(
    self,
    *,
    ClusterId: str,
    InstanceGroupId: str = ...,
    InstanceGroupTypes: Sequence[InstanceGroupTypeType] = ...,  # (1)
    InstanceFleetId: str = ...,
    InstanceFleetType: InstanceFleetTypeType = ...,  # (2)
    InstanceStates: Sequence[InstanceStateType] = ...,  # (3)
    Marker: str = ...,
) -> ListInstancesOutputTypeDef:  # (4)
    ...

1. See InstanceGroupTypeType
2. See InstanceFleetTypeType
3. See InstanceStateType
4. See ListInstancesOutputTypeDef

Usage example with kwargs

kwargs: ListInstancesInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_instances(**kwargs)

1. See ListInstancesInputRequestTypeDef

list_notebook_executions

Provides summaries of all notebook executions.

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

Method definition

await def list_notebook_executions(
    self,
    *,
    EditorId: str = ...,
    Status: NotebookExecutionStatusType = ...,  # (1)
    From: Union[datetime, str] = ...,
    To: Union[datetime, str] = ...,
    Marker: str = ...,
) -> ListNotebookExecutionsOutputTypeDef:  # (2)
    ...

1. See NotebookExecutionStatusType
2. See ListNotebookExecutionsOutputTypeDef

Usage example with kwargs

kwargs: ListNotebookExecutionsInputRequestTypeDef = {  # (1)
    "EditorId": ...,
}

parent.list_notebook_executions(**kwargs)

1. See ListNotebookExecutionsInputRequestTypeDef

list_release_labels

Retrieves release labels of EMR services in the region where the API is called.

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

Method definition

await def list_release_labels(
    self,
    *,
    Filters: ReleaseLabelFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReleaseLabelsOutputTypeDef:  # (2)
    ...

1. See ReleaseLabelFilterTypeDef
2. See ListReleaseLabelsOutputTypeDef

Usage example with kwargs

kwargs: ListReleaseLabelsInputRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_release_labels(**kwargs)

1. See ListReleaseLabelsInputRequestTypeDef

list_security_configurations

Lists all the security configurations visible to this account, providing their creation dates and times, and their names.

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

Method definition

await def list_security_configurations(
    self,
    *,
    Marker: str = ...,
) -> ListSecurityConfigurationsOutputTypeDef:  # (1)
    ...

1. See ListSecurityConfigurationsOutputTypeDef

Usage example with kwargs

kwargs: ListSecurityConfigurationsInputRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_security_configurations(**kwargs)

1. See ListSecurityConfigurationsInputRequestTypeDef

list_steps

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates.

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

Method definition

await def list_steps(
    self,
    *,
    ClusterId: str,
    StepStates: Sequence[StepStateType] = ...,  # (1)
    StepIds: Sequence[str] = ...,
    Marker: str = ...,
) -> ListStepsOutputTypeDef:  # (2)
    ...

1. See StepStateType
2. See ListStepsOutputTypeDef

Usage example with kwargs

kwargs: ListStepsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_steps(**kwargs)

1. See ListStepsInputRequestTypeDef

list_studio_session_mappings

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId .

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

Method definition

await def list_studio_session_mappings(
    self,
    *,
    StudioId: str = ...,
    IdentityType: IdentityTypeType = ...,  # (1)
    Marker: str = ...,
) -> ListStudioSessionMappingsOutputTypeDef:  # (2)
    ...

1. See IdentityTypeType
2. See ListStudioSessionMappingsOutputTypeDef

Usage example with kwargs

kwargs: ListStudioSessionMappingsInputRequestTypeDef = {  # (1)
    "StudioId": ...,
}

parent.list_studio_session_mappings(**kwargs)

1. See ListStudioSessionMappingsInputRequestTypeDef

list_studios

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account.

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

Method definition

await def list_studios(
    self,
    *,
    Marker: str = ...,
) -> ListStudiosOutputTypeDef:  # (1)
    ...

1. See ListStudiosOutputTypeDef

Usage example with kwargs

kwargs: ListStudiosInputRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_studios(**kwargs)

1. See ListStudiosInputRequestTypeDef

modify_cluster

Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.

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

Method definition

await def modify_cluster(
    self,
    *,
    ClusterId: str,
    StepConcurrencyLevel: int = ...,
) -> ModifyClusterOutputTypeDef:  # (1)
    ...

1. See ModifyClusterOutputTypeDef

Usage example with kwargs

kwargs: ModifyClusterInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.modify_cluster(**kwargs)

1. See ModifyClusterInputRequestTypeDef

modify_instance_fleet

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID.

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

Method definition

await def modify_instance_fleet(
    self,
    *,
    ClusterId: str,
    InstanceFleet: InstanceFleetModifyConfigTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See InstanceFleetModifyConfigTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: ModifyInstanceFleetInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceFleet": ...,
}

parent.modify_instance_fleet(**kwargs)

1. See ModifyInstanceFleetInputRequestTypeDef

modify_instance_groups

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.

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

Method definition

await def modify_instance_groups(
    self,
    *,
    ClusterId: str = ...,
    InstanceGroups: Sequence[InstanceGroupModifyConfigTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See InstanceGroupModifyConfigTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: ModifyInstanceGroupsInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.modify_instance_groups(**kwargs)

1. See ModifyInstanceGroupsInputRequestTypeDef

put_auto_scaling_policy

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.

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

Method definition

await def put_auto_scaling_policy(
    self,
    *,
    ClusterId: str,
    InstanceGroupId: str,
    AutoScalingPolicy: AutoScalingPolicyTypeDef,  # (1)
) -> PutAutoScalingPolicyOutputTypeDef:  # (2)
    ...

1. See AutoScalingPolicyTypeDef
2. See PutAutoScalingPolicyOutputTypeDef

Usage example with kwargs

kwargs: PutAutoScalingPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceGroupId": ...,
    "AutoScalingPolicy": ...,
}

parent.put_auto_scaling_policy(**kwargs)

1. See PutAutoScalingPolicyInputRequestTypeDef

put_auto_termination_policy

.

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

Method definition

await def put_auto_termination_policy(
    self,
    *,
    ClusterId: str,
    AutoTerminationPolicy: AutoTerminationPolicyTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See AutoTerminationPolicyTypeDef

Usage example with kwargs

kwargs: PutAutoTerminationPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.put_auto_termination_policy(**kwargs)

1. See PutAutoTerminationPolicyInputRequestTypeDef

put_block_public_access_configuration

Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region.

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

Method definition

await def put_block_public_access_configuration(
    self,
    *,
    BlockPublicAccessConfiguration: BlockPublicAccessConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See BlockPublicAccessConfigurationTypeDef

Usage example with kwargs

kwargs: PutBlockPublicAccessConfigurationInputRequestTypeDef = {  # (1)
    "BlockPublicAccessConfiguration": ...,
}

parent.put_block_public_access_configuration(**kwargs)

1. See PutBlockPublicAccessConfigurationInputRequestTypeDef

put_managed_scaling_policy

Creates or updates a managed scaling policy for an Amazon EMR cluster.

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

Method definition

await def put_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
    ManagedScalingPolicy: ManagedScalingPolicyTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See ManagedScalingPolicyTypeDef

Usage example with kwargs

kwargs: PutManagedScalingPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "ManagedScalingPolicy": ...,
}

parent.put_managed_scaling_policy(**kwargs)

1. See PutManagedScalingPolicyInputRequestTypeDef

remove_auto_scaling_policy

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

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

Method definition

await def remove_auto_scaling_policy(
    self,
    *,
    ClusterId: str,
    InstanceGroupId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveAutoScalingPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceGroupId": ...,
}

parent.remove_auto_scaling_policy(**kwargs)

1. See RemoveAutoScalingPolicyInputRequestTypeDef

remove_auto_termination_policy

Removes an auto-termination policy from an Amazon EMR cluster.

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

Method definition

await def remove_auto_termination_policy(
    self,
    *,
    ClusterId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveAutoTerminationPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.remove_auto_termination_policy(**kwargs)

1. See RemoveAutoTerminationPolicyInputRequestTypeDef

remove_managed_scaling_policy

Removes a managed scaling policy from a specified EMR cluster.

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

Method definition

await def remove_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveManagedScalingPolicyInputRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.remove_managed_scaling_policy(**kwargs)

1. See RemoveManagedScalingPolicyInputRequestTypeDef

remove_tags

Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio.

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

Method definition

await def remove_tags(
    self,
    *,
    ResourceId: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveTagsInputRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "TagKeys": ...,
}

parent.remove_tags(**kwargs)

1. See RemoveTagsInputRequestTypeDef

run_job_flow

RunJobFlow creates and starts running a new cluster (job flow).

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

Method definition

await def run_job_flow(
    self,
    *,
    Name: str,
    Instances: JobFlowInstancesConfigTypeDef,  # (1)
    LogUri: str = ...,
    LogEncryptionKmsKeyId: str = ...,
    AdditionalInfo: str = ...,
    AmiVersion: str = ...,
    ReleaseLabel: str = ...,
    Steps: Sequence[StepConfigTypeDef] = ...,  # (2)
    BootstrapActions: Sequence[BootstrapActionConfigTypeDef] = ...,  # (3)
    SupportedProducts: Sequence[str] = ...,
    NewSupportedProducts: Sequence[SupportedProductConfigTypeDef] = ...,  # (4)
    Applications: Sequence[ApplicationTypeDef] = ...,  # (5)
    Configurations: Sequence[ConfigurationTypeDef] = ...,  # (6)
    VisibleToAllUsers: bool = ...,
    JobFlowRole: str = ...,
    ServiceRole: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    SecurityConfiguration: str = ...,
    AutoScalingRole: str = ...,
    ScaleDownBehavior: ScaleDownBehaviorType = ...,  # (8)
    CustomAmiId: str = ...,
    EbsRootVolumeSize: int = ...,
    RepoUpgradeOnBoot: RepoUpgradeOnBootType = ...,  # (9)
    KerberosAttributes: KerberosAttributesTypeDef = ...,  # (10)
    StepConcurrencyLevel: int = ...,
    ManagedScalingPolicy: ManagedScalingPolicyTypeDef = ...,  # (11)
    PlacementGroupConfigs: Sequence[PlacementGroupConfigTypeDef] = ...,  # (12)
    AutoTerminationPolicy: AutoTerminationPolicyTypeDef = ...,  # (13)
    OSReleaseLabel: str = ...,
) -> RunJobFlowOutputTypeDef:  # (14)
    ...

1. See JobFlowInstancesConfigTypeDef
2. See StepConfigTypeDef
3. See BootstrapActionConfigTypeDef
4. See SupportedProductConfigTypeDef
5. See ApplicationTypeDef
6. See ConfigurationTypeDef
7. See TagTypeDef
8. See ScaleDownBehaviorType
9. See RepoUpgradeOnBootType
10. See KerberosAttributesTypeDef
11. See ManagedScalingPolicyTypeDef
12. See PlacementGroupConfigTypeDef
13. See AutoTerminationPolicyTypeDef
14. See RunJobFlowOutputTypeDef

Usage example with kwargs

kwargs: RunJobFlowInputRequestTypeDef = {  # (1)
    "Name": ...,
    "Instances": ...,
}

parent.run_job_flow(**kwargs)

1. See RunJobFlowInputRequestTypeDef

set_termination_protection

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error.

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

Method definition

await def set_termination_protection(
    self,
    *,
    JobFlowIds: Sequence[str],
    TerminationProtected: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SetTerminationProtectionInputRequestTypeDef = {  # (1)
    "JobFlowIds": ...,
    "TerminationProtected": ...,
}

parent.set_termination_protection(**kwargs)

1. See SetTerminationProtectionInputRequestTypeDef

set_visible_to_all_users

.

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

Method definition

await def set_visible_to_all_users(
    self,
    *,
    JobFlowIds: Sequence[str],
    VisibleToAllUsers: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SetVisibleToAllUsersInputRequestTypeDef = {  # (1)
    "JobFlowIds": ...,
    "VisibleToAllUsers": ...,
}

parent.set_visible_to_all_users(**kwargs)

1. See SetVisibleToAllUsersInputRequestTypeDef

start_notebook_execution

Starts a notebook execution.

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

Method definition

await def start_notebook_execution(
    self,
    *,
    EditorId: str,
    RelativePath: str,
    ExecutionEngine: ExecutionEngineConfigTypeDef,  # (1)
    ServiceRole: str,
    NotebookExecutionName: str = ...,
    NotebookParams: str = ...,
    NotebookInstanceSecurityGroupId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> StartNotebookExecutionOutputTypeDef:  # (3)
    ...

1. See ExecutionEngineConfigTypeDef
2. See TagTypeDef
3. See StartNotebookExecutionOutputTypeDef

Usage example with kwargs

kwargs: StartNotebookExecutionInputRequestTypeDef = {  # (1)
    "EditorId": ...,
    "RelativePath": ...,
    "ExecutionEngine": ...,
    "ServiceRole": ...,
}

parent.start_notebook_execution(**kwargs)

1. See StartNotebookExecutionInputRequestTypeDef

stop_notebook_execution

Stops a notebook execution.

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

Method definition

await def stop_notebook_execution(
    self,
    *,
    NotebookExecutionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: StopNotebookExecutionInputRequestTypeDef = {  # (1)
    "NotebookExecutionId": ...,
}

parent.stop_notebook_execution(**kwargs)

1. See StopNotebookExecutionInputRequestTypeDef

terminate_job_flows

TerminateJobFlows shuts a list of clusters (job flows) down.

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

Method definition

await def terminate_job_flows(
    self,
    *,
    JobFlowIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TerminateJobFlowsInputRequestTypeDef = {  # (1)
    "JobFlowIds": ...,
}

parent.terminate_job_flows(**kwargs)

1. See TerminateJobFlowsInputRequestTypeDef

update_studio

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

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

Method definition

await def update_studio(
    self,
    *,
    StudioId: str,
    Name: str = ...,
    Description: str = ...,
    SubnetIds: Sequence[str] = ...,
    DefaultS3Location: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateStudioInputRequestTypeDef = {  # (1)
    "StudioId": ...,
}

parent.update_studio(**kwargs)

1. See UpdateStudioInputRequestTypeDef

update_studio_session_mapping

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

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

Method definition

await def update_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    SessionPolicyArn: str,
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See IdentityTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateStudioSessionMappingInputRequestTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
    "SessionPolicyArn": ...,
}

parent.update_studio_session_mapping(**kwargs)

1. See UpdateStudioSessionMappingInputRequestTypeDef

__aenter__

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

Method definition

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

__aexit__

Type annotations and code completion for session.client("emr").__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").get_paginator method with overloads.

• client.get_paginator("list_bootstrap_actions") -> ListBootstrapActionsPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_instance_fleets") -> ListInstanceFleetsPaginator
• client.get_paginator("list_instance_groups") -> ListInstanceGroupsPaginator
• client.get_paginator("list_instances") -> ListInstancesPaginator
• client.get_paginator("list_notebook_executions") -> ListNotebookExecutionsPaginator
• client.get_paginator("list_security_configurations") -> ListSecurityConfigurationsPaginator
• client.get_paginator("list_steps") -> ListStepsPaginator
• client.get_paginator("list_studio_session_mappings") -> ListStudioSessionMappingsPaginator
• client.get_paginator("list_studios") -> ListStudiosPaginator

get_waiter

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

• client.get_waiter("cluster_running") -> ClusterRunningWaiter
• client.get_waiter("cluster_terminated") -> ClusterTerminatedWaiter
• client.get_waiter("step_complete") -> StepCompleteWaiter