EMRClient#
Auto-generated documentation for EMR type annotations stubs module types-boto3-emr.
EMRClient#
Type annotations and code completion for boto3.client("emr").
 boto3 documentation
# EMRClient usage example
from boto3.session import Session
from types_boto3_emr.client import EMRClient
def get_emr_client() -> EMRClient:
    return Session().client("emr")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("emr").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("emr")
try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerError,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidRequestException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_emr.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("emr").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").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:
    ...add_instance_fleet#
Adds an instance fleet to a running cluster.
Type annotations and code completion for boto3.client("emr").add_instance_fleet method.
 boto3 documentation
# add_instance_fleet method definition
def add_instance_fleet(
    self,
    *,
    ClusterId: str,
    InstanceFleet: InstanceFleetConfigTypeDef,  # (1)
) -> AddInstanceFleetOutputTypeDef:  # (2)
    ...# add_instance_fleet method usage example with argument unpacking
kwargs: AddInstanceFleetInputTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceFleet": ...,
}
parent.add_instance_fleet(**kwargs)add_instance_groups#
Adds one or more instance groups to a running cluster.
Type annotations and code completion for boto3.client("emr").add_instance_groups method.
 boto3 documentation
# add_instance_groups method definition
def add_instance_groups(
    self,
    *,
    InstanceGroups: Sequence[InstanceGroupConfigTypeDef],  # (1)
    JobFlowId: str,
) -> AddInstanceGroupsOutputTypeDef:  # (2)
    ...- See Sequence[InstanceGroupConfigTypeDef]
- See AddInstanceGroupsOutputTypeDef
# add_instance_groups method usage example with argument unpacking
kwargs: AddInstanceGroupsInputTypeDef = {  # (1)
    "InstanceGroups": ...,
    "JobFlowId": ...,
}
parent.add_instance_groups(**kwargs)add_job_flow_steps#
AddJobFlowSteps adds new steps to a running cluster.
Type annotations and code completion for boto3.client("emr").add_job_flow_steps method.
 boto3 documentation
# add_job_flow_steps method definition
def add_job_flow_steps(
    self,
    *,
    JobFlowId: str,
    Steps: Sequence[StepConfigUnionTypeDef],  # (1)
    ExecutionRoleArn: str = ...,
) -> AddJobFlowStepsOutputTypeDef:  # (2)
    ...- See Sequence[StepConfigUnionTypeDef]
- See AddJobFlowStepsOutputTypeDef
# add_job_flow_steps method usage example with argument unpacking
kwargs: AddJobFlowStepsInputTypeDef = {  # (1)
    "JobFlowId": ...,
    "Steps": ...,
}
parent.add_job_flow_steps(**kwargs)add_tags#
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio.
Type annotations and code completion for boto3.client("emr").add_tags method.
 boto3 documentation
# add_tags method definition
def add_tags(
    self,
    *,
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...- See Sequence[TagTypeDef]
# add_tags method usage example with argument unpacking
kwargs: AddTagsInputTypeDef = {  # (1)
    "ResourceId": ...,
    "Tags": ...,
}
parent.add_tags(**kwargs)cancel_steps#
Cancels a pending step or steps in a running cluster.
Type annotations and code completion for boto3.client("emr").cancel_steps method.
 boto3 documentation
# cancel_steps method definition
def cancel_steps(
    self,
    *,
    ClusterId: str,
    StepIds: Sequence[str],
    StepCancellationOption: StepCancellationOptionType = ...,  # (1)
) -> CancelStepsOutputTypeDef:  # (2)
    ...# cancel_steps method usage example with argument unpacking
kwargs: CancelStepsInputTypeDef = {  # (1)
    "ClusterId": ...,
    "StepIds": ...,
}
parent.cancel_steps(**kwargs)create_persistent_app_ui#
Creates a persistent application user interface.
Type annotations and code completion for boto3.client("emr").create_persistent_app_ui method.
 boto3 documentation
# create_persistent_app_ui method definition
def create_persistent_app_ui(
    self,
    *,
    TargetResourceArn: str,
    EMRContainersConfig: EMRContainersConfigTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    XReferer: str = ...,
    ProfilerType: ProfilerTypeType = ...,  # (3)
) -> CreatePersistentAppUIOutputTypeDef:  # (4)
    ...- See EMRContainersConfigTypeDef
- See Sequence[TagTypeDef]
- See ProfilerTypeType
- See CreatePersistentAppUIOutputTypeDef
# create_persistent_app_ui method usage example with argument unpacking
kwargs: CreatePersistentAppUIInputTypeDef = {  # (1)
    "TargetResourceArn": ...,
}
parent.create_persistent_app_ui(**kwargs)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 boto3.client("emr").create_security_configuration method.
 boto3 documentation
# create_security_configuration method definition
def create_security_configuration(
    self,
    *,
    Name: str,
    SecurityConfiguration: str,
) -> CreateSecurityConfigurationOutputTypeDef:  # (1)
    ...# create_security_configuration method usage example with argument unpacking
kwargs: CreateSecurityConfigurationInputTypeDef = {  # (1)
    "Name": ...,
    "SecurityConfiguration": ...,
}
parent.create_security_configuration(**kwargs)create_studio#
Creates a new Amazon EMR Studio.
Type annotations and code completion for boto3.client("emr").create_studio method.
 boto3 documentation
# create_studio method definition
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)
    TrustedIdentityPropagationEnabled: bool = ...,
    IdcUserAssignment: IdcUserAssignmentType = ...,  # (3)
    IdcInstanceArn: str = ...,
    EncryptionKeyArn: str = ...,
) -> CreateStudioOutputTypeDef:  # (4)
    ...- See AuthModeType
- See Sequence[TagTypeDef]
- See IdcUserAssignmentType
- See CreateStudioOutputTypeDef
# create_studio method usage example with argument unpacking
kwargs: CreateStudioInputTypeDef = {  # (1)
    "Name": ...,
    "AuthMode": ...,
    "VpcId": ...,
    "SubnetIds": ...,
    "ServiceRole": ...,
    "WorkspaceSecurityGroupId": ...,
    "EngineSecurityGroupId": ...,
    "DefaultS3Location": ...,
}
parent.create_studio(**kwargs)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 boto3.client("emr").create_studio_session_mapping method.
 boto3 documentation
# create_studio_session_mapping method definition
def create_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    SessionPolicyArn: str,
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...# create_studio_session_mapping method usage example with argument unpacking
kwargs: CreateStudioSessionMappingInputTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
    "SessionPolicyArn": ...,
}
parent.create_studio_session_mapping(**kwargs)delete_security_configuration#
Deletes a security configuration.
Type annotations and code completion for boto3.client("emr").delete_security_configuration method.
 boto3 documentation
# delete_security_configuration method definition
def delete_security_configuration(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...# delete_security_configuration method usage example with argument unpacking
kwargs: DeleteSecurityConfigurationInputTypeDef = {  # (1)
    "Name": ...,
}
parent.delete_security_configuration(**kwargs)delete_studio#
Removes an Amazon EMR Studio from the Studio metadata store.
Type annotations and code completion for boto3.client("emr").delete_studio method.
 boto3 documentation
# delete_studio method definition
def delete_studio(
    self,
    *,
    StudioId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# delete_studio method usage example with argument unpacking
kwargs: DeleteStudioInputTypeDef = {  # (1)
    "StudioId": ...,
}
parent.delete_studio(**kwargs)delete_studio_session_mapping#
Removes a user or group from an Amazon EMR Studio.
Type annotations and code completion for boto3.client("emr").delete_studio_session_mapping method.
 boto3 documentation
# delete_studio_session_mapping method definition
def delete_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...# delete_studio_session_mapping method usage example with argument unpacking
kwargs: DeleteStudioSessionMappingInputTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
}
parent.delete_studio_session_mapping(**kwargs)describe_cluster#
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
Type annotations and code completion for boto3.client("emr").describe_cluster method.
 boto3 documentation
# describe_cluster method definition
def describe_cluster(
    self,
    *,
    ClusterId: str,
) -> DescribeClusterOutputTypeDef:  # (1)
    ...# describe_cluster method usage example with argument unpacking
kwargs: DescribeClusterInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.describe_cluster(**kwargs)describe_job_flows#
This API is no longer supported and will eventually be removed.
Type annotations and code completion for boto3.client("emr").describe_job_flows method.
 boto3 documentation
# describe_job_flows method definition
def describe_job_flows(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    JobFlowIds: Sequence[str] = ...,
    JobFlowStates: Sequence[JobFlowExecutionStateType] = ...,  # (1)
) -> DescribeJobFlowsOutputTypeDef:  # (2)
    ...- See Sequence[JobFlowExecutionStateType]
- See DescribeJobFlowsOutputTypeDef
# describe_job_flows method usage example with argument unpacking
kwargs: DescribeJobFlowsInputTypeDef = {  # (1)
    "CreatedAfter": ...,
}
parent.describe_job_flows(**kwargs)describe_notebook_execution#
Provides details of a notebook execution.
Type annotations and code completion for boto3.client("emr").describe_notebook_execution method.
 boto3 documentation
# describe_notebook_execution method definition
def describe_notebook_execution(
    self,
    *,
    NotebookExecutionId: str,
) -> DescribeNotebookExecutionOutputTypeDef:  # (1)
    ...# describe_notebook_execution method usage example with argument unpacking
kwargs: DescribeNotebookExecutionInputTypeDef = {  # (1)
    "NotebookExecutionId": ...,
}
parent.describe_notebook_execution(**kwargs)describe_persistent_app_ui#
Describes a persistent application user interface.
Type annotations and code completion for boto3.client("emr").describe_persistent_app_ui method.
 boto3 documentation
# describe_persistent_app_ui method definition
def describe_persistent_app_ui(
    self,
    *,
    PersistentAppUIId: str,
) -> DescribePersistentAppUIOutputTypeDef:  # (1)
    ...# describe_persistent_app_ui method usage example with argument unpacking
kwargs: DescribePersistentAppUIInputTypeDef = {  # (1)
    "PersistentAppUIId": ...,
}
parent.describe_persistent_app_ui(**kwargs)describe_release_label#
Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label.
Type annotations and code completion for boto3.client("emr").describe_release_label method.
 boto3 documentation
# describe_release_label method definition
def describe_release_label(
    self,
    *,
    ReleaseLabel: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeReleaseLabelOutputTypeDef:  # (1)
    ...# describe_release_label method usage example with argument unpacking
kwargs: DescribeReleaseLabelInputTypeDef = {  # (1)
    "ReleaseLabel": ...,
}
parent.describe_release_label(**kwargs)describe_security_configuration#
Provides the details of a security configuration by returning the configuration JSON.
Type annotations and code completion for boto3.client("emr").describe_security_configuration method.
 boto3 documentation
# describe_security_configuration method definition
def describe_security_configuration(
    self,
    *,
    Name: str,
) -> DescribeSecurityConfigurationOutputTypeDef:  # (1)
    ...# describe_security_configuration method usage example with argument unpacking
kwargs: DescribeSecurityConfigurationInputTypeDef = {  # (1)
    "Name": ...,
}
parent.describe_security_configuration(**kwargs)describe_step#
Provides more detail about the cluster step.
Type annotations and code completion for boto3.client("emr").describe_step method.
 boto3 documentation
# describe_step method definition
def describe_step(
    self,
    *,
    ClusterId: str,
    StepId: str,
) -> DescribeStepOutputTypeDef:  # (1)
    ...# describe_step method usage example with argument unpacking
kwargs: DescribeStepInputTypeDef = {  # (1)
    "ClusterId": ...,
    "StepId": ...,
}
parent.describe_step(**kwargs)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 boto3.client("emr").describe_studio method.
 boto3 documentation
# describe_studio method definition
def describe_studio(
    self,
    *,
    StudioId: str,
) -> DescribeStudioOutputTypeDef:  # (1)
    ...# describe_studio method usage example with argument unpacking
kwargs: DescribeStudioInputTypeDef = {  # (1)
    "StudioId": ...,
}
parent.describe_studio(**kwargs)get_auto_termination_policy#
Returns the auto-termination policy for an Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").get_auto_termination_policy method.
 boto3 documentation
# get_auto_termination_policy method definition
def get_auto_termination_policy(
    self,
    *,
    ClusterId: str,
) -> GetAutoTerminationPolicyOutputTypeDef:  # (1)
    ...# get_auto_termination_policy method usage example with argument unpacking
kwargs: GetAutoTerminationPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.get_auto_termination_policy(**kwargs)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 boto3.client("emr").get_block_public_access_configuration method.
 boto3 documentation
# get_block_public_access_configuration method definition
def get_block_public_access_configuration(
    self,
) -> GetBlockPublicAccessConfigurationOutputTypeDef:  # (1)
    ...get_cluster_session_credentials#
Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated.
Type annotations and code completion for boto3.client("emr").get_cluster_session_credentials method.
 boto3 documentation
# get_cluster_session_credentials method definition
def get_cluster_session_credentials(
    self,
    *,
    ClusterId: str,
    ExecutionRoleArn: str = ...,
) -> GetClusterSessionCredentialsOutputTypeDef:  # (1)
    ...# get_cluster_session_credentials method usage example with argument unpacking
kwargs: GetClusterSessionCredentialsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.get_cluster_session_credentials(**kwargs)get_managed_scaling_policy#
Fetches the attached managed scaling policy for an Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").get_managed_scaling_policy method.
 boto3 documentation
# get_managed_scaling_policy method definition
def get_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
) -> GetManagedScalingPolicyOutputTypeDef:  # (1)
    ...# get_managed_scaling_policy method usage example with argument unpacking
kwargs: GetManagedScalingPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.get_managed_scaling_policy(**kwargs)get_on_cluster_app_ui_presigned_url#
The presigned URL properties for the cluster's application user interface.
Type annotations and code completion for boto3.client("emr").get_on_cluster_app_ui_presigned_url method.
 boto3 documentation
# get_on_cluster_app_ui_presigned_url method definition
def get_on_cluster_app_ui_presigned_url(
    self,
    *,
    ClusterId: str,
    OnClusterAppUIType: OnClusterAppUITypeType = ...,  # (1)
    ApplicationId: str = ...,
    DryRun: bool = ...,
    ExecutionRoleArn: str = ...,
) -> GetOnClusterAppUIPresignedURLOutputTypeDef:  # (2)
    ...# get_on_cluster_app_ui_presigned_url method usage example with argument unpacking
kwargs: GetOnClusterAppUIPresignedURLInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.get_on_cluster_app_ui_presigned_url(**kwargs)get_persistent_app_ui_presigned_url#
The presigned URL properties for the cluster's application user interface.
Type annotations and code completion for boto3.client("emr").get_persistent_app_ui_presigned_url method.
 boto3 documentation
# get_persistent_app_ui_presigned_url method definition
def get_persistent_app_ui_presigned_url(
    self,
    *,
    PersistentAppUIId: str,
    PersistentAppUIType: PersistentAppUITypeType = ...,  # (1)
    ApplicationId: str = ...,
    AuthProxyCall: bool = ...,
    ExecutionRoleArn: str = ...,
) -> GetPersistentAppUIPresignedURLOutputTypeDef:  # (2)
    ...# get_persistent_app_ui_presigned_url method usage example with argument unpacking
kwargs: GetPersistentAppUIPresignedURLInputTypeDef = {  # (1)
    "PersistentAppUIId": ...,
}
parent.get_persistent_app_ui_presigned_url(**kwargs)get_studio_session_mapping#
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
Type annotations and code completion for boto3.client("emr").get_studio_session_mapping method.
 boto3 documentation
# get_studio_session_mapping method definition
def get_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> GetStudioSessionMappingOutputTypeDef:  # (2)
    ...# get_studio_session_mapping method usage example with argument unpacking
kwargs: GetStudioSessionMappingInputTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
}
parent.get_studio_session_mapping(**kwargs)list_bootstrap_actions#
Provides information about the bootstrap actions associated with a cluster.
Type annotations and code completion for boto3.client("emr").list_bootstrap_actions method.
 boto3 documentation
# list_bootstrap_actions method definition
def list_bootstrap_actions(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListBootstrapActionsOutputTypeDef:  # (1)
    ...# list_bootstrap_actions method usage example with argument unpacking
kwargs: ListBootstrapActionsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.list_bootstrap_actions(**kwargs)list_clusters#
Provides the status of all clusters visible to this Amazon Web Services account.
Type annotations and code completion for boto3.client("emr").list_clusters method.
 boto3 documentation
# list_clusters method definition
def list_clusters(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    ClusterStates: Sequence[ClusterStateType] = ...,  # (1)
    Marker: str = ...,
) -> ListClustersOutputTypeDef:  # (2)
    ...- See Sequence[ClusterStateType]
- See ListClustersOutputTypeDef
# list_clusters method usage example with argument unpacking
kwargs: ListClustersInputTypeDef = {  # (1)
    "CreatedAfter": ...,
}
parent.list_clusters(**kwargs)list_instance_fleets#
Lists all available details about the instance fleets in a cluster.
Type annotations and code completion for boto3.client("emr").list_instance_fleets method.
 boto3 documentation
# list_instance_fleets method definition
def list_instance_fleets(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListInstanceFleetsOutputTypeDef:  # (1)
    ...# list_instance_fleets method usage example with argument unpacking
kwargs: ListInstanceFleetsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.list_instance_fleets(**kwargs)list_instance_groups#
Provides all available details about the instance groups in a cluster.
Type annotations and code completion for boto3.client("emr").list_instance_groups method.
 boto3 documentation
# list_instance_groups method definition
def list_instance_groups(
    self,
    *,
    ClusterId: str,
    Marker: str = ...,
) -> ListInstanceGroupsOutputTypeDef:  # (1)
    ...# list_instance_groups method usage example with argument unpacking
kwargs: ListInstanceGroupsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.list_instance_groups(**kwargs)list_instances#
Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000.
Type annotations and code completion for boto3.client("emr").list_instances method.
 boto3 documentation
# list_instances method definition
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)
    ...- See Sequence[InstanceGroupTypeType]
- See InstanceFleetTypeType
- See Sequence[InstanceStateType]
- See ListInstancesOutputTypeDef
# list_instances method usage example with argument unpacking
kwargs: ListInstancesInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.list_instances(**kwargs)list_notebook_executions#
Provides summaries of all notebook executions.
Type annotations and code completion for boto3.client("emr").list_notebook_executions method.
 boto3 documentation
# list_notebook_executions method definition
def list_notebook_executions(
    self,
    *,
    EditorId: str = ...,
    Status: NotebookExecutionStatusType = ...,  # (1)
    From: TimestampTypeDef = ...,
    To: TimestampTypeDef = ...,
    Marker: str = ...,
    ExecutionEngineId: str = ...,
) -> ListNotebookExecutionsOutputTypeDef:  # (2)
    ...# list_notebook_executions method usage example with argument unpacking
kwargs: ListNotebookExecutionsInputTypeDef = {  # (1)
    "EditorId": ...,
}
parent.list_notebook_executions(**kwargs)list_release_labels#
Retrieves release labels of Amazon EMR services in the Region where the API is called.
Type annotations and code completion for boto3.client("emr").list_release_labels method.
 boto3 documentation
# list_release_labels method definition
def list_release_labels(
    self,
    *,
    Filters: ReleaseLabelFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReleaseLabelsOutputTypeDef:  # (2)
    ...# list_release_labels method usage example with argument unpacking
kwargs: ListReleaseLabelsInputTypeDef = {  # (1)
    "Filters": ...,
}
parent.list_release_labels(**kwargs)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 boto3.client("emr").list_security_configurations method.
 boto3 documentation
# list_security_configurations method definition
def list_security_configurations(
    self,
    *,
    Marker: str = ...,
) -> ListSecurityConfigurationsOutputTypeDef:  # (1)
    ...# list_security_configurations method usage example with argument unpacking
kwargs: ListSecurityConfigurationsInputTypeDef = {  # (1)
    "Marker": ...,
}
parent.list_security_configurations(**kwargs)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 boto3.client("emr").list_steps method.
 boto3 documentation
# list_steps method definition
def list_steps(
    self,
    *,
    ClusterId: str,
    StepStates: Sequence[StepStateType] = ...,  # (1)
    StepIds: Sequence[str] = ...,
    Marker: str = ...,
) -> ListStepsOutputTypeDef:  # (2)
    ...- See Sequence[StepStateType]
- See ListStepsOutputTypeDef
# list_steps method usage example with argument unpacking
kwargs: ListStepsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.list_steps(**kwargs)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 boto3.client("emr").list_studio_session_mappings method.
 boto3 documentation
# list_studio_session_mappings method definition
def list_studio_session_mappings(
    self,
    *,
    StudioId: str = ...,
    IdentityType: IdentityTypeType = ...,  # (1)
    Marker: str = ...,
) -> ListStudioSessionMappingsOutputTypeDef:  # (2)
    ...# list_studio_session_mappings method usage example with argument unpacking
kwargs: ListStudioSessionMappingsInputTypeDef = {  # (1)
    "StudioId": ...,
}
parent.list_studio_session_mappings(**kwargs)list_studios#
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account.
Type annotations and code completion for boto3.client("emr").list_studios method.
 boto3 documentation
# list_studios method definition
def list_studios(
    self,
    *,
    Marker: str = ...,
) -> ListStudiosOutputTypeDef:  # (1)
    ...# list_studios method usage example with argument unpacking
kwargs: ListStudiosInputTypeDef = {  # (1)
    "Marker": ...,
}
parent.list_studios(**kwargs)list_supported_instance_types#
A list of the instance types that Amazon EMR supports.
Type annotations and code completion for boto3.client("emr").list_supported_instance_types method.
 boto3 documentation
# list_supported_instance_types method definition
def list_supported_instance_types(
    self,
    *,
    ReleaseLabel: str,
    Marker: str = ...,
) -> ListSupportedInstanceTypesOutputTypeDef:  # (1)
    ...# list_supported_instance_types method usage example with argument unpacking
kwargs: ListSupportedInstanceTypesInputTypeDef = {  # (1)
    "ReleaseLabel": ...,
}
parent.list_supported_instance_types(**kwargs)modify_cluster#
Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
Type annotations and code completion for boto3.client("emr").modify_cluster method.
 boto3 documentation
# modify_cluster method definition
def modify_cluster(
    self,
    *,
    ClusterId: str,
    StepConcurrencyLevel: int = ...,
    ExtendedSupport: bool = ...,
) -> ModifyClusterOutputTypeDef:  # (1)
    ...# modify_cluster method usage example with argument unpacking
kwargs: ModifyClusterInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.modify_cluster(**kwargs)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 boto3.client("emr").modify_instance_fleet method.
 boto3 documentation
# modify_instance_fleet method definition
def modify_instance_fleet(
    self,
    *,
    ClusterId: str,
    InstanceFleet: InstanceFleetModifyConfigTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...# modify_instance_fleet method usage example with argument unpacking
kwargs: ModifyInstanceFleetInputTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceFleet": ...,
}
parent.modify_instance_fleet(**kwargs)modify_instance_groups#
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.
Type annotations and code completion for boto3.client("emr").modify_instance_groups method.
 boto3 documentation
# modify_instance_groups method definition
def modify_instance_groups(
    self,
    *,
    ClusterId: str = ...,
    InstanceGroups: Sequence[InstanceGroupModifyConfigTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...- See Sequence[InstanceGroupModifyConfigTypeDef]
- See EmptyResponseMetadataTypeDef
# modify_instance_groups method usage example with argument unpacking
kwargs: ModifyInstanceGroupsInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.modify_instance_groups(**kwargs)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 boto3.client("emr").put_auto_scaling_policy method.
 boto3 documentation
# put_auto_scaling_policy method definition
def put_auto_scaling_policy(
    self,
    *,
    ClusterId: str,
    InstanceGroupId: str,
    AutoScalingPolicy: AutoScalingPolicyTypeDef,  # (1)
) -> PutAutoScalingPolicyOutputTypeDef:  # (2)
    ...# put_auto_scaling_policy method usage example with argument unpacking
kwargs: PutAutoScalingPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceGroupId": ...,
    "AutoScalingPolicy": ...,
}
parent.put_auto_scaling_policy(**kwargs)put_auto_termination_policy#
Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later.
Type annotations and code completion for boto3.client("emr").put_auto_termination_policy method.
 boto3 documentation
# put_auto_termination_policy method definition
def put_auto_termination_policy(
    self,
    *,
    ClusterId: str,
    AutoTerminationPolicy: AutoTerminationPolicyTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...# put_auto_termination_policy method usage example with argument unpacking
kwargs: PutAutoTerminationPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.put_auto_termination_policy(**kwargs)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 boto3.client("emr").put_block_public_access_configuration method.
 boto3 documentation
# put_block_public_access_configuration method definition
def put_block_public_access_configuration(
    self,
    *,
    BlockPublicAccessConfiguration: BlockPublicAccessConfigurationUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...# put_block_public_access_configuration method usage example with argument unpacking
kwargs: PutBlockPublicAccessConfigurationInputTypeDef = {  # (1)
    "BlockPublicAccessConfiguration": ...,
}
parent.put_block_public_access_configuration(**kwargs)put_managed_scaling_policy#
Creates or updates a managed scaling policy for an Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").put_managed_scaling_policy method.
 boto3 documentation
# put_managed_scaling_policy method definition
def put_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
    ManagedScalingPolicy: ManagedScalingPolicyTypeDef,  # (1)
) -> Dict[str, Any]:
    ...# put_managed_scaling_policy method usage example with argument unpacking
kwargs: PutManagedScalingPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
    "ManagedScalingPolicy": ...,
}
parent.put_managed_scaling_policy(**kwargs)remove_auto_scaling_policy#
Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").remove_auto_scaling_policy method.
 boto3 documentation
# remove_auto_scaling_policy method definition
def remove_auto_scaling_policy(
    self,
    *,
    ClusterId: str,
    InstanceGroupId: str,
) -> Dict[str, Any]:
    ...# remove_auto_scaling_policy method usage example with argument unpacking
kwargs: RemoveAutoScalingPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
    "InstanceGroupId": ...,
}
parent.remove_auto_scaling_policy(**kwargs)remove_auto_termination_policy#
Removes an auto-termination policy from an Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").remove_auto_termination_policy method.
 boto3 documentation
# remove_auto_termination_policy method definition
def remove_auto_termination_policy(
    self,
    *,
    ClusterId: str,
) -> Dict[str, Any]:
    ...# remove_auto_termination_policy method usage example with argument unpacking
kwargs: RemoveAutoTerminationPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.remove_auto_termination_policy(**kwargs)remove_managed_scaling_policy#
Removes a managed scaling policy from a specified Amazon EMR cluster.
Type annotations and code completion for boto3.client("emr").remove_managed_scaling_policy method.
 boto3 documentation
# remove_managed_scaling_policy method definition
def remove_managed_scaling_policy(
    self,
    *,
    ClusterId: str,
) -> Dict[str, Any]:
    ...# remove_managed_scaling_policy method usage example with argument unpacking
kwargs: RemoveManagedScalingPolicyInputTypeDef = {  # (1)
    "ClusterId": ...,
}
parent.remove_managed_scaling_policy(**kwargs)remove_tags#
Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio.
Type annotations and code completion for boto3.client("emr").remove_tags method.
 boto3 documentation
# remove_tags method definition
def remove_tags(
    self,
    *,
    ResourceId: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# remove_tags method usage example with argument unpacking
kwargs: RemoveTagsInputTypeDef = {  # (1)
    "ResourceId": ...,
    "TagKeys": ...,
}
parent.remove_tags(**kwargs)run_job_flow#
RunJobFlow creates and starts running a new cluster (job flow).
Type annotations and code completion for boto3.client("emr").run_job_flow method.
 boto3 documentation
# run_job_flow method definition
def run_job_flow(
    self,
    *,
    Name: str,
    Instances: JobFlowInstancesConfigTypeDef,  # (1)
    LogUri: str = ...,
    LogEncryptionKmsKeyId: str = ...,
    AdditionalInfo: str = ...,
    AmiVersion: str = ...,
    ReleaseLabel: str = ...,
    Steps: Sequence[StepConfigUnionTypeDef] = ...,  # (2)
    BootstrapActions: Sequence[BootstrapActionConfigUnionTypeDef] = ...,  # (3)
    SupportedProducts: Sequence[str] = ...,
    NewSupportedProducts: Sequence[SupportedProductConfigTypeDef] = ...,  # (4)
    Applications: Sequence[ApplicationUnionTypeDef] = ...,  # (5)
    Configurations: Sequence[ConfigurationUnionTypeDef] = ...,  # (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 = ...,
    EbsRootVolumeIops: int = ...,
    EbsRootVolumeThroughput: int = ...,
    ExtendedSupport: bool = ...,
) -> RunJobFlowOutputTypeDef:  # (14)
    ...- See JobFlowInstancesConfigTypeDef
- See Sequence[StepConfigUnionTypeDef]
- See Sequence[BootstrapActionConfigUnionTypeDef]
- See Sequence[SupportedProductConfigTypeDef]
- See Sequence[ApplicationUnionTypeDef]
- See Sequence[ConfigurationUnionTypeDef]
- See Sequence[TagTypeDef]
- See ScaleDownBehaviorType
- See RepoUpgradeOnBootType
- See KerberosAttributesTypeDef
- See ManagedScalingPolicyTypeDef
- See Sequence[PlacementGroupConfigTypeDef]
- See AutoTerminationPolicyTypeDef
- See RunJobFlowOutputTypeDef
# run_job_flow method usage example with argument unpacking
kwargs: RunJobFlowInputTypeDef = {  # (1)
    "Name": ...,
    "Instances": ...,
}
parent.run_job_flow(**kwargs)set_keep_job_flow_alive_when_no_steps#
You can use the SetKeepJobFlowAliveWhenNoSteps to configure a
cluster (job flow) to terminate after the step execution, i.e., all your steps
are executed.
Type annotations and code completion for boto3.client("emr").set_keep_job_flow_alive_when_no_steps method.
 boto3 documentation
# set_keep_job_flow_alive_when_no_steps method definition
def set_keep_job_flow_alive_when_no_steps(
    self,
    *,
    JobFlowIds: Sequence[str],
    KeepJobFlowAliveWhenNoSteps: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# set_keep_job_flow_alive_when_no_steps method usage example with argument unpacking
kwargs: SetKeepJobFlowAliveWhenNoStepsInputTypeDef = {  # (1)
    "JobFlowIds": ...,
    "KeepJobFlowAliveWhenNoSteps": ...,
}
parent.set_keep_job_flow_alive_when_no_steps(**kwargs)set_termination_protection#
SetTerminationProtection locks a cluster (job flow) so the Amazon 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 boto3.client("emr").set_termination_protection method.
 boto3 documentation
# set_termination_protection method definition
def set_termination_protection(
    self,
    *,
    JobFlowIds: Sequence[str],
    TerminationProtected: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# set_termination_protection method usage example with argument unpacking
kwargs: SetTerminationProtectionInputTypeDef = {  # (1)
    "JobFlowIds": ...,
    "TerminationProtected": ...,
}
parent.set_termination_protection(**kwargs)set_unhealthy_node_replacement#
Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy.
Type annotations and code completion for boto3.client("emr").set_unhealthy_node_replacement method.
 boto3 documentation
# set_unhealthy_node_replacement method definition
def set_unhealthy_node_replacement(
    self,
    *,
    JobFlowIds: Sequence[str],
    UnhealthyNodeReplacement: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# set_unhealthy_node_replacement method usage example with argument unpacking
kwargs: SetUnhealthyNodeReplacementInputTypeDef = {  # (1)
    "JobFlowIds": ...,
    "UnhealthyNodeReplacement": ...,
}
parent.set_unhealthy_node_replacement(**kwargs)set_visible_to_all_users#
The SetVisibleToAllUsers parameter is no longer supported.
Type annotations and code completion for boto3.client("emr").set_visible_to_all_users method.
 boto3 documentation
# set_visible_to_all_users method definition
def set_visible_to_all_users(
    self,
    *,
    JobFlowIds: Sequence[str],
    VisibleToAllUsers: bool,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# set_visible_to_all_users method usage example with argument unpacking
kwargs: SetVisibleToAllUsersInputTypeDef = {  # (1)
    "JobFlowIds": ...,
    "VisibleToAllUsers": ...,
}
parent.set_visible_to_all_users(**kwargs)start_notebook_execution#
Starts a notebook execution.
Type annotations and code completion for boto3.client("emr").start_notebook_execution method.
 boto3 documentation
# start_notebook_execution method definition
def start_notebook_execution(
    self,
    *,
    ExecutionEngine: ExecutionEngineConfigTypeDef,  # (1)
    ServiceRole: str,
    EditorId: str = ...,
    RelativePath: str = ...,
    NotebookExecutionName: str = ...,
    NotebookParams: str = ...,
    NotebookInstanceSecurityGroupId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    NotebookS3Location: NotebookS3LocationFromInputTypeDef = ...,  # (3)
    OutputNotebookS3Location: OutputNotebookS3LocationFromInputTypeDef = ...,  # (4)
    OutputNotebookFormat: OutputNotebookFormatType = ...,  # (5)
    EnvironmentVariables: Mapping[str, str] = ...,
) -> StartNotebookExecutionOutputTypeDef:  # (6)
    ...- See ExecutionEngineConfigTypeDef
- See Sequence[TagTypeDef]
- See NotebookS3LocationFromInputTypeDef
- See OutputNotebookS3LocationFromInputTypeDef
- See OutputNotebookFormatType
- See StartNotebookExecutionOutputTypeDef
# start_notebook_execution method usage example with argument unpacking
kwargs: StartNotebookExecutionInputTypeDef = {  # (1)
    "ExecutionEngine": ...,
    "ServiceRole": ...,
}
parent.start_notebook_execution(**kwargs)stop_notebook_execution#
Stops a notebook execution.
Type annotations and code completion for boto3.client("emr").stop_notebook_execution method.
 boto3 documentation
# stop_notebook_execution method definition
def stop_notebook_execution(
    self,
    *,
    NotebookExecutionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# stop_notebook_execution method usage example with argument unpacking
kwargs: StopNotebookExecutionInputTypeDef = {  # (1)
    "NotebookExecutionId": ...,
}
parent.stop_notebook_execution(**kwargs)terminate_job_flows#
TerminateJobFlows shuts a list of clusters (job flows) down.
Type annotations and code completion for boto3.client("emr").terminate_job_flows method.
 boto3 documentation
# terminate_job_flows method definition
def terminate_job_flows(
    self,
    *,
    JobFlowIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# terminate_job_flows method usage example with argument unpacking
kwargs: TerminateJobFlowsInputTypeDef = {  # (1)
    "JobFlowIds": ...,
}
parent.terminate_job_flows(**kwargs)update_studio#
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
Type annotations and code completion for boto3.client("emr").update_studio method.
 boto3 documentation
# update_studio method definition
def update_studio(
    self,
    *,
    StudioId: str,
    Name: str = ...,
    Description: str = ...,
    SubnetIds: Sequence[str] = ...,
    DefaultS3Location: str = ...,
    EncryptionKeyArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# update_studio method usage example with argument unpacking
kwargs: UpdateStudioInputTypeDef = {  # (1)
    "StudioId": ...,
}
parent.update_studio(**kwargs)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 boto3.client("emr").update_studio_session_mapping method.
 boto3 documentation
# update_studio_session_mapping method definition
def update_studio_session_mapping(
    self,
    *,
    StudioId: str,
    IdentityType: IdentityTypeType,  # (1)
    SessionPolicyArn: str,
    IdentityId: str = ...,
    IdentityName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...# update_studio_session_mapping method usage example with argument unpacking
kwargs: UpdateStudioSessionMappingInputTypeDef = {  # (1)
    "StudioId": ...,
    "IdentityType": ...,
    "SessionPolicyArn": ...,
}
parent.update_studio_session_mapping(**kwargs)get_paginator#
Type annotations and code completion for boto3.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 boto3.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