Struct aws_sdk_emr::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon EMR
Client for invoking operations on Amazon EMR. Each operation on Amazon EMR is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_emr::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_emr::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_emr::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn add_instance_fleet(&self) -> AddInstanceFleet
pub fn add_instance_fleet(&self) -> AddInstanceFleet
Constructs a fluent builder for the AddInstanceFleet
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The unique identifier of the cluster.
instance_fleet(InstanceFleetConfig)
/set_instance_fleet(Option<InstanceFleetConfig>)
:Specifies the configuration of the instance fleet.
- On success, responds with
AddInstanceFleetOutput
with field(s):cluster_id(Option<String>)
:The unique identifier of the cluster.
instance_fleet_id(Option<String>)
:The unique identifier of the instance fleet.
cluster_arn(Option<String>)
:The Amazon Resource Name of the cluster.
- On failure, responds with
SdkError<AddInstanceFleetError>
sourcepub fn add_instance_groups(&self) -> AddInstanceGroups
pub fn add_instance_groups(&self) -> AddInstanceGroups
Constructs a fluent builder for the AddInstanceGroups
operation.
- The fluent builder is configurable:
instance_groups(Vec<InstanceGroupConfig>)
/set_instance_groups(Option<Vec<InstanceGroupConfig>>)
:Instance groups to add.
job_flow_id(impl Into<String>)
/set_job_flow_id(Option<String>)
:Job flow in which to add the instance groups.
- On success, responds with
AddInstanceGroupsOutput
with field(s):job_flow_id(Option<String>)
:The job flow ID in which the instance groups are added.
instance_group_ids(Option<Vec<String>>)
:Instance group IDs of the newly created instance groups.
cluster_arn(Option<String>)
:The Amazon Resource Name of the cluster.
- On failure, responds with
SdkError<AddInstanceGroupsError>
sourcepub fn add_job_flow_steps(&self) -> AddJobFlowSteps
pub fn add_job_flow_steps(&self) -> AddJobFlowSteps
Constructs a fluent builder for the AddJobFlowSteps
operation.
- The fluent builder is configurable:
job_flow_id(impl Into<String>)
/set_job_flow_id(Option<String>)
:A string that uniquely identifies the job flow. This identifier is returned by
RunJobFlow
and can also be obtained fromListClusters
.steps(Vec<StepConfig>)
/set_steps(Option<Vec<StepConfig>>)
:A list of
StepConfig
to be executed by the job flow.execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format:
arn:partition:service:region:account:resource
.For example,
arn:aws:iam::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
- On success, responds with
AddJobFlowStepsOutput
with field(s):step_ids(Option<Vec<String>>)
:The identifiers of the list of steps added to the job flow.
- On failure, responds with
SdkError<AddJobFlowStepsError>
Constructs a fluent builder for the AddTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
- On success, responds with
AddTagsOutput
- On failure, responds with
SdkError<AddTagsError>
sourcepub fn cancel_steps(&self) -> CancelSteps
pub fn cancel_steps(&self) -> CancelSteps
Constructs a fluent builder for the CancelSteps
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The
ClusterID
for the specified steps that will be canceled. UseRunJobFlow
andListClusters
to get ClusterIDs.step_ids(Vec<String>)
/set_step_ids(Option<Vec<String>>)
:The list of
StepIDs
to cancel. UseListSteps
to get steps and their states for the specified cluster.step_cancellation_option(StepCancellationOption)
/set_step_cancellation_option(Option<StepCancellationOption>)
:The option to choose to cancel
RUNNING
steps. By default, the value isSEND_INTERRUPT
.
- On success, responds with
CancelStepsOutput
with field(s):cancel_steps_info_list(Option<Vec<CancelStepsInfo>>)
:A list of
CancelStepsInfo
, which shows the status of specified cancel requests for eachStepID
specified.
- On failure, responds with
SdkError<CancelStepsError>
sourcepub fn create_security_configuration(&self) -> CreateSecurityConfiguration
pub fn create_security_configuration(&self) -> CreateSecurityConfiguration
Constructs a fluent builder for the CreateSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the security configuration.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
- On success, responds with
CreateSecurityConfigurationOutput
with field(s):name(Option<String>)
:The name of the security configuration.
creation_date_time(Option<DateTime>)
:The date and time the security configuration was created.
- On failure, responds with
SdkError<CreateSecurityConfigurationError>
sourcepub fn create_studio(&self) -> CreateStudio
pub fn create_studio(&self) -> CreateStudio
Constructs a fluent builder for the CreateStudio
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:A descriptive name for the Amazon EMR Studio.
description(impl Into<String>)
/set_description(Option<String>)
:A detailed description of the Amazon EMR Studio.
auth_mode(AuthMode)
/set_auth_mode(Option<AuthMode>)
:Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by
VpcId
. Studio users can create a Workspace in any of the specified subnets.service_role(impl Into<String>)
/set_service_role(Option<String>)
:The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
user_role(impl Into<String>)
/set_user_role(Option<String>)
:The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a
UserRole
when you use Amazon Web Services SSO authentication. The permissions attached to theUserRole
can be scoped down for each user or group using session policies.workspace_security_group_id(impl Into<String>)
/set_workspace_security_group_id(Option<String>)
:The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by
VpcId
.engine_security_group_id(impl Into<String>)
/set_engine_security_group_id(Option<String>)
:The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
.default_s3_location(impl Into<String>)
/set_default_s3_location(Option<String>)
:The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
idp_auth_url(impl Into<String>)
/set_idp_auth_url(Option<String>)
:The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
idp_relay_state_parameter_name(impl Into<String>)
/set_idp_relay_state_parameter_name(Option<String>)
:The name that your identity provider (IdP) uses for its
RelayState
parameter. For example,RelayState
orTargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. TheRelayState
parameter differs by IdP.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
- On success, responds with
CreateStudioOutput
with field(s):studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
url(Option<String>)
:The unique Studio access URL.
- On failure, responds with
SdkError<CreateStudioError>
sourcepub fn create_studio_session_mapping(&self) -> CreateStudioSessionMapping
pub fn create_studio_session_mapping(&self) -> CreateStudioSessionMapping
Constructs a fluent builder for the CreateStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio to which the user or group will be mapped.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified, but not both.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified, but not both.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
session_policy_arn(impl Into<String>)
/set_session_policy_arn(Option<String>)
:The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.
- On success, responds with
CreateStudioSessionMappingOutput
- On failure, responds with
SdkError<CreateStudioSessionMappingError>
sourcepub fn delete_security_configuration(&self) -> DeleteSecurityConfiguration
pub fn delete_security_configuration(&self) -> DeleteSecurityConfiguration
Constructs a fluent builder for the DeleteSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the security configuration.
- On success, responds with
DeleteSecurityConfigurationOutput
- On failure, responds with
SdkError<DeleteSecurityConfigurationError>
sourcepub fn delete_studio(&self) -> DeleteStudio
pub fn delete_studio(&self) -> DeleteStudio
Constructs a fluent builder for the DeleteStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
- On success, responds with
DeleteStudioOutput
- On failure, responds with
SdkError<DeleteStudioError>
sourcepub fn delete_studio_session_mapping(&self) -> DeleteStudioSessionMapping
pub fn delete_studio_session_mapping(&self) -> DeleteStudioSessionMapping
Constructs a fluent builder for the DeleteStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the Amazon Web Services SSO Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
- On success, responds with
DeleteStudioSessionMappingOutput
- On failure, responds with
SdkError<DeleteStudioSessionMappingError>
sourcepub fn describe_cluster(&self) -> DescribeCluster
pub fn describe_cluster(&self) -> DescribeCluster
Constructs a fluent builder for the DescribeCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The identifier of the cluster to describe.
- On success, responds with
DescribeClusterOutput
with field(s):cluster(Option<Cluster>)
:This output contains the details for the requested cluster.
- On failure, responds with
SdkError<DescribeClusterError>
sourcepub fn describe_job_flows(&self) -> DescribeJobFlows
pub fn describe_job_flows(&self) -> DescribeJobFlows
Constructs a fluent builder for the DescribeJobFlows
operation.
- The fluent builder is configurable:
created_after(DateTime)
/set_created_after(Option<DateTime>)
:Return only job flows created after this date and time.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:Return only job flows created before this date and time.
job_flow_ids(Vec<String>)
/set_job_flow_ids(Option<Vec<String>>)
:Return only job flows whose job flow ID is contained in this list.
job_flow_states(Vec<JobFlowExecutionState>)
/set_job_flow_states(Option<Vec<JobFlowExecutionState>>)
:Return only job flows whose state is contained in this list.
- On success, responds with
DescribeJobFlowsOutput
with field(s):job_flows(Option<Vec<JobFlowDetail>>)
:A list of job flows matching the parameters supplied.
- On failure, responds with
SdkError<DescribeJobFlowsError>
sourcepub fn describe_notebook_execution(&self) -> DescribeNotebookExecution
pub fn describe_notebook_execution(&self) -> DescribeNotebookExecution
Constructs a fluent builder for the DescribeNotebookExecution
operation.
- The fluent builder is configurable:
notebook_execution_id(impl Into<String>)
/set_notebook_execution_id(Option<String>)
:The unique identifier of the notebook execution.
- On success, responds with
DescribeNotebookExecutionOutput
with field(s):notebook_execution(Option<NotebookExecution>)
:Properties of the notebook execution.
- On failure, responds with
SdkError<DescribeNotebookExecutionError>
sourcepub fn describe_release_label(&self) -> DescribeReleaseLabel
pub fn describe_release_label(&self) -> DescribeReleaseLabel
Constructs a fluent builder for the DescribeReleaseLabel
operation.
- The fluent builder is configurable:
release_label(impl Into<String>)
/set_release_label(Option<String>)
:The target release label to be described.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The pagination token. Reserved for future use. Currently set to null.
max_results(i32)
/set_max_results(Option<i32>)
:Reserved for future use. Currently set to null.
- On success, responds with
DescribeReleaseLabelOutput
with field(s):release_label(Option<String>)
:The target release label described in the response.
applications(Option<Vec<SimplifiedApplication>>)
:The list of applications available for the target release label.
Name
is the name of the application.Version
is the concise version of the application.next_token(Option<String>)
:The pagination token. Reserved for future use. Currently set to null.
available_os_releases(Option<Vec<OsRelease>>)
:The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
- On failure, responds with
SdkError<DescribeReleaseLabelError>
sourcepub fn describe_security_configuration(&self) -> DescribeSecurityConfiguration
pub fn describe_security_configuration(&self) -> DescribeSecurityConfiguration
Constructs a fluent builder for the DescribeSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the security configuration.
- On success, responds with
DescribeSecurityConfigurationOutput
with field(s):name(Option<String>)
:The name of the security configuration.
security_configuration(Option<String>)
:The security configuration details in JSON format.
creation_date_time(Option<DateTime>)
:The date and time the security configuration was created
- On failure, responds with
SdkError<DescribeSecurityConfigurationError>
sourcepub fn describe_step(&self) -> DescribeStep
pub fn describe_step(&self) -> DescribeStep
Constructs a fluent builder for the DescribeStep
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The identifier of the cluster with steps to describe.
step_id(impl Into<String>)
/set_step_id(Option<String>)
:The identifier of the step to describe.
- On success, responds with
DescribeStepOutput
with field(s):step(Option<Step>)
:The step details for the requested step identifier.
- On failure, responds with
SdkError<DescribeStepError>
sourcepub fn describe_studio(&self) -> DescribeStudio
pub fn describe_studio(&self) -> DescribeStudio
Constructs a fluent builder for the DescribeStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The Amazon EMR Studio ID.
- On success, responds with
DescribeStudioOutput
with field(s):studio(Option<Studio>)
:The Amazon EMR Studio details.
- On failure, responds with
SdkError<DescribeStudioError>
sourcepub fn get_auto_termination_policy(&self) -> GetAutoTerminationPolicy
pub fn get_auto_termination_policy(&self) -> GetAutoTerminationPolicy
Constructs a fluent builder for the GetAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
- On success, responds with
GetAutoTerminationPolicyOutput
with field(s):auto_termination_policy(Option<AutoTerminationPolicy>)
:Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
- On failure, responds with
SdkError<GetAutoTerminationPolicyError>
sourcepub fn get_block_public_access_configuration(
&self
) -> GetBlockPublicAccessConfiguration
pub fn get_block_public_access_configuration(
&self
) -> GetBlockPublicAccessConfiguration
Constructs a fluent builder for the GetBlockPublicAccessConfiguration
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetBlockPublicAccessConfigurationOutput
with field(s):block_public_access_configuration(Option<BlockPublicAccessConfiguration>)
:A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
PermittedPublicSecurityGroupRuleRanges
in theBlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
block_public_access_configuration_metadata(Option<BlockPublicAccessConfigurationMetadata>)
:Properties that describe the Amazon Web Services principal that created the
BlockPublicAccessConfiguration
using thePutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
- On failure, responds with
SdkError<GetBlockPublicAccessConfigurationError>
sourcepub fn get_managed_scaling_policy(&self) -> GetManagedScalingPolicy
pub fn get_managed_scaling_policy(&self) -> GetManagedScalingPolicy
Constructs a fluent builder for the GetManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of the cluster for which the managed scaling policy will be fetched.
- On success, responds with
GetManagedScalingPolicyOutput
with field(s):managed_scaling_policy(Option<ManagedScalingPolicy>)
:Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
- On failure, responds with
SdkError<GetManagedScalingPolicyError>
sourcepub fn get_studio_session_mapping(&self) -> GetStudioSessionMapping
pub fn get_studio_session_mapping(&self) -> GetStudioSessionMapping
Constructs a fluent builder for the GetStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:The name of the user or group to fetch. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:Specifies whether the identity to fetch is a user or a group.
- On success, responds with
GetStudioSessionMappingOutput
with field(s):session_mapping(Option<SessionMappingDetail>)
:The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
- On failure, responds with
SdkError<GetStudioSessionMappingError>
sourcepub fn list_bootstrap_actions(&self) -> ListBootstrapActions
pub fn list_bootstrap_actions(&self) -> ListBootstrapActions
Constructs a fluent builder for the ListBootstrapActions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The cluster identifier for the bootstrap actions to list.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListBootstrapActionsOutput
with field(s):bootstrap_actions(Option<Vec<Command>>)
:The bootstrap actions associated with the cluster.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListBootstrapActionsError>
sourcepub fn list_clusters(&self) -> ListClusters
pub fn list_clusters(&self) -> ListClusters
Constructs a fluent builder for the ListClusters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
created_after(DateTime)
/set_created_after(Option<DateTime>)
:The creation date and time beginning value filter for listing clusters.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:The creation date and time end value filter for listing clusters.
cluster_states(Vec<ClusterState>)
/set_cluster_states(Option<Vec<ClusterState>>)
:The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListClustersOutput
with field(s):clusters(Option<Vec<ClusterSummary>>)
:The list of clusters for the account based on the given filters.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListClustersError>
sourcepub fn list_instance_fleets(&self) -> ListInstanceFleets
pub fn list_instance_fleets(&self) -> ListInstanceFleets
Constructs a fluent builder for the ListInstanceFleets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The unique identifier of the cluster.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListInstanceFleetsOutput
with field(s):instance_fleets(Option<Vec<InstanceFleet>>)
:The list of instance fleets for the cluster and given filters.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListInstanceFleetsError>
sourcepub fn list_instance_groups(&self) -> ListInstanceGroups
pub fn list_instance_groups(&self) -> ListInstanceGroups
Constructs a fluent builder for the ListInstanceGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The identifier of the cluster for which to list the instance groups.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListInstanceGroupsOutput
with field(s):instance_groups(Option<Vec<InstanceGroup>>)
:The list of instance groups for the cluster and given filters.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListInstanceGroupsError>
sourcepub fn list_instances(&self) -> ListInstances
pub fn list_instances(&self) -> ListInstances
Constructs a fluent builder for the ListInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The identifier of the cluster for which to list the instances.
instance_group_id(impl Into<String>)
/set_instance_group_id(Option<String>)
:The identifier of the instance group for which to list the instances.
instance_group_types(Vec<InstanceGroupType>)
/set_instance_group_types(Option<Vec<InstanceGroupType>>)
:The type of instance group for which to list the instances.
instance_fleet_id(impl Into<String>)
/set_instance_fleet_id(Option<String>)
:The unique identifier of the instance fleet.
instance_fleet_type(InstanceFleetType)
/set_instance_fleet_type(Option<InstanceFleetType>)
:The node type of the instance fleet. For example MASTER, CORE, or TASK.
instance_states(Vec<InstanceState>)
/set_instance_states(Option<Vec<InstanceState>>)
:A list of instance states that will filter the instances returned with this request.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListInstancesOutput
with field(s):instances(Option<Vec<Instance>>)
:The list of instances for the cluster and given filters.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListInstancesError>
sourcepub fn list_notebook_executions(&self) -> ListNotebookExecutions
pub fn list_notebook_executions(&self) -> ListNotebookExecutions
Constructs a fluent builder for the ListNotebookExecutions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
editor_id(impl Into<String>)
/set_editor_id(Option<String>)
:The unique ID of the editor associated with the notebook execution.
status(NotebookExecutionStatus)
/set_status(Option<NotebookExecutionStatus>)
:The status filter for listing notebook executions.
-
START_PENDING
indicates that the cluster has received the execution request but execution has not begun. -
STARTING
indicates that the execution is starting on the cluster. -
RUNNING
indicates that the execution is being processed by the cluster. -
FINISHING
indicates that execution processing is in the final stages. -
FINISHED
indicates that the execution has completed without error. -
FAILING
indicates that the execution is failing and will not finish successfully. -
FAILED
indicates that the execution failed. -
STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
-
from(DateTime)
/set_from(Option<DateTime>)
:The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
to(DateTime)
/set_to(Option<DateTime>)
:The end of time range filter for listing notebook executions. The default is the current timestamp.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token, returned by a previous
ListNotebookExecutions
call, that indicates the start of the list for thisListNotebookExecutions
call.
- On success, responds with
ListNotebookExecutionsOutput
with field(s):notebook_executions(Option<Vec<NotebookExecutionSummary>>)
:A list of notebook executions.
marker(Option<String>)
:A pagination token that a subsequent
ListNotebookExecutions
can use to determine the next set of results to retrieve.
- On failure, responds with
SdkError<ListNotebookExecutionsError>
sourcepub fn list_release_labels(&self) -> ListReleaseLabels
pub fn list_release_labels(&self) -> ListReleaseLabels
Constructs a fluent builder for the ListReleaseLabels
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(ReleaseLabelFilter)
/set_filters(Option<ReleaseLabelFilter>)
:Filters the results of the request.
Prefix
specifies the prefix of release labels to return.Application
specifies the application (with/without version) of release labels to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:Specifies the next page of results. If
NextToken
is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. TheListReleaseLabels
request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if theNextToken
is expired or tampered with.max_results(i32)
/set_max_results(Option<i32>)
:Defines the maximum number of release labels to return in a single response. The default is
100
.
- On success, responds with
ListReleaseLabelsOutput
with field(s):release_labels(Option<Vec<String>>)
:The returned release labels.
next_token(Option<String>)
:Used to paginate the next page of results if specified in the next
ListReleaseLabels
request.
- On failure, responds with
SdkError<ListReleaseLabelsError>
sourcepub fn list_security_configurations(&self) -> ListSecurityConfigurations
pub fn list_security_configurations(&self) -> ListSecurityConfigurations
Constructs a fluent builder for the ListSecurityConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the set of results to retrieve.
- On success, responds with
ListSecurityConfigurationsOutput
with field(s):security_configurations(Option<Vec<SecurityConfigurationSummary>>)
:The creation date and time, and name, of each security configuration.
marker(Option<String>)
:A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
- On failure, responds with
SdkError<ListSecurityConfigurationsError>
sourcepub fn list_steps(&self) -> ListSteps
pub fn list_steps(&self) -> ListSteps
Constructs a fluent builder for the ListSteps
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The identifier of the cluster for which to list the steps.
step_states(Vec<StepState>)
/set_step_states(Option<Vec<StepState>>)
:The filter to limit the step list based on certain states.
step_ids(Vec<String>)
/set_step_ids(Option<Vec<String>>)
:The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
marker(impl Into<String>)
/set_marker(Option<String>)
:The maximum number of steps that a single
ListSteps
action returns is 50. To return a longer list of steps, use multipleListSteps
actions along with theMarker
parameter, which is a pagination token that indicates the next set of results to retrieve.
- On success, responds with
ListStepsOutput
with field(s):steps(Option<Vec<StepSummary>>)
:The filtered list of steps for the cluster.
marker(Option<String>)
:The maximum number of steps that a single
ListSteps
action returns is 50. To return a longer list of steps, use multipleListSteps
actions along with theMarker
parameter, which is a pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListStepsError>
sourcepub fn list_studios(&self) -> ListStudios
pub fn list_studios(&self) -> ListStudios
Constructs a fluent builder for the ListStudios
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the set of results to retrieve.
- On success, responds with
ListStudiosOutput
with field(s):studios(Option<Vec<StudioSummary>>)
:The list of Studio summary objects.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListStudiosError>
sourcepub fn list_studio_session_mappings(&self) -> ListStudioSessionMappings
pub fn list_studio_session_mappings(&self) -> ListStudioSessionMappings
Constructs a fluent builder for the ListStudioSessionMappings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
marker(impl Into<String>)
/set_marker(Option<String>)
:The pagination token that indicates the set of results to retrieve.
- On success, responds with
ListStudioSessionMappingsOutput
with field(s):session_mappings(Option<Vec<SessionMappingSummary>>)
:A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
marker(Option<String>)
:The pagination token that indicates the next set of results to retrieve.
- On failure, responds with
SdkError<ListStudioSessionMappingsError>
sourcepub fn modify_cluster(&self) -> ModifyCluster
pub fn modify_cluster(&self) -> ModifyCluster
Constructs a fluent builder for the ModifyCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The unique identifier of the cluster.
step_concurrency_level(i32)
/set_step_concurrency_level(Option<i32>)
:The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the
ActionOnFailure
setting may not behave as expected. For more information seeStep$ActionOnFailure
.
- On success, responds with
ModifyClusterOutput
with field(s):step_concurrency_level(Option<i32>)
:The number of steps that can be executed concurrently.
- On failure, responds with
SdkError<ModifyClusterError>
sourcepub fn modify_instance_fleet(&self) -> ModifyInstanceFleet
pub fn modify_instance_fleet(&self) -> ModifyInstanceFleet
Constructs a fluent builder for the ModifyInstanceFleet
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The unique identifier of the cluster.
instance_fleet(InstanceFleetModifyConfig)
/set_instance_fleet(Option<InstanceFleetModifyConfig>)
:The configuration parameters of the instance fleet.
- On success, responds with
ModifyInstanceFleetOutput
- On failure, responds with
SdkError<ModifyInstanceFleetError>
sourcepub fn modify_instance_groups(&self) -> ModifyInstanceGroups
pub fn modify_instance_groups(&self) -> ModifyInstanceGroups
Constructs a fluent builder for the ModifyInstanceGroups
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:The ID of the cluster to which the instance group belongs.
instance_groups(Vec<InstanceGroupModifyConfig>)
/set_instance_groups(Option<Vec<InstanceGroupModifyConfig>>)
:Instance groups to change.
- On success, responds with
ModifyInstanceGroupsOutput
- On failure, responds with
SdkError<ModifyInstanceGroupsError>
sourcepub fn put_auto_scaling_policy(&self) -> PutAutoScalingPolicy
pub fn put_auto_scaling_policy(&self) -> PutAutoScalingPolicy
Constructs a fluent builder for the PutAutoScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
instance_group_id(impl Into<String>)
/set_instance_group_id(Option<String>)
:Specifies the ID of the instance group to which the automatic scaling policy is applied.
auto_scaling_policy(AutoScalingPolicy)
/set_auto_scaling_policy(Option<AutoScalingPolicy>)
:Specifies the definition of the automatic scaling policy.
- On success, responds with
PutAutoScalingPolicyOutput
with field(s):cluster_id(Option<String>)
:Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
instance_group_id(Option<String>)
:Specifies the ID of the instance group to which the scaling policy is applied.
auto_scaling_policy(Option<AutoScalingPolicyDescription>)
:The automatic scaling policy definition.
cluster_arn(Option<String>)
:The Amazon Resource Name (ARN) of the cluster.
- On failure, responds with
SdkError<PutAutoScalingPolicyError>
sourcepub fn put_auto_termination_policy(&self) -> PutAutoTerminationPolicy
pub fn put_auto_termination_policy(&self) -> PutAutoTerminationPolicy
Constructs a fluent builder for the PutAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
auto_termination_policy(AutoTerminationPolicy)
/set_auto_termination_policy(Option<AutoTerminationPolicy>)
:Specifies the auto-termination policy to attach to the cluster.
- On success, responds with
PutAutoTerminationPolicyOutput
- On failure, responds with
SdkError<PutAutoTerminationPolicyError>
sourcepub fn put_block_public_access_configuration(
&self
) -> PutBlockPublicAccessConfiguration
pub fn put_block_public_access_configuration(
&self
) -> PutBlockPublicAccessConfiguration
Constructs a fluent builder for the PutBlockPublicAccessConfiguration
operation.
- The fluent builder is configurable:
block_public_access_configuration(BlockPublicAccessConfiguration)
/set_block_public_access_configuration(Option<BlockPublicAccessConfiguration>)
:A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
PermittedPublicSecurityGroupRuleRanges
in theBlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updatingBlockPublicSecurityGroupRules
to remove the exception.For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.
- On success, responds with
PutBlockPublicAccessConfigurationOutput
- On failure, responds with
SdkError<PutBlockPublicAccessConfigurationError>
sourcepub fn put_managed_scaling_policy(&self) -> PutManagedScalingPolicy
pub fn put_managed_scaling_policy(&self) -> PutManagedScalingPolicy
Constructs a fluent builder for the PutManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of an EMR cluster where the managed scaling policy is attached.
managed_scaling_policy(ManagedScalingPolicy)
/set_managed_scaling_policy(Option<ManagedScalingPolicy>)
:Specifies the constraints for the managed scaling policy.
- On success, responds with
PutManagedScalingPolicyOutput
- On failure, responds with
SdkError<PutManagedScalingPolicyError>
sourcepub fn remove_auto_scaling_policy(&self) -> RemoveAutoScalingPolicy
pub fn remove_auto_scaling_policy(&self) -> RemoveAutoScalingPolicy
Constructs a fluent builder for the RemoveAutoScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
instance_group_id(impl Into<String>)
/set_instance_group_id(Option<String>)
:Specifies the ID of the instance group to which the scaling policy is applied.
- On success, responds with
RemoveAutoScalingPolicyOutput
- On failure, responds with
SdkError<RemoveAutoScalingPolicyError>
sourcepub fn remove_auto_termination_policy(&self) -> RemoveAutoTerminationPolicy
pub fn remove_auto_termination_policy(&self) -> RemoveAutoTerminationPolicy
Constructs a fluent builder for the RemoveAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.
- On success, responds with
RemoveAutoTerminationPolicyOutput
- On failure, responds with
SdkError<RemoveAutoTerminationPolicyError>
sourcepub fn remove_managed_scaling_policy(&self) -> RemoveManagedScalingPolicy
pub fn remove_managed_scaling_policy(&self) -> RemoveManagedScalingPolicy
Constructs a fluent builder for the RemoveManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:Specifies the ID of the cluster from which the managed scaling policy will be removed.
- On success, responds with
RemoveManagedScalingPolicyOutput
- On failure, responds with
SdkError<RemoveManagedScalingPolicyError>
Constructs a fluent builder for the RemoveTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of tag keys to remove from the resource.
- On success, responds with
RemoveTagsOutput
- On failure, responds with
SdkError<RemoveTagsError>
sourcepub fn run_job_flow(&self) -> RunJobFlow
pub fn run_job_flow(&self) -> RunJobFlow
Constructs a fluent builder for the RunJobFlow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the job flow.
log_uri(impl Into<String>)
/set_log_uri(Option<String>)
:The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
log_encryption_kms_key_id(impl Into<String>)
/set_log_encryption_kms_key_id(Option<String>)
:The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.
additional_info(impl Into<String>)
/set_additional_info(Option<String>)
:A JSON string for selecting additional features.
ami_version(impl Into<String>)
/set_ami_version(Option<String>)
:Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
ReleaseLabel
is used. To specify a custom AMI, useCustomAmiID
.release_label(impl Into<String>)
/set_release_label(Option<String>)
:The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form
emr-x.x.x
, where x.x.x is an Amazon EMR release version such asemr-5.14.0
. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions useAmiVersion
.instances(JobFlowInstancesConfig)
/set_instances(Option<JobFlowInstancesConfig>)
:A specification of the number and type of Amazon EC2 instances.
steps(Vec<StepConfig>)
/set_steps(Option<Vec<StepConfig>>)
:A list of steps to run.
bootstrap_actions(Vec<BootstrapActionConfig>)
/set_bootstrap_actions(Option<Vec<BootstrapActionConfig>>)
:A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
supported_products(Vec<String>)
/set_supported_products(Option<Vec<String>>)
:For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:
-
“mapr-m3” - launch the job flow using MapR M3 Edition.
-
“mapr-m5” - launch the job flow using MapR M5 Edition.
-
new_supported_products(Vec<SupportedProductConfig>)
/set_new_supported_products(Option<Vec<SupportedProductConfig>>)
:For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see “Launch a Job Flow on the MapR Distribution for Hadoop” in the Amazon EMR Developer Guide. Supported values are:
-
“mapr-m3” - launch the cluster using MapR M3 Edition.
-
“mapr-m5” - launch the cluster using MapR M5 Edition.
-
“mapr” with the user arguments specifying “–edition,m3” or “–edition,m5” - launch the job flow using MapR M3 or M5 Edition respectively.
-
“mapr-m7” - launch the cluster using MapR M7 Edition.
-
“hunk” - launch the cluster with the Hunk Big Data Analytics Platform.
-
“hue”- launch the cluster with Hue installed.
-
“spark” - launch the cluster with Apache Spark installed.
-
“ganglia” - launch the cluster with the Ganglia Monitoring System installed.
-
applications(Vec<Application>)
/set_applications(Option<Vec<Application>>)
:Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.
configurations(Vec<Configuration>)
/set_configurations(Option<Vec<Configuration>>)
:For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
visible_to_all_users(bool)
/set_visible_to_all_users(bool)
:The VisibleToAllUsers parameter is no longer supported. By default, the value is set to
true
. Setting it tofalse
now has no effect.Set this value to
true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults totrue
for clusters created using the EMR API or the CLI create-cluster command.When set to
false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.job_flow_role(impl Into<String>)
/set_job_flow_role(Option<String>)
:Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is
EMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.service_role(impl Into<String>)
/set_service_role(Option<String>)
:The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:The name of a security configuration to apply to the cluster.
auto_scaling_role(impl Into<String>)
/set_auto_scaling_role(Option<String>)
:An IAM role for automatic scaling policies. The default role is
EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.scale_down_behavior(ScaleDownBehavior)
/set_scale_down_behavior(Option<ScaleDownBehavior>)
:Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.custom_ami_id(impl Into<String>)
/set_custom_ami_id(Option<String>)
:Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the
ReleaseLabel
specified. For Amazon EMR versions 2.x and 3.x, useAmiVersion
instead.For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
ebs_root_volume_size(i32)
/set_ebs_root_volume_size(Option<i32>)
:The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
repo_upgrade_on_boot(RepoUpgradeOnBoot)
/set_repo_upgrade_on_boot(Option<RepoUpgradeOnBoot>)
:Applies only when
CustomAmiID
is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default isSECURITY
, which indicates that only security updates are applied. IfNONE
is specified, no updates are applied, and all updates must be applied manually.kerberos_attributes(KerberosAttributes)
/set_kerberos_attributes(Option<KerberosAttributes>)
:Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
step_concurrency_level(i32)
/set_step_concurrency_level(Option<i32>)
:Specifies the number of steps that can be executed concurrently. The default value is
1
. The maximum value is256
.managed_scaling_policy(ManagedScalingPolicy)
/set_managed_scaling_policy(Option<ManagedScalingPolicy>)
:The specified managed scaling policy for an Amazon EMR cluster.
placement_group_configs(Vec<PlacementGroupConfig>)
/set_placement_group_configs(Option<Vec<PlacementGroupConfig>>)
:The specified placement group configuration for an Amazon EMR cluster.
auto_termination_policy(AutoTerminationPolicy)
/set_auto_termination_policy(Option<AutoTerminationPolicy>)
:An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
os_release_label(impl Into<String>)
/set_os_release_label(Option<String>)
:Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
- On success, responds with
RunJobFlowOutput
with field(s):job_flow_id(Option<String>)
:A unique identifier for the job flow.
cluster_arn(Option<String>)
:The Amazon Resource Name (ARN) of the cluster.
- On failure, responds with
SdkError<RunJobFlowError>
sourcepub fn set_termination_protection(&self) -> SetTerminationProtection
pub fn set_termination_protection(&self) -> SetTerminationProtection
Constructs a fluent builder for the SetTerminationProtection
operation.
- The fluent builder is configurable:
job_flow_ids(Vec<String>)
/set_job_flow_ids(Option<Vec<String>>)
:A list of strings that uniquely identify the clusters to protect. This identifier is returned by
RunJobFlow
and can also be obtained fromDescribeJobFlows
.termination_protected(bool)
/set_termination_protected(bool)
:A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
- On success, responds with
SetTerminationProtectionOutput
- On failure, responds with
SdkError<SetTerminationProtectionError>
sourcepub fn set_visible_to_all_users(&self) -> SetVisibleToAllUsers
pub fn set_visible_to_all_users(&self) -> SetVisibleToAllUsers
Constructs a fluent builder for the SetVisibleToAllUsers
operation.
- The fluent builder is configurable:
job_flow_ids(Vec<String>)
/set_job_flow_ids(Option<Vec<String>>)
:The unique identifier of the job flow (cluster).
visible_to_all_users(bool)
/set_visible_to_all_users(bool)
:A value of
true
indicates that an IAM principal in the Amazon Web Services account can perform EMR actions on the cluster that the IAM policies attached to the principal allow. A value offalse
indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform EMR actions on the cluster.
- On success, responds with
SetVisibleToAllUsersOutput
- On failure, responds with
SdkError<SetVisibleToAllUsersError>
sourcepub fn start_notebook_execution(&self) -> StartNotebookExecution
pub fn start_notebook_execution(&self) -> StartNotebookExecution
Constructs a fluent builder for the StartNotebookExecution
operation.
- The fluent builder is configurable:
editor_id(impl Into<String>)
/set_editor_id(Option<String>)
:The unique identifier of the EMR Notebook to use for notebook execution.
relative_path(impl Into<String>)
/set_relative_path(Option<String>)
:The path and file name of the notebook file for this execution, relative to the path specified for the EMR Notebook. For example, if you specify a path of
s3://MyBucket/MyNotebooks
when you create an EMR Notebook for a notebook with an ID ofe-ABCDEFGHIJK1234567890ABCD
(theEditorID
of this request), and you specify aRelativePath
ofmy_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution iss3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.notebook_execution_name(impl Into<String>)
/set_notebook_execution_name(Option<String>)
:An optional name for the notebook execution.
notebook_params(impl Into<String>)
/set_notebook_params(Option<String>)
:Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
execution_engine(ExecutionEngineConfig)
/set_execution_engine(Option<ExecutionEngineConfig>)
:Specifies the execution engine (cluster) that runs the notebook execution.
service_role(impl Into<String>)
/set_service_role(Option<String>)
:The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook execution.
notebook_instance_security_group_id(impl Into<String>)
/set_notebook_instance_security_group_id(Option<String>)
:The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook execution.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
- On success, responds with
StartNotebookExecutionOutput
with field(s):notebook_execution_id(Option<String>)
:The unique identifier of the notebook execution.
- On failure, responds with
SdkError<StartNotebookExecutionError>
sourcepub fn stop_notebook_execution(&self) -> StopNotebookExecution
pub fn stop_notebook_execution(&self) -> StopNotebookExecution
Constructs a fluent builder for the StopNotebookExecution
operation.
- The fluent builder is configurable:
notebook_execution_id(impl Into<String>)
/set_notebook_execution_id(Option<String>)
:The unique identifier of the notebook execution.
- On success, responds with
StopNotebookExecutionOutput
- On failure, responds with
SdkError<StopNotebookExecutionError>
sourcepub fn terminate_job_flows(&self) -> TerminateJobFlows
pub fn terminate_job_flows(&self) -> TerminateJobFlows
Constructs a fluent builder for the TerminateJobFlows
operation.
- The fluent builder is configurable:
job_flow_ids(Vec<String>)
/set_job_flow_ids(Option<Vec<String>>)
:A list of job flows to be shut down.
- On success, responds with
TerminateJobFlowsOutput
- On failure, responds with
SdkError<TerminateJobFlowsError>
sourcepub fn update_studio(&self) -> UpdateStudio
pub fn update_studio(&self) -> UpdateStudio
Constructs a fluent builder for the UpdateStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio to update.
name(impl Into<String>)
/set_name(Option<String>)
:A descriptive name for the Amazon EMR Studio.
description(impl Into<String>)
/set_description(Option<String>)
:A detailed description to assign to the Amazon EMR Studio.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
default_s3_location(impl Into<String>)
/set_default_s3_location(Option<String>)
:The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
- On success, responds with
UpdateStudioOutput
- On failure, responds with
SdkError<UpdateStudioError>
sourcepub fn update_studio_session_mapping(&self) -> UpdateStudioSessionMapping
pub fn update_studio_session_mapping(&self) -> UpdateStudioSessionMapping
Constructs a fluent builder for the UpdateStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:The ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:The name of the user or group to update. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:Specifies whether the identity to update is a user or a group.
session_policy_arn(impl Into<String>)
/set_session_policy_arn(Option<String>)
:The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
- On success, responds with
UpdateStudioSessionMappingOutput
- On failure, responds with
SdkError<UpdateStudioSessionMappingError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Selfwhere
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Selfwhere
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.