lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.67.0 vs lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.68.0
- old
+ new
@@ -379,11 +379,11 @@
# @!group API Operations
# Adds an instance fleet to a running cluster.
#
# <note markdown="1"> The instance fleet configuration is available only in Amazon EMR
- # versions 4.8.0 and later, excluding 5.0.x.
+ # releases 4.8.0 and later, excluding 5.0.x.
#
# </note>
#
# @option params [required, String] :cluster_id
# The unique identifier of the cluster.
@@ -632,11 +632,11 @@
# 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
+ # For example, `arn:aws:IAM::1234567890:role/ReadOnly` is a correctly
# formatted runtime role ARN.
#
# @return [Types::AddJobFlowStepsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::AddJobFlowStepsOutput#step_ids #step_ids} => Array<String>
@@ -724,11 +724,11 @@
# Cancels a pending step or steps in a running cluster. Available only
# in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A
# maximum of 256 steps are allowed in each CancelSteps request.
# CancelSteps is idempotent but asynchronous; it does not guarantee that
# a step will be canceled, even if the request is successfully
- # submitted. When you use Amazon EMR versions 5.28.0 and later, you can
+ # submitted. When you use Amazon EMR releases 5.28.0 and later, you can
# cancel steps that are in a `PENDING` or `RUNNING` state. In earlier
# versions of Amazon EMR, you can only cancel steps that are in a
# `PENDING` state.
#
# @option params [required, String] :cluster_id
@@ -966,12 +966,12 @@
#
# @option params [required, String] :session_policy_arn
# 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][1].
+ # For more information, see [Create an Amazon EMR Studio User Role with
+ # Session Policies][1].
#
#
#
# [1]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html
#
@@ -1347,10 +1347,11 @@
# resp.notebook_execution.notebook_execution_id #=> String
# resp.notebook_execution.editor_id #=> String
# resp.notebook_execution.execution_engine.id #=> String
# resp.notebook_execution.execution_engine.type #=> String, one of "EMR"
# resp.notebook_execution.execution_engine.master_instance_security_group_id #=> String
+ # resp.notebook_execution.execution_engine.execution_role_arn #=> String
# resp.notebook_execution.notebook_execution_name #=> String
# resp.notebook_execution.notebook_params #=> String
# resp.notebook_execution.status #=> String, one of "START_PENDING", "STARTING", "RUNNING", "FINISHING", "FINISHED", "FAILING", "FAILED", "STOP_PENDING", "STOPPING", "STOPPED"
# resp.notebook_execution.start_time #=> Time
# resp.notebook_execution.end_time #=> Time
@@ -1359,24 +1360,31 @@
# resp.notebook_execution.last_state_change_reason #=> String
# resp.notebook_execution.notebook_instance_security_group_id #=> String
# resp.notebook_execution.tags #=> Array
# resp.notebook_execution.tags[0].key #=> String
# resp.notebook_execution.tags[0].value #=> String
+ # resp.notebook_execution.notebook_s3_location.bucket #=> String
+ # resp.notebook_execution.notebook_s3_location.key #=> String
+ # resp.notebook_execution.output_notebook_s3_location.bucket #=> String
+ # resp.notebook_execution.output_notebook_s3_location.key #=> String
+ # resp.notebook_execution.output_notebook_format #=> String, one of "HTML"
+ # resp.notebook_execution.environment_variables #=> Hash
+ # resp.notebook_execution.environment_variables["XmlStringMaxLen256"] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/DescribeNotebookExecution AWS API Documentation
#
# @overload describe_notebook_execution(params = {})
# @param [Hash] params ({})
def describe_notebook_execution(params = {}, options = {})
req = build_request(:describe_notebook_execution, params)
req.send_request(options)
end
- # Provides EMR release label details, such as releases available the
- # region where the API request is run, and the available applications
- # for a specific EMR release label. Can also list EMR release versions
- # that support a specified version of Spark.
+ # Provides Amazon EMR release label details, such as the releases
+ # available the Region where the API request is run, and the available
+ # applications for a specific Amazon EMR release label. Can also list
+ # Amazon EMR releases that support a specified version of Spark.
#
# @option params [String] :release_label
# The target release label to be described.
#
# @option params [String] :next_token
@@ -1867,11 +1875,11 @@
end
# Lists all available details about the instance fleets in a cluster.
#
# <note markdown="1"> The instance fleet configuration is available only in Amazon EMR
- # versions 4.8.0 and later, excluding 5.0.x versions.
+ # releases 4.8.0 and later, excluding 5.0.x versions.
#
# </note>
#
# @option params [required, String] :cluster_id
# The unique identifier of the cluster.
@@ -2047,14 +2055,15 @@
def list_instance_groups(params = {}, options = {})
req = build_request(:list_instance_groups, params)
req.send_request(options)
end
- # Provides information for all active EC2 instances and EC2 instances
- # terminated in the last 30 days, up to a maximum of 2,000. EC2
- # instances in any of the following states are considered active:
- # AWAITING\_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
+ # Provides information for all active Amazon EC2 instances and Amazon
+ # EC2 instances terminated in the last 30 days, up to a maximum of
+ # 2,000. Amazon EC2 instances in any of the following states are
+ # considered active: AWAITING\_FULFILLMENT, PROVISIONING, BOOTSTRAPPING,
+ # RUNNING.
#
# @option params [required, String] :cluster_id
# The identifier of the cluster for which to list the instances.
#
# @option params [String] :instance_group_id
@@ -2132,11 +2141,11 @@
# Provides summaries of all notebook executions. You can filter the list
# based on multiple criteria such as status, time range, and editor id.
# Returns a maximum of 50 notebook executions and a marker to track the
# paging of a longer notebook execution list across multiple
- # `ListNotebookExecution` calls.
+ # `ListNotebookExecutions` calls.
#
# @option params [String] :editor_id
# The unique ID of the editor associated with the notebook execution.
#
# @option params [String] :status
@@ -2180,10 +2189,13 @@
# @option params [String] :marker
# The pagination token, returned by a previous `ListNotebookExecutions`
# call, that indicates the start of the list for this
# `ListNotebookExecutions` call.
#
+ # @option params [String] :execution_engine_id
+ # The unique ID of the execution engine.
+ #
# @return [Types::ListNotebookExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListNotebookExecutionsOutput#notebook_executions #notebook_executions} => Array<Types::NotebookExecutionSummary>
# * {Types::ListNotebookExecutionsOutput#marker #marker} => String
#
@@ -2195,10 +2207,11 @@
# editor_id: "XmlStringMaxLen256",
# status: "START_PENDING", # accepts START_PENDING, STARTING, RUNNING, FINISHING, FINISHED, FAILING, FAILED, STOP_PENDING, STOPPING, STOPPED
# from: Time.now,
# to: Time.now,
# marker: "Marker",
+ # execution_engine_id: "XmlString",
# })
#
# @example Response structure
#
# resp.notebook_executions #=> Array
@@ -2206,10 +2219,13 @@
# resp.notebook_executions[0].editor_id #=> String
# resp.notebook_executions[0].notebook_execution_name #=> String
# resp.notebook_executions[0].status #=> String, one of "START_PENDING", "STARTING", "RUNNING", "FINISHING", "FINISHED", "FAILING", "FAILED", "STOP_PENDING", "STOPPING", "STOPPED"
# resp.notebook_executions[0].start_time #=> Time
# resp.notebook_executions[0].end_time #=> Time
+ # resp.notebook_executions[0].notebook_s3_location.bucket #=> String
+ # resp.notebook_executions[0].notebook_s3_location.key #=> String
+ # resp.notebook_executions[0].execution_engine_id #=> String
# resp.marker #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/ListNotebookExecutions AWS API Documentation
#
# @overload list_notebook_executions(params = {})
@@ -2217,12 +2233,12 @@
def list_notebook_executions(params = {}, options = {})
req = build_request(:list_notebook_executions, params)
req.send_request(options)
end
- # Retrieves release labels of EMR services in the region where the API
- # is called.
+ # Retrieves release labels of Amazon EMR services in the Region where
+ # the API is called.
#
# @option params [Types::ReleaseLabelFilter] :filters
# 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.
@@ -2514,11 +2530,11 @@
# instance fleet with the specified InstanceFleetID within the cluster
# specified using ClusterID. The call either succeeds or fails
# atomically.
#
# <note markdown="1"> The instance fleet configuration is available only in Amazon EMR
- # versions 4.8.0 and later, excluding 5.0.x versions.
+ # releases 4.8.0 and later, excluding 5.0.x versions.
#
# </note>
#
# @option params [required, String] :cluster_id
# The unique identifier of the cluster.
@@ -2612,12 +2628,12 @@
end
# Creates or updates an automatic scaling policy for a core instance
# group or task instance group in an Amazon EMR cluster. The automatic
# scaling policy defines how an instance group dynamically adds and
- # terminates EC2 instances in response to the value of a CloudWatch
- # metric.
+ # terminates Amazon EC2 instances in response to the value of a
+ # CloudWatch metric.
#
# @option params [required, String] :cluster_id
# Specifies the ID of a cluster. The instance group to which the
# automatic scaling policy is applied is within this cluster.
#
@@ -2716,11 +2732,11 @@
def put_auto_scaling_policy(params = {}, options = {})
req = build_request(:put_auto_scaling_policy, params)
req.send_request(options)
end
- # <note markdown="1"> Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0
+ # <note markdown="1"> Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0
# and later. For more information, see [Using an auto-termination
# policy][1].
#
# </note>
#
@@ -2785,12 +2801,12 @@
# exception.
#
# <note markdown="1"> 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.
+ # 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.
#
# </note>
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -2817,17 +2833,17 @@
req.send_request(options)
end
# Creates or updates a managed scaling policy for an Amazon EMR cluster.
# The managed scaling policy defines the limits for resources, such as
- # EC2 instances that can be added or terminated from a cluster. The
- # policy only applies to the core and task nodes. The master node cannot
- # be scaled after initial configuration.
+ # Amazon EC2 instances that can be added or terminated from a cluster.
+ # The policy only applies to the core and task nodes. The master node
+ # cannot be scaled after initial configuration.
#
# @option params [required, String] :cluster_id
- # Specifies the ID of an EMR cluster where the managed scaling policy is
- # attached.
+ # Specifies the ID of an Amazon EMR cluster where the managed scaling
+ # policy is attached.
#
# @option params [required, Types::ManagedScalingPolicy] :managed_scaling_policy
# Specifies the constraints for the managed scaling policy.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -2855,11 +2871,11 @@
req = build_request(:put_managed_scaling_policy, params)
req.send_request(options)
end
# Removes an automatic scaling policy from a specified instance group
- # within an EMR cluster.
+ # within an Amazon EMR cluster.
#
# @option params [required, String] :cluster_id
# Specifies the ID of a cluster. The instance group to which the
# automatic scaling policy is applied is within this cluster.
#
@@ -2906,11 +2922,11 @@
def remove_auto_termination_policy(params = {}, options = {})
req = build_request(:remove_auto_termination_policy, params)
req.send_request(options)
end
- # Removes a managed scaling policy from a specified EMR cluster.
+ # Removes a managed scaling policy from a specified Amazon EMR cluster.
#
# @option params [required, String] :cluster_id
# Specifies the ID of the cluster from which the managed scaling policy
# will be removed.
#
@@ -2992,11 +3008,11 @@
#
# For long-running clusters, we recommend that you periodically store
# your results.
#
# <note markdown="1"> The instance fleets configuration is available only in Amazon EMR
- # versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow
+ # releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow
# request can contain InstanceFleets parameters or InstanceGroups
# parameters, but not both.
#
# </note>
#
@@ -3008,11 +3024,11 @@
# value is not provided, logs are not created.
#
# @option params [String] :log_encryption_kms_key_id
# 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.
+ # with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
#
# @option params [String] :additional_info
# A JSON string for selecting additional features.
#
# @option params [String] :ami_version
@@ -3068,12 +3084,12 @@
# later, use Applications.
#
# </note>
#
# 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
+ # 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][1]. Supported values are:
#
# * "mapr-m3" - launch the cluster using MapR M3 Edition.
@@ -3110,39 +3126,40 @@
#
# [1]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/
#
# @option params [Array<Types::Configuration>] :configurations
# For Amazon EMR releases 4.0 and later. The list of configurations
- # supplied for the EMR cluster you are creating.
+ # supplied for the Amazon EMR cluster that you are creating.
#
# @option params [Boolean] :visible_to_all_users
# The VisibleToAllUsers parameter is no longer supported. By default,
# the value is set to `true`. Setting it to `false` 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 to
- # `true` for clusters created using the EMR API or the CLI
- # [create-cluster][1] command.
+ # Services account associated with the cluster can perform Amazon EMR
+ # actions on the cluster that their IAM policies allow. This value
+ # defaults to `true` for clusters created using the Amazon EMR API or
+ # the CLI [create-cluster][1] 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][2] in the *Amazon EMRManagement
- # Guide*.
+ # 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][2] in
+ # the *Amazon EMR Management Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html
- # [2]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users
+ # [2]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_IAM_emr-with-IAM.html#security_set_visible_to_all_users
#
# @option params [String] :job_flow_role
- # 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.
+ # Also 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.
#
# @option params [String] :service_role
# The 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
@@ -3156,12 +3173,12 @@
# The name of a security configuration to apply to the cluster.
#
# @option params [String] :auto_scaling_role
# 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.
+ # the automatic scaling feature requires to launch and terminate Amazon
+ # EC2 instances in an instance group.
#
# @option params [String] :scale_down_behavior
# 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
@@ -3172,21 +3189,21 @@
# 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.
+ # in Amazon EMR releases 4.1.0 and later, and is the default for
+ # releases of Amazon EMR earlier than 5.1.0.
#
# @option params [String] :custom_ami_id
- # Available only in Amazon EMR version 5.7.0 and later. The ID of a
+ # Available 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 EC2 instances. For more information about
- # custom AMIs in Amazon EMR, see [Using a Custom AMI][1] 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,
- # use `AmiVersion` instead.
+ # AMI when it launches cluster Amazon EC2 instances. For more
+ # information about custom AMIs in Amazon EMR, see [Using a Custom
+ # AMI][1] 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, use `AmiVersion` instead.
#
# For information about creating a custom AMI, see [Creating an Amazon
# EBS-Backed Linux AMI][2] in the *Amazon Elastic Compute Cloud User
# Guide for Linux Instances*. For information about finding an AMI ID,
# see [Finding a Linux AMI][3].
@@ -3197,12 +3214,12 @@
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html
# [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
#
# @option params [Integer] :ebs_root_volume_size
# 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.
+ # AMI that is used for each Amazon EC2 instance. Available in Amazon EMR
+ # releases 4.x and later.
#
# @option params [String] :repo_upgrade_on_boot
# 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 is
@@ -3528,17 +3545,17 @@
def run_job_flow(params = {}, options = {})
req = build_request(:run_job_flow, params)
req.send_request(options)
end
- # SetTerminationProtection locks a cluster (job flow) so the EC2
+ # SetTerminationProtection locks a cluster (job flow) so the Amazon EC2
# instances in the cluster cannot be terminated by user intervention, an
# API call, or in the event of a job-flow error. The cluster still
# terminates upon successful completion of the job flow. Calling
# `SetTerminationProtection` on a cluster is similar to calling the
- # Amazon EC2 `DisableAPITermination` API on all EC2 instances in a
- # cluster.
+ # Amazon EC2 `DisableAPITermination` API on all Amazon EC2 instances in
+ # a cluster.
#
# `SetTerminationProtection` is used to prevent accidental termination
# of a cluster and to ensure that in the event of an error, the
# instances persist so that you can recover any data stored in their
# ephemeral instance storage.
@@ -3584,39 +3601,41 @@
end
# The SetVisibleToAllUsers parameter is no longer supported. Your
# cluster may be visible to all users in your account. To restrict
# cluster access using an IAM policy, see [Identity and Access
- # Management for EMR][1].
+ # Management for Amazon EMR][1].
#
- # Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When
- # `true`, IAM principals in the Amazon Web Services account can perform
- # EMR cluster actions that their IAM policies allow. When `false`, only
- # the IAM principal that created the cluster and the Amazon Web Services
- # account root user can perform EMR actions on the cluster, regardless
- # of IAM permissions policies attached to other IAM principals.
+ # Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster.
+ # When `true`, IAM principals in the Amazon Web Services account can
+ # perform Amazon EMR cluster actions that their IAM policies allow. When
+ # `false`, only the IAM principal that created the cluster and the
+ # Amazon Web Services account root user can perform Amazon EMR actions
+ # on the cluster, regardless of IAM permissions policies attached to
+ # other IAM principals.
#
# This action works on running clusters. When you create a cluster, use
# the RunJobFlowInput$VisibleToAllUsers parameter.
#
- # For more information, see [Understanding the EMR Cluster
- # VisibleToAllUsers Setting][2] in the *Amazon EMRManagement Guide*.
+ # For more information, see [Understanding the Amazon EMR Cluster
+ # VisibleToAllUsers Setting][2] in the *Amazon EMR Management Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-iam.html
- # [2]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users
+ # [1]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-IAM.html
+ # [2]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_IAM_emr-with-IAM.html#security_set_visible_to_all_users
#
# @option params [required, Array<String>] :job_flow_ids
# The unique identifier of the job flow (cluster).
#
# @option params [required, Boolean] :visible_to_all_users
# 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 of `false` indicates
- # that only the IAM principal that created the cluster and the Amazon
- # Web Services root user can perform EMR actions on the cluster.
+ # Services account can perform Amazon EMR actions on the cluster that
+ # the IAM policies attached to the principal allow. A value of `false`
+ # 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -3634,74 +3653,99 @@
req.send_request(options)
end
# Starts a notebook execution.
#
- # @option params [required, String] :editor_id
- # The unique identifier of the EMR Notebook to use for notebook
+ # @option params [String] :editor_id
+ # The unique identifier of the Amazon EMR Notebook to use for notebook
# execution.
#
- # @option params [required, String] :relative_path
+ # @option params [String] :relative_path
# 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 of
+ # 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 of
# `e-ABCDEFGHIJK1234567890ABCD` (the `EditorID` of this request), and
# you specify a `RelativePath` of
# `my_notebook_executions/notebook_execution.ipynb`, the location of the
# file for the notebook execution is
# `s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb`.
#
# @option params [String] :notebook_execution_name
# An optional name for the notebook execution.
#
# @option params [String] :notebook_params
- # Input parameters in JSON format passed to the EMR Notebook at runtime
- # for execution.
+ # Input parameters in JSON format passed to the Amazon EMR Notebook at
+ # runtime for execution.
#
# @option params [required, Types::ExecutionEngineConfig] :execution_engine
# Specifies the execution engine (cluster) that runs the notebook
# execution.
#
# @option params [required, String] :service_role
# 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.
+ # Amazon EMR (the Amazon EMR role) for the notebook execution.
#
# @option params [String] :notebook_instance_security_group_id
# The unique identifier of the Amazon EC2 security group to associate
- # with the EMR Notebook for this notebook execution.
+ # with the Amazon EMR Notebook for this notebook execution.
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
+ # @option params [Types::NotebookS3LocationFromInput] :notebook_s3_location
+ # The Amazon S3 location for the notebook execution input.
+ #
+ # @option params [Types::OutputNotebookS3LocationFromInput] :output_notebook_s3_location
+ # The Amazon S3 location for the notebook execution output.
+ #
+ # @option params [String] :output_notebook_format
+ # The output format for the notebook execution.
+ #
+ # @option params [Hash<String,String>] :environment_variables
+ # The environment variables associated with the notebook execution.
+ #
# @return [Types::StartNotebookExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StartNotebookExecutionOutput#notebook_execution_id #notebook_execution_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.start_notebook_execution({
- # editor_id: "XmlStringMaxLen256", # required
- # relative_path: "XmlString", # required
+ # editor_id: "XmlStringMaxLen256",
+ # relative_path: "XmlString",
# notebook_execution_name: "XmlStringMaxLen256",
# notebook_params: "XmlString",
# execution_engine: { # required
# id: "XmlStringMaxLen256", # required
# type: "EMR", # accepts EMR
# master_instance_security_group_id: "XmlStringMaxLen256",
+ # execution_role_arn: "IAMRoleArn",
# },
# service_role: "XmlString", # required
# notebook_instance_security_group_id: "XmlStringMaxLen256",
# tags: [
# {
# key: "String",
# value: "String",
# },
# ],
+ # notebook_s3_location: {
+ # bucket: "XmlStringMaxLen256",
+ # key: "UriString",
+ # },
+ # output_notebook_s3_location: {
+ # bucket: "XmlStringMaxLen256",
+ # key: "UriString",
+ # },
+ # output_notebook_format: "HTML", # accepts HTML
+ # environment_variables: {
+ # "XmlStringMaxLen256" => "XmlString",
+ # },
# })
#
# @example Response structure
#
# resp.notebook_execution_id #=> String
@@ -3737,12 +3781,12 @@
req.send_request(options)
end
# TerminateJobFlows shuts a list of clusters (job flows) down. When a
# job flow is shut down, any step not yet completed is canceled and the
- # EC2 instances on which the cluster is running are stopped. Any log
- # files not already saved are uploaded to Amazon S3 if a LogUri was
+ # Amazon EC2 instances on which the cluster is running are stopped. Any
+ # log files not already saved are uploaded to Amazon S3 if a LogUri was
# specified when the cluster was created.
#
# The maximum number of clusters allowed is 10. The call to
# `TerminateJobFlows` is asynchronous. Depending on the configuration of
# the cluster, it may take up to 1-5 minutes for the cluster to
@@ -3880,10 +3924,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-emr'
- context[:gem_version] = '1.67.0'
+ context[:gem_version] = '1.68.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#