lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.41.0 vs lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.42.0
- old
+ new
@@ -739,22 +739,17 @@
def create_security_configuration(params = {}, options = {})
req = build_request(:create_security_configuration, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Creates a new Amazon EMR Studio.
#
# @option params [required, String] :name
# A descriptive name for the Amazon EMR Studio.
#
# @option params [String] :description
- # A detailed description of the Studio.
+ # A detailed description of the Amazon EMR Studio.
#
# @option params [required, String] :auth_mode
# Specifies whether the Studio authenticates users using single sign-on
# (SSO) or IAM. Amazon EMR Studio currently only supports SSO
# authentication.
@@ -762,23 +757,24 @@
# @option params [required, String] :vpc_id
# The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate
# with the Studio.
#
# @option params [required, Array<String>] :subnet_ids
- # A list of subnet IDs to associate with the Studio. The subnets must
- # belong to the VPC specified by `VpcId`. Studio users can create a
- # Workspace in any of the specified subnets.
+ # A list of subnet IDs to associate with the Amazon EMR Studio. A Studio
+ # can have a maximum of 5 subnets. The subnets must belong to the VPC
+ # specified by `VpcId`. Studio users can create a Workspace in any of
+ # the specified subnets.
#
# @option params [required, String] :service_role
# The IAM role that will be assumed by the Amazon EMR Studio. The
# service role provides a way for Amazon EMR Studio to interoperate with
# other AWS services.
#
# @option params [required, String] :user_role
# The IAM user role that will be assumed by users and groups logged in
- # to a Studio. The permissions attached to this IAM role can be scoped
- # down for each user or group using session policies.
+ # to an Amazon EMR Studio. The permissions attached to this IAM role can
+ # be scoped down for each user or group using session policies.
#
# @option params [required, String] :workspace_security_group_id
# The ID of the Amazon EMR Studio Workspace security group. The
# Workspace security group allows outbound network traffic to resources
# in the Engine security group, and it must be in the same VPC specified
@@ -787,20 +783,20 @@
# @option params [required, String] :engine_security_group_id
# The ID of the Amazon EMR Studio Engine security group. The Engine
# security group allows inbound network traffic from the Workspace
# security group, and it must be in the same VPC specified by `VpcId`.
#
- # @option params [String] :default_s3_location
- # The default Amazon S3 location to back up EMR Studio Workspaces and
- # notebook files. A Studio user can select an alternative Amazon S3
+ # @option params [required, String] :default_s3_location
+ # The default Amazon S3 location to back up Amazon EMR Studio Workspaces
+ # and notebook files. A Studio user can select an alternative Amazon S3
# location when creating a Workspace.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags to associate with the 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.
+ # A list of tags to associate with the Amazon EMR Studio. Tags are
+ # user-defined key-value pairs that consist of a required key string
+ # with a maximum of 128 characters, and an optional value string with a
+ # maximum of 256 characters.
#
# @return [Types::CreateStudioOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStudioOutput#studio_id #studio_id} => String
# * {Types::CreateStudioOutput#url #url} => String
@@ -815,11 +811,11 @@
# subnet_ids: ["String"], # required
# service_role: "XmlString", # required
# user_role: "XmlString", # required
# workspace_security_group_id: "XmlStringMaxLen256", # required
# engine_security_group_id: "XmlStringMaxLen256", # required
- # default_s3_location: "XmlString",
+ # default_s3_location: "XmlString", # required
# tags: [
# {
# key: "String",
# value: "String",
# },
@@ -838,15 +834,10 @@
def create_studio(params = {}, options = {})
req = build_request(:create_studio, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Maps a user or group to the Amazon EMR Studio specified by `StudioId`,
# and applies a session policy to refine Studio permissions for that
# user or group.
#
# @option params [required, String] :studio_id
@@ -869,16 +860,16 @@
# and [DisplayName][2] in the *AWS SSO Identity Store API Reference*.
# Either `IdentityName` or `IdentityId` must be specified.
#
#
#
- # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName
# [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName
#
# @option params [required, String] :identity_type
- # Specifies whether the identity to map to the Studio is a user or a
- # group.
+ # Specifies whether the identity to map to the Amazon EMR Studio is a
+ # user or a group.
#
# @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. Session policies refine Studio user
# permissions without the need to use multiple IAM user roles.
@@ -924,15 +915,10 @@
def delete_security_configuration(params = {}, options = {})
req = build_request(:delete_security_configuration, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Removes an Amazon EMR Studio from the Studio metadata store.
#
# @option params [required, String] :studio_id
# The ID of the Amazon EMR Studio.
#
@@ -951,15 +937,10 @@
def delete_studio(params = {}, options = {})
req = build_request(:delete_studio, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Removes a user or group from an Amazon EMR Studio.
#
# @option params [required, String] :studio_id
# The ID of the Amazon EMR Studio.
#
@@ -973,23 +954,23 @@
#
# [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId
# [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId
#
# @option params [String] :identity_name
- # The name of the user name or group to remove from the Studio. For more
- # information, see [UserName][1] and [DisplayName][2] in the *AWS SSO
- # Identity Store API Reference*. Either `IdentityName` or `IdentityId`
- # must be specified.
+ # The name of the user name or group to remove from the Amazon EMR
+ # Studio. For more information, see [UserName][1] and [DisplayName][2]
+ # in the *AWS SSO Identity Store API Reference*. Either `IdentityName`
+ # or `IdentityId` must be specified.
#
#
#
- # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName
# [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName
#
# @option params [required, String] :identity_type
- # Specifies whether the identity to delete from the Studio is a user or
- # a group.
+ # Specifies whether the identity to delete from the Amazon EMR Studio is
+ # a user or a group.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -1366,15 +1347,10 @@
def describe_step(params = {}, options = {})
req = build_request(:describe_step, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Returns details for the specified Amazon EMR Studio including ID,
# Name, VPC, Studio access URL, and so on.
#
# @option params [required, String] :studio_id
# The Amazon EMR Studio ID.
@@ -1482,15 +1458,10 @@
def get_managed_scaling_policy(params = {}, options = {})
req = build_request(:get_managed_scaling_policy, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Fetches mapping details for the specified Amazon EMR Studio and
# identity (user or group).
#
# @option params [required, String] :studio_id
# The ID of the Amazon EMR Studio.
@@ -1511,11 +1482,11 @@
# [UserName][1] and [DisplayName][2] in the *AWS SSO Identity Store API
# Reference*. Either `IdentityName` or `IdentityId` must be specified.
#
#
#
- # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName
# [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName
#
# @option params [required, String] :identity_type
# Specifies whether the identity to fetch is a user or a group.
#
@@ -2037,11 +2008,11 @@
req.send_request(options)
end
# Provides a list of steps for the cluster in reverse order unless you
# specify `stepIds` with the request of filter by `StepStates`. You can
- # specify a maximum of ten `stepIDs`.
+ # specify a maximum of 10 `stepIDs`.
#
# @option params [required, String] :cluster_id
# The identifier of the cluster for which to list the steps.
#
# @option params [Array<String>] :step_states
@@ -2102,18 +2073,13 @@
def list_steps(params = {}, options = {})
req = build_request(:list_steps, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
+ # Returns a list of all user or group session mappings for the Amazon
+ # EMR Studio specified by `StudioId`.
#
- # </note>
- #
- # Returns a list of all user or group session mappings for the EMR
- # Studio specified by `StudioId`.
- #
# @option params [String] :studio_id
# The ID of the Amazon EMR Studio.
#
# @option params [String] :identity_type
# Specifies whether to return session mappings for users or groups. If
@@ -2156,15 +2122,10 @@
def list_studio_session_mappings(params = {}, options = {})
req = build_request(:list_studio_session_mappings, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
- #
- # </note>
- #
# Returns a list of all Amazon EMR Studios associated with the AWS
# account. The list includes details such as ID, Studio Access URL, and
# creation time for each Studio.
#
# @option params [String] :marker
@@ -2741,11 +2702,11 @@
# "--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 Analtics
+ # * "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.
@@ -3357,20 +3318,60 @@
def terminate_job_flows(params = {}, options = {})
req = build_request(:terminate_job_flows, params)
req.send_request(options)
end
- # <note markdown="1"> The Amazon EMR Studio APIs are in preview release for Amazon EMR and
- # are subject to change.
+ # Updates an Amazon EMR Studio configuration, including attributes such
+ # as name, description, and subnets.
#
- # </note>
+ # @option params [required, String] :studio_id
+ # The ID of the Amazon EMR Studio to update.
#
+ # @option params [String] :name
+ # A descriptive name for the Amazon EMR Studio.
+ #
+ # @option params [String] :description
+ # A detailed description to assign to the Amazon EMR Studio.
+ #
+ # @option params [Array<String>] :subnet_ids
+ # A list of subnet IDs to associate with the Amazon EMR Studio. The list
+ # can include new subnet IDs, but must also include all of the subnet
+ # IDs previously associated with the Studio. The list order does not
+ # matter. A Studio can have a maximum of 5 subnets. The subnets must
+ # belong to the same VPC as the Studio.
+ #
+ # @option params [String] :default_s3_location
+ # A default Amazon S3 location to back up Workspaces and notebook files
+ # for the Amazon EMR Studio. A Studio user can select an alternative
+ # Amazon S3 location when creating a Workspace.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.update_studio({
+ # studio_id: "XmlStringMaxLen256", # required
+ # name: "XmlStringMaxLen256",
+ # description: "XmlStringMaxLen256",
+ # subnet_ids: ["String"],
+ # default_s3_location: "XmlString",
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/UpdateStudio AWS API Documentation
+ #
+ # @overload update_studio(params = {})
+ # @param [Hash] params ({})
+ def update_studio(params = {}, options = {})
+ req = build_request(:update_studio, params)
+ req.send_request(options)
+ end
+
# Updates the session policy attached to the user or group for the
# specified Amazon EMR Studio.
#
# @option params [required, String] :studio_id
- # The ID of the EMR Studio.
+ # The ID of the Amazon EMR Studio.
#
# @option params [String] :identity_id
# The globally unique identifier (GUID) of the user or group. For more
# information, see [UserId][1] and [GroupId][2] in the *AWS SSO Identity
# Store API Reference*. Either `IdentityName` or `IdentityId` must be
@@ -3386,11 +3387,11 @@
# [UserName][1] and [DisplayName][2] in the *AWS SSO Identity Store API
# Reference*. Either `IdentityName` or `IdentityId` must be specified.
#
#
#
- # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName
# [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName
#
# @option params [required, String] :identity_type
# Specifies whether the identity to update is a user or a group.
#
@@ -3430,10 +3431,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-emr'
- context[:gem_version] = '1.41.0'
+ context[:gem_version] = '1.42.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#