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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_emr::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_emr::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AddInstanceFleet
operation has
a Client::add_instance_fleet
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.add_instance_fleet()
.cluster_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn add_instance_fleet(&self) -> AddInstanceFleetFluentBuilder
pub fn add_instance_fleet(&self) -> AddInstanceFleetFluentBuilder
Constructs a fluent builder for the AddInstanceFleet
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe unique identifier of the cluster.
instance_fleet(InstanceFleetConfig)
/set_instance_fleet(Option<InstanceFleetConfig>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn add_instance_groups(&self) -> AddInstanceGroupsFluentBuilder
pub fn add_instance_groups(&self) -> AddInstanceGroupsFluentBuilder
Constructs a fluent builder for the AddInstanceGroups
operation.
- The fluent builder is configurable:
instance_groups(InstanceGroupConfig)
/set_instance_groups(Option<Vec::<InstanceGroupConfig>>)
:
required: trueInstance groups to add.
job_flow_id(impl Into<String>)
/set_job_flow_id(Option<String>)
:
required: trueJob 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>
Source§impl Client
impl Client
Sourcepub fn add_job_flow_steps(&self) -> AddJobFlowStepsFluentBuilder
pub fn add_job_flow_steps(&self) -> AddJobFlowStepsFluentBuilder
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>)
:
required: trueA string that uniquely identifies the job flow. This identifier is returned by
RunJobFlow
and can also be obtained fromListClusters
.steps(StepConfig)
/set_steps(Option<Vec::<StepConfig>>)
:
required: trueA list of
StepConfig
to be executed by the job flow.execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Constructs a fluent builder for the AddTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA 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>
Source§impl Client
impl Client
Sourcepub fn cancel_steps(&self) -> CancelStepsFluentBuilder
pub fn cancel_steps(&self) -> CancelStepsFluentBuilder
Constructs a fluent builder for the CancelSteps
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe
ClusterID
for the specified steps that will be canceled. UseRunJobFlow
andListClusters
to get ClusterIDs.step_ids(impl Into<String>)
/set_step_ids(Option<Vec::<String>>)
:
required: trueThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_persistent_app_ui(&self) -> CreatePersistentAppUIFluentBuilder
pub fn create_persistent_app_ui(&self) -> CreatePersistentAppUIFluentBuilder
Constructs a fluent builder for the CreatePersistentAppUI
operation.
- The fluent builder is configurable:
target_resource_arn(impl Into<String>)
/set_target_resource_arn(Option<String>)
:
required: trueThe unique Amazon Resource Name (ARN) of the target resource.
emr_containers_config(EmrContainersConfig)
/set_emr_containers_config(Option<EmrContainersConfig>)
:
required: falseThe EMR containers configuration.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseTags for the persistent application user interface.
x_referer(impl Into<String>)
/set_x_referer(Option<String>)
:
required: falseThe cross reference for the persistent application user interface.
profiler_type(ProfilerType)
/set_profiler_type(Option<ProfilerType>)
:
required: falseThe profiler type for the persistent application user interface. Valid values are SHS, TEZUI, or YTS.
- On success, responds with
CreatePersistentAppUiOutput
with field(s):persistent_app_ui_id(Option<String>)
:The persistent application user interface identifier.
runtime_role_enabled_cluster(Option<bool>)
:Represents if the EMR on EC2 cluster that the persisent application user interface is created for is a runtime role enabled cluster or not.
- On failure, responds with
SdkError<CreatePersistentAppUIError>
Source§impl Client
impl Client
Sourcepub fn create_security_configuration(
&self,
) -> CreateSecurityConfigurationFluentBuilder
pub fn create_security_configuration( &self, ) -> CreateSecurityConfigurationFluentBuilder
Constructs a fluent builder for the CreateSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the security configuration.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn create_studio(&self) -> CreateStudioFluentBuilder
pub fn create_studio(&self) -> CreateStudioFluentBuilder
Constructs a fluent builder for the CreateStudio
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA descriptive name for the Amazon EMR Studio.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA detailed description of the Amazon EMR Studio.
auth_mode(AuthMode)
/set_auth_mode(Option<AuthMode>)
:
required: trueSpecifies whether the Studio authenticates users using IAM or IAM Identity Center.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:
required: trueThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueA 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>)
:
required: trueThe 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>)
:
required: falseThe IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a
UserRole
when you use IAM Identity Center 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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: falseThe 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>)
:
required: falseThe 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA 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.
trusted_identity_propagation_enabled(bool)
/set_trusted_identity_propagation_enabled(Option<bool>)
:
required: falseA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is
false
.idc_user_assignment(IdcUserAssignment)
/set_idc_user_assignment(Option<IdcUserAssignment>)
:
required: falseSpecifies whether IAM Identity Center user assignment is
REQUIRED
orOPTIONAL
. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.idc_instance_arn(impl Into<String>)
/set_idc_instance_arn(Option<String>)
:
required: falseThe ARN of the IAM Identity Center instance to create the Studio application.
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- 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>
Source§impl Client
impl Client
Sourcepub fn create_studio_session_mapping(
&self,
) -> CreateStudioSessionMappingFluentBuilder
pub fn create_studio_session_mapping( &self, ) -> CreateStudioSessionMappingFluentBuilder
Constructs a fluent builder for the CreateStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe 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>)
:
required: falseThe globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified, but not both.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:
required: falseThe name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified, but not both.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: trueSpecifies 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>)
:
required: trueThe 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 Amazon EMR Studio User Role with Session Policies.
- On success, responds with
CreateStudioSessionMappingOutput
- On failure, responds with
SdkError<CreateStudioSessionMappingError>
Source§impl Client
impl Client
Sourcepub fn delete_security_configuration(
&self,
) -> DeleteSecurityConfigurationFluentBuilder
pub fn delete_security_configuration( &self, ) -> DeleteSecurityConfigurationFluentBuilder
Constructs a fluent builder for the DeleteSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the security configuration.
- On success, responds with
DeleteSecurityConfigurationOutput
- On failure, responds with
SdkError<DeleteSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_studio(&self) -> DeleteStudioFluentBuilder
pub fn delete_studio(&self) -> DeleteStudioFluentBuilder
Constructs a fluent builder for the DeleteStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe ID of the Amazon EMR Studio.
- On success, responds with
DeleteStudioOutput
- On failure, responds with
SdkError<DeleteStudioError>
Source§impl Client
impl Client
Sourcepub fn delete_studio_session_mapping(
&self,
) -> DeleteStudioSessionMappingFluentBuilder
pub fn delete_studio_session_mapping( &self, ) -> DeleteStudioSessionMappingFluentBuilder
Constructs a fluent builder for the DeleteStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:
required: falseThe 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 IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:
required: falseThe name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
Constructs a fluent builder for the DescribeCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_job_flows(&self) -> DescribeJobFlowsFluentBuilder
👎Deprecated
pub fn describe_job_flows(&self) -> DescribeJobFlowsFluentBuilder
Constructs a fluent builder for the DescribeJobFlows
operation.
- The fluent builder is configurable:
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseReturn only job flows created after this date and time.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseReturn only job flows created before this date and time.
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: falseReturn only job flows whose job flow ID is contained in this list.
job_flow_states(JobFlowExecutionState)
/set_job_flow_states(Option<Vec::<JobFlowExecutionState>>)
:
required: falseReturn 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>
Source§impl Client
impl Client
Sourcepub fn describe_notebook_execution(
&self,
) -> DescribeNotebookExecutionFluentBuilder
pub fn describe_notebook_execution( &self, ) -> DescribeNotebookExecutionFluentBuilder
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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_persistent_app_ui(&self) -> DescribePersistentAppUIFluentBuilder
pub fn describe_persistent_app_ui(&self) -> DescribePersistentAppUIFluentBuilder
Constructs a fluent builder for the DescribePersistentAppUI
operation.
- The fluent builder is configurable:
persistent_app_ui_id(impl Into<String>)
/set_persistent_app_ui_id(Option<String>)
:
required: trueThe identifier for the persistent application user interface.
- On success, responds with
DescribePersistentAppUiOutput
with field(s):persistent_app_ui(Option<PersistentAppUi>)
:The persistent application user interface.
- On failure, responds with
SdkError<DescribePersistentAppUIError>
Source§impl Client
impl Client
Sourcepub fn describe_release_label(&self) -> DescribeReleaseLabelFluentBuilder
pub fn describe_release_label(&self) -> DescribeReleaseLabelFluentBuilder
Constructs a fluent builder for the DescribeReleaseLabel
operation.
- The fluent builder is configurable:
release_label(impl Into<String>)
/set_release_label(Option<String>)
:
required: falseThe target release label to be described.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token. Reserved for future use. Currently set to null.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseReserved 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>
Source§impl Client
impl Client
Sourcepub fn describe_security_configuration(
&self,
) -> DescribeSecurityConfigurationFluentBuilder
pub fn describe_security_configuration( &self, ) -> DescribeSecurityConfigurationFluentBuilder
Constructs a fluent builder for the DescribeSecurityConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_step(&self) -> DescribeStepFluentBuilder
pub fn describe_step(&self) -> DescribeStepFluentBuilder
Constructs a fluent builder for the DescribeStep
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe identifier of the cluster with steps to describe.
step_id(impl Into<String>)
/set_step_id(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_studio(&self) -> DescribeStudioFluentBuilder
pub fn describe_studio(&self) -> DescribeStudioFluentBuilder
Constructs a fluent builder for the DescribeStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_auto_termination_policy(
&self,
) -> GetAutoTerminationPolicyFluentBuilder
pub fn get_auto_termination_policy( &self, ) -> GetAutoTerminationPolicyFluentBuilder
Constructs a fluent builder for the GetAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn get_block_public_access_configuration(
&self,
) -> GetBlockPublicAccessConfigurationFluentBuilder
pub fn get_block_public_access_configuration( &self, ) -> GetBlockPublicAccessConfigurationFluentBuilder
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 Amazon 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>
Source§impl Client
impl Client
Sourcepub fn get_cluster_session_credentials(
&self,
) -> GetClusterSessionCredentialsFluentBuilder
pub fn get_cluster_session_credentials( &self, ) -> GetClusterSessionCredentialsFluentBuilder
Constructs a fluent builder for the GetClusterSessionCredentials
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe unique identifier of the cluster.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the runtime role for interactive workload submission 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
.
- On success, responds with
GetClusterSessionCredentialsOutput
with field(s):credentials(Option<Credentials>)
:The credentials that you can use to connect to cluster endpoints that support username and password authentication.
expires_at(Option<DateTime>)
:The time when the credentials that are returned by the
GetClusterSessionCredentials
API expire.
- On failure, responds with
SdkError<GetClusterSessionCredentialsError>
Source§impl Client
impl Client
Sourcepub fn get_managed_scaling_policy(&self) -> GetManagedScalingPolicyFluentBuilder
pub fn get_managed_scaling_policy(&self) -> GetManagedScalingPolicyFluentBuilder
Constructs a fluent builder for the GetManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn get_on_cluster_app_ui_presigned_url(
&self,
) -> GetOnClusterAppUIPresignedURLFluentBuilder
pub fn get_on_cluster_app_ui_presigned_url( &self, ) -> GetOnClusterAppUIPresignedURLFluentBuilder
Constructs a fluent builder for the GetOnClusterAppUIPresignedURL
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe cluster ID associated with the cluster’s application user interface presigned URL.
on_cluster_app_ui_type(OnClusterAppUiType)
/set_on_cluster_app_ui_type(Option<OnClusterAppUiType>)
:
required: falseThe application UI type associated with the cluster’s application user interface presigned URL.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: falseThe application ID associated with the cluster’s application user interface presigned URL.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseDetermines if the user interface presigned URL is for a dry run.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe execution role ARN associated with the cluster’s application user interface presigned URL.
- On success, responds with
GetOnClusterAppUiPresignedUrlOutput
with field(s):presigned_url_ready(Option<bool>)
:Used to determine if the presigned URL is ready.
presigned_url(Option<String>)
:The cluster’s generated presigned URL.
- On failure, responds with
SdkError<GetOnClusterAppUIPresignedURLError>
Source§impl Client
impl Client
Sourcepub fn get_persistent_app_ui_presigned_url(
&self,
) -> GetPersistentAppUIPresignedURLFluentBuilder
pub fn get_persistent_app_ui_presigned_url( &self, ) -> GetPersistentAppUIPresignedURLFluentBuilder
Constructs a fluent builder for the GetPersistentAppUIPresignedURL
operation.
- The fluent builder is configurable:
persistent_app_ui_id(impl Into<String>)
/set_persistent_app_ui_id(Option<String>)
:
required: trueThe persistent application user interface ID associated with the presigned URL.
persistent_app_ui_type(PersistentAppUiType)
/set_persistent_app_ui_type(Option<PersistentAppUiType>)
:
required: falseThe persistent application user interface type associated with the presigned URL.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: falseThe application ID associated with the presigned URL.
auth_proxy_call(bool)
/set_auth_proxy_call(Option<bool>)
:
required: falseA boolean that represents if the caller is an authentication proxy call.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe execution role ARN associated with the presigned URL.
- On success, responds with
GetPersistentAppUiPresignedUrlOutput
with field(s):presigned_url_ready(Option<bool>)
:Used to determine if the presigned URL is ready.
presigned_url(Option<String>)
:The returned presigned URL.
- On failure, responds with
SdkError<GetPersistentAppUIPresignedURLError>
Source§impl Client
impl Client
Sourcepub fn get_studio_session_mapping(&self) -> GetStudioSessionMappingFluentBuilder
pub fn get_studio_session_mapping(&self) -> GetStudioSessionMappingFluentBuilder
Constructs a fluent builder for the GetStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:
required: falseThe globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:
required: falseThe name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn list_bootstrap_actions(&self) -> ListBootstrapActionsFluentBuilder
pub fn list_bootstrap_actions(&self) -> ListBootstrapActionsFluentBuilder
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>)
:
required: trueThe cluster identifier for the bootstrap actions to list.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_clusters(&self) -> ListClustersFluentBuilder
pub fn list_clusters(&self) -> ListClustersFluentBuilder
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>)
:
required: falseThe creation date and time beginning value filter for listing clusters.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe creation date and time end value filter for listing clusters.
cluster_states(ClusterState)
/set_cluster_states(Option<Vec::<ClusterState>>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_instance_fleets(&self) -> ListInstanceFleetsFluentBuilder
pub fn list_instance_fleets(&self) -> ListInstanceFleetsFluentBuilder
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>)
:
required: trueThe unique identifier of the cluster.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_instance_groups(&self) -> ListInstanceGroupsFluentBuilder
pub fn list_instance_groups(&self) -> ListInstanceGroupsFluentBuilder
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>)
:
required: trueThe identifier of the cluster for which to list the instance groups.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_instances(&self) -> ListInstancesFluentBuilder
pub fn list_instances(&self) -> ListInstancesFluentBuilder
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>)
:
required: trueThe identifier of the cluster for which to list the instances.
instance_group_id(impl Into<String>)
/set_instance_group_id(Option<String>)
:
required: falseThe identifier of the instance group for which to list the instances.
instance_group_types(InstanceGroupType)
/set_instance_group_types(Option<Vec::<InstanceGroupType>>)
:
required: falseThe type of instance group for which to list the instances.
instance_fleet_id(impl Into<String>)
/set_instance_fleet_id(Option<String>)
:
required: falseThe unique identifier of the instance fleet.
instance_fleet_type(InstanceFleetType)
/set_instance_fleet_type(Option<InstanceFleetType>)
:
required: falseThe node type of the instance fleet. For example MASTER, CORE, or TASK.
instance_states(InstanceState)
/set_instance_states(Option<Vec::<InstanceState>>)
:
required: falseA list of instance states that will filter the instances returned with this request.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_notebook_executions(&self) -> ListNotebookExecutionsFluentBuilder
pub fn list_notebook_executions(&self) -> ListNotebookExecutionsFluentBuilder
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>)
:
required: falseThe unique ID of the editor associated with the notebook execution.
status(NotebookExecutionStatus)
/set_status(Option<NotebookExecutionStatus>)
:
required: falseThe 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>)
:
required: falseThe beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
to(DateTime)
/set_to(Option<DateTime>)
:
required: falseThe end of time range filter for listing notebook executions. The default is the current timestamp.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe pagination token, returned by a previous
ListNotebookExecutions
call, that indicates the start of the list for thisListNotebookExecutions
call.execution_engine_id(impl Into<String>)
/set_execution_engine_id(Option<String>)
:
required: falseThe unique ID of the execution engine.
- 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>
Source§impl Client
impl Client
Sourcepub fn list_release_labels(&self) -> ListReleaseLabelsFluentBuilder
pub fn list_release_labels(&self) -> ListReleaseLabelsFluentBuilder
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>)
:
required: falseFilters 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>)
:
required: falseSpecifies 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>)
:
required: falseDefines 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>
Source§impl Client
impl Client
Sourcepub fn list_security_configurations(
&self,
) -> ListSecurityConfigurationsFluentBuilder
pub fn list_security_configurations( &self, ) -> ListSecurityConfigurationsFluentBuilder
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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_steps(&self) -> ListStepsFluentBuilder
pub fn list_steps(&self) -> ListStepsFluentBuilder
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>)
:
required: trueThe identifier of the cluster for which to list the steps.
step_states(StepState)
/set_step_states(Option<Vec::<StepState>>)
:
required: falseThe filter to limit the step list based on certain states.
step_ids(impl Into<String>)
/set_step_ids(Option<Vec::<String>>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_studio_session_mappings(
&self,
) -> ListStudioSessionMappingsFluentBuilder
pub fn list_studio_session_mappings( &self, ) -> ListStudioSessionMappingsFluentBuilder
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>)
:
required: falseThe ID of the Amazon EMR Studio.
identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: falseSpecifies 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_studios(&self) -> ListStudiosFluentBuilder
pub fn list_studios(&self) -> ListStudiosFluentBuilder
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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_supported_instance_types(
&self,
) -> ListSupportedInstanceTypesFluentBuilder
pub fn list_supported_instance_types( &self, ) -> ListSupportedInstanceTypesFluentBuilder
Constructs a fluent builder for the ListSupportedInstanceTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
release_label(impl Into<String>)
/set_release_label(Option<String>)
:
required: trueThe Amazon EMR release label determines the versions of open-source application packages that Amazon EMR has installed on the cluster. Release labels are in the format
emr-x.x.x
, where x.x.x is an Amazon EMR release number such asemr-6.10.0
. For more information about Amazon EMR releases and their included application versions and features, see the Amazon EMR Release Guide .marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe pagination token that marks the next set of results to retrieve.
- On success, responds with
ListSupportedInstanceTypesOutput
with field(s):supported_instance_types(Option<Vec::<SupportedInstanceType>>)
:The list of instance types that the release specified in
ListSupportedInstanceTypesInput$ReleaseLabel
supports, filtered by Amazon Web Services Region.marker(Option<String>)
:The pagination token that marks the next set of results to retrieve.
- On failure, responds with
SdkError<ListSupportedInstanceTypesError>
Source§impl Client
impl Client
Sourcepub fn modify_cluster(&self) -> ModifyClusterFluentBuilder
pub fn modify_cluster(&self) -> ModifyClusterFluentBuilder
Constructs a fluent builder for the ModifyCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe unique identifier of the cluster.
step_concurrency_level(i32)
/set_step_concurrency_level(Option<i32>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn modify_instance_fleet(&self) -> ModifyInstanceFleetFluentBuilder
pub fn modify_instance_fleet(&self) -> ModifyInstanceFleetFluentBuilder
Constructs a fluent builder for the ModifyInstanceFleet
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe unique identifier of the cluster.
instance_fleet(InstanceFleetModifyConfig)
/set_instance_fleet(Option<InstanceFleetModifyConfig>)
:
required: trueThe configuration parameters of the instance fleet.
- On success, responds with
ModifyInstanceFleetOutput
- On failure, responds with
SdkError<ModifyInstanceFleetError>
Source§impl Client
impl Client
Sourcepub fn modify_instance_groups(&self) -> ModifyInstanceGroupsFluentBuilder
pub fn modify_instance_groups(&self) -> ModifyInstanceGroupsFluentBuilder
Constructs a fluent builder for the ModifyInstanceGroups
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: falseThe ID of the cluster to which the instance group belongs.
instance_groups(InstanceGroupModifyConfig)
/set_instance_groups(Option<Vec::<InstanceGroupModifyConfig>>)
:
required: falseInstance groups to change.
- On success, responds with
ModifyInstanceGroupsOutput
- On failure, responds with
SdkError<ModifyInstanceGroupsError>
Source§impl Client
impl Client
Sourcepub fn put_auto_scaling_policy(&self) -> PutAutoScalingPolicyFluentBuilder
pub fn put_auto_scaling_policy(&self) -> PutAutoScalingPolicyFluentBuilder
Constructs a fluent builder for the PutAutoScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>)
:
required: trueSpecifies the ID of the instance group to which the automatic scaling policy is applied.
auto_scaling_policy(AutoScalingPolicy)
/set_auto_scaling_policy(Option<AutoScalingPolicy>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn put_auto_termination_policy(
&self,
) -> PutAutoTerminationPolicyFluentBuilder
pub fn put_auto_termination_policy( &self, ) -> PutAutoTerminationPolicyFluentBuilder
Constructs a fluent builder for the PutAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>)
:
required: falseSpecifies the auto-termination policy to attach to the cluster.
- On success, responds with
PutAutoTerminationPolicyOutput
- On failure, responds with
SdkError<PutAutoTerminationPolicyError>
Source§impl Client
impl Client
Sourcepub fn put_block_public_access_configuration(
&self,
) -> PutBlockPublicAccessConfigurationFluentBuilder
pub fn put_block_public_access_configuration( &self, ) -> PutBlockPublicAccessConfigurationFluentBuilder
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>)
:
required: trueA 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 Amazon 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>
Source§impl Client
impl Client
Sourcepub fn put_managed_scaling_policy(&self) -> PutManagedScalingPolicyFluentBuilder
pub fn put_managed_scaling_policy(&self) -> PutManagedScalingPolicyFluentBuilder
Constructs a fluent builder for the PutManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies the ID of an Amazon EMR cluster where the managed scaling policy is attached.
managed_scaling_policy(ManagedScalingPolicy)
/set_managed_scaling_policy(Option<ManagedScalingPolicy>)
:
required: trueSpecifies the constraints for the managed scaling policy.
- On success, responds with
PutManagedScalingPolicyOutput
- On failure, responds with
SdkError<PutManagedScalingPolicyError>
Source§impl Client
impl Client
Sourcepub fn remove_auto_scaling_policy(&self) -> RemoveAutoScalingPolicyFluentBuilder
pub fn remove_auto_scaling_policy(&self) -> RemoveAutoScalingPolicyFluentBuilder
Constructs a fluent builder for the RemoveAutoScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>)
:
required: trueSpecifies the ID of the instance group to which the scaling policy is applied.
- On success, responds with
RemoveAutoScalingPolicyOutput
- On failure, responds with
SdkError<RemoveAutoScalingPolicyError>
Source§impl Client
impl Client
Sourcepub fn remove_auto_termination_policy(
&self,
) -> RemoveAutoTerminationPolicyFluentBuilder
pub fn remove_auto_termination_policy( &self, ) -> RemoveAutoTerminationPolicyFluentBuilder
Constructs a fluent builder for the RemoveAutoTerminationPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Sourcepub fn remove_managed_scaling_policy(
&self,
) -> RemoveManagedScalingPolicyFluentBuilder
pub fn remove_managed_scaling_policy( &self, ) -> RemoveManagedScalingPolicyFluentBuilder
Constructs a fluent builder for the RemoveManagedScalingPolicy
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueSpecifies 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>
Source§impl Client
impl Client
Constructs a fluent builder for the RemoveTags
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of tag keys to remove from the resource.
- On success, responds with
RemoveTagsOutput
- On failure, responds with
SdkError<RemoveTagsError>
Source§impl Client
impl Client
Sourcepub fn run_job_flow(&self) -> RunJobFlowFluentBuilder
pub fn run_job_flow(&self) -> RunJobFlowFluentBuilder
Constructs a fluent builder for the RunJobFlow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the job flow.
log_uri(impl Into<String>)
/set_log_uri(Option<String>)
:
required: falseThe 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>)
:
required: falseThe 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 releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
additional_info(impl Into<String>)
/set_additional_info(Option<String>)
:
required: falseA JSON string for selecting additional features.
ami_version(impl Into<String>)
/set_ami_version(Option<String>)
:
required: falseApplies 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>)
:
required: falseThe 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>)
:
required: trueA specification of the number and type of Amazon EC2 instances.
steps(StepConfig)
/set_steps(Option<Vec::<StepConfig>>)
:
required: falseA list of steps to run.
bootstrap_actions(BootstrapActionConfig)
/set_bootstrap_actions(Option<Vec::<BootstrapActionConfig>>)
:
required: falseA list of bootstrap actions to run before Hadoop starts on the cluster nodes.
supported_products(impl Into<String>)
/set_supported_products(Option<Vec::<String>>)
:
required: falseFor 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(SupportedProductConfig)
/set_new_supported_products(Option<Vec::<SupportedProductConfig>>)
:
required: falseFor 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. Amazon 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(Application)
/set_applications(Option<Vec::<Application>>)
:
required: falseApplies 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(Configuration)
/set_configurations(Option<Vec::<Configuration>>)
:
required: falseFor Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
visible_to_all_users(bool)
/set_visible_to_all_users(Option<bool>)
:
required: falseThe 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 Amazon EMR actions on the cluster that their IAM policies allow. This value defaults totrue
for clusters created using the Amazon 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 Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.job_flow_role(impl Into<String>)
/set_job_flow_role(Option<String>)
:
required: falseAlso called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon 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>)
:
required: falseThe IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you’ve created a custom service role path, you must specify it for the service role when you launch your cluster.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of tags to associate with a cluster and propagate to Amazon EC2 instances.
security_configuration(impl Into<String>)
/set_security_configuration(Option<String>)
:
required: falseThe name of a security configuration to apply to the cluster.
auto_scaling_role(impl Into<String>)
/set_auto_scaling_role(Option<String>)
:
required: falseAn 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 Amazon EC2 instances in an instance group.scale_down_behavior(ScaleDownBehavior)
/set_scale_down_behavior(Option<ScaleDownBehavior>)
:
required: falseSpecifies 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 releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.custom_ami_id(impl Into<String>)
/set_custom_ami_id(Option<String>)
:
required: falseAvailable only in Amazon EMR releases 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 Amazon 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 releases 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>)
:
required: falseThe size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
repo_upgrade_on_boot(RepoUpgradeOnBoot)
/set_repo_upgrade_on_boot(Option<RepoUpgradeOnBoot>)
:
required: falseApplies 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>)
:
required: falseAttributes 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>)
:
required: falseSpecifies 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>)
:
required: falseThe specified managed scaling policy for an Amazon EMR cluster.
placement_group_configs(PlacementGroupConfig)
/set_placement_group_configs(Option<Vec::<PlacementGroupConfig>>)
:
required: falseThe specified placement group configuration for an Amazon EMR cluster.
auto_termination_policy(AutoTerminationPolicy)
/set_auto_termination_policy(Option<AutoTerminationPolicy>)
:
required: falseAn 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>)
:
required: falseSpecifies 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.
ebs_root_volume_iops(i32)
/set_ebs_root_volume_iops(Option<i32>)
:
required: falseThe IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
ebs_root_volume_throughput(i32)
/set_ebs_root_volume_throughput(Option<i32>)
:
required: falseThe throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
- 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>
Source§impl Client
impl Client
Sourcepub fn set_keep_job_flow_alive_when_no_steps(
&self,
) -> SetKeepJobFlowAliveWhenNoStepsFluentBuilder
pub fn set_keep_job_flow_alive_when_no_steps( &self, ) -> SetKeepJobFlowAliveWhenNoStepsFluentBuilder
Constructs a fluent builder for the SetKeepJobFlowAliveWhenNoSteps
operation.
- The fluent builder is configurable:
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: trueA list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows.
keep_job_flow_alive_when_no_steps(bool)
/set_keep_job_flow_alive_when_no_steps(Option<bool>)
:
required: trueA Boolean that indicates whether to terminate the cluster after all steps are executed.
- On success, responds with
SetKeepJobFlowAliveWhenNoStepsOutput
- On failure, responds with
SdkError<SetKeepJobFlowAliveWhenNoStepsError>
Source§impl Client
impl Client
Sourcepub fn set_termination_protection(
&self,
) -> SetTerminationProtectionFluentBuilder
pub fn set_termination_protection( &self, ) -> SetTerminationProtectionFluentBuilder
Constructs a fluent builder for the SetTerminationProtection
operation.
- The fluent builder is configurable:
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: trueA 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(Option<bool>)
:
required: trueA 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>
Source§impl Client
impl Client
Sourcepub fn set_unhealthy_node_replacement(
&self,
) -> SetUnhealthyNodeReplacementFluentBuilder
pub fn set_unhealthy_node_replacement( &self, ) -> SetUnhealthyNodeReplacementFluentBuilder
Constructs a fluent builder for the SetUnhealthyNodeReplacement
operation.
- The fluent builder is configurable:
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: trueThe list of strings that uniquely identify the clusters for which to turn on unhealthy node replacement. You can get these identifiers by running the
RunJobFlow
or theDescribeJobFlows
operations.unhealthy_node_replacement(bool)
/set_unhealthy_node_replacement(Option<bool>)
:
required: trueIndicates whether to turn on or turn off graceful unhealthy node replacement.
- On success, responds with
SetUnhealthyNodeReplacementOutput
- On failure, responds with
SdkError<SetUnhealthyNodeReplacementError>
Source§impl Client
impl Client
Sourcepub fn set_visible_to_all_users(&self) -> SetVisibleToAllUsersFluentBuilder
pub fn set_visible_to_all_users(&self) -> SetVisibleToAllUsersFluentBuilder
Constructs a fluent builder for the SetVisibleToAllUsers
operation.
- The fluent builder is configurable:
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: trueThe unique identifier of the job flow (cluster).
visible_to_all_users(bool)
/set_visible_to_all_users(Option<bool>)
:
required: trueA value of
true
indicates that an IAM principal in the Amazon Web Services account can perform Amazon 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 Amazon EMR actions on the cluster.
- On success, responds with
SetVisibleToAllUsersOutput
- On failure, responds with
SdkError<SetVisibleToAllUsersError>
Source§impl Client
impl Client
Sourcepub fn start_notebook_execution(&self) -> StartNotebookExecutionFluentBuilder
pub fn start_notebook_execution(&self) -> StartNotebookExecutionFluentBuilder
Constructs a fluent builder for the StartNotebookExecution
operation.
- The fluent builder is configurable:
editor_id(impl Into<String>)
/set_editor_id(Option<String>)
:
required: falseThe unique identifier of the Amazon EMR Notebook to use for notebook execution.
relative_path(impl Into<String>)
/set_relative_path(Option<String>)
:
required: falseThe path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of
s3://MyBucket/MyNotebooks
when you create an Amazon 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>)
:
required: falseAn optional name for the notebook execution.
notebook_params(impl Into<String>)
/set_notebook_params(Option<String>)
:
required: falseInput parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
execution_engine(ExecutionEngineConfig)
/set_execution_engine(Option<ExecutionEngineConfig>)
:
required: trueSpecifies the execution engine (cluster) that runs the notebook execution.
service_role(impl Into<String>)
/set_service_role(Option<String>)
:
required: trueThe name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
notebook_instance_security_group_id(impl Into<String>)
/set_notebook_instance_security_group_id(Option<String>)
:
required: falseThe unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA 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.
notebook_s3_location(NotebookS3LocationFromInput)
/set_notebook_s3_location(Option<NotebookS3LocationFromInput>)
:
required: falseThe Amazon S3 location for the notebook execution input.
output_notebook_s3_location(OutputNotebookS3LocationFromInput)
/set_output_notebook_s3_location(Option<OutputNotebookS3LocationFromInput>)
:
required: falseThe Amazon S3 location for the notebook execution output.
output_notebook_format(OutputNotebookFormat)
/set_output_notebook_format(Option<OutputNotebookFormat>)
:
required: falseThe output format for the notebook execution.
environment_variables(impl Into<String>, impl Into<String>)
/set_environment_variables(Option<HashMap::<String, String>>)
:
required: falseThe environment variables associated with the notebook execution.
- 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>
Source§impl Client
impl Client
Sourcepub fn stop_notebook_execution(&self) -> StopNotebookExecutionFluentBuilder
pub fn stop_notebook_execution(&self) -> StopNotebookExecutionFluentBuilder
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>)
:
required: trueThe unique identifier of the notebook execution.
- On success, responds with
StopNotebookExecutionOutput
- On failure, responds with
SdkError<StopNotebookExecutionError>
Source§impl Client
impl Client
Sourcepub fn terminate_job_flows(&self) -> TerminateJobFlowsFluentBuilder
pub fn terminate_job_flows(&self) -> TerminateJobFlowsFluentBuilder
Constructs a fluent builder for the TerminateJobFlows
operation.
- The fluent builder is configurable:
job_flow_ids(impl Into<String>)
/set_job_flow_ids(Option<Vec::<String>>)
:
required: trueA list of job flows to be shut down.
- On success, responds with
TerminateJobFlowsOutput
- On failure, responds with
SdkError<TerminateJobFlowsError>
Source§impl Client
impl Client
Sourcepub fn update_studio(&self) -> UpdateStudioFluentBuilder
pub fn update_studio(&self) -> UpdateStudioFluentBuilder
Constructs a fluent builder for the UpdateStudio
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe ID of the Amazon EMR Studio to update.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA descriptive name for the Amazon EMR Studio.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA detailed description to assign to the Amazon EMR Studio.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: falseA 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>)
:
required: falseThe Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
encryption_key_arn(impl Into<String>)
/set_encryption_key_arn(Option<String>)
:
required: falseThe KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- On success, responds with
UpdateStudioOutput
- On failure, responds with
SdkError<UpdateStudioError>
Source§impl Client
impl Client
Sourcepub fn update_studio_session_mapping(
&self,
) -> UpdateStudioSessionMappingFluentBuilder
pub fn update_studio_session_mapping( &self, ) -> UpdateStudioSessionMappingFluentBuilder
Constructs a fluent builder for the UpdateStudioSessionMapping
operation.
- The fluent builder is configurable:
studio_id(impl Into<String>)
/set_studio_id(Option<String>)
:
required: trueThe ID of the Amazon EMR Studio.
identity_id(impl Into<String>)
/set_identity_id(Option<String>)
:
required: falseThe globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_name(impl Into<String>)
/set_identity_name(Option<String>)
:
required: falseThe name of the user or group to update. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either
IdentityName
orIdentityId
must be specified.identity_type(IdentityType)
/set_identity_type(Option<IdentityType>)
:
required: trueSpecifies whether the identity to update is a user or a group.
session_policy_arn(impl Into<String>)
/set_session_policy_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_cluster_running(&self) -> ClusterRunningFluentBuilder
fn wait_until_cluster_running(&self) -> ClusterRunningFluentBuilder
cluster_running
Source§fn wait_until_cluster_terminated(&self) -> ClusterTerminatedFluentBuilder
fn wait_until_cluster_terminated(&self) -> ClusterTerminatedFluentBuilder
cluster_terminated
Source§fn wait_until_step_complete(&self) -> StepCompleteFluentBuilder
fn wait_until_step_complete(&self) -> StepCompleteFluentBuilder
step_complete
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);