lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.45.0 vs lib/aws-sdk-emr/client.rb in aws-sdk-emr-1.46.0

- old
+ new

@@ -661,11 +661,14 @@ # 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. You can only cancel steps that are in a `PENDING` state. + # submitted. When you use Amazon EMR versions 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 # The `ClusterID` for the specified steps that will be canceled. Use # RunJobFlow and ListClusters to get ClusterIDs. # @@ -770,11 +773,11 @@ # 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. + # other Amazon Web Services services. # # @option params [required, String] :user_role # The IAM user role that will be assumed by users and groups logged in # to an Amazon EMR Studio. The permissions attached to this IAM role can # be scoped down for each user or group using session policies. @@ -848,23 +851,25 @@ # The ID of the Amazon EMR Studio to which the user or group will be # mapped. # # @option params [String] :identity_id # The globally unique identifier (GUID) of the user or group from the - # AWS SSO Identity Store. For more information, see [UserId][1] and - # [GroupId][2] in the *AWS SSO Identity Store API Reference*. Either - # `IdentityName` or `IdentityId` must be specified. + # Amazon Web Services SSO Identity Store. For more information, see + # [UserId][1] and [GroupId][2] in the *Amazon Web Services 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 # [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 or group. For more information, see [UserName][1] - # and [DisplayName][2] in the *AWS SSO Identity Store API Reference*. - # Either `IdentityName` or `IdentityId` must be specified. + # and [DisplayName][2] in the *Amazon Web Services 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-UserName # [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName @@ -873,13 +878,19 @@ # 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. + # 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]. # + # + # + # [1]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_studio_session_mapping({ @@ -949,23 +960,23 @@ # The ID of the Amazon EMR Studio. # # @option params [String] :identity_id # The globally unique identifier (GUID) of the user or group to remove # from the Amazon EMR Studio. For more information, see [UserId][1] and - # [GroupId][2] in the *AWS SSO Identity Store API Reference*. Either - # `IdentityName` or `IdentityId` must be specified. + # [GroupId][2] in the *Amazon Web Services 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 # [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 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. + # in the *Amazon Web Services SSO 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-UserName # [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName @@ -1264,10 +1275,55 @@ 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. + # + # @option params [String] :release_label + # The target release label to be described. + # + # @option params [String] :next_token + # The pagination token. Reserved for future use. Currently set to null. + # + # @option params [Integer] :max_results + # Reserved for future use. Currently set to null. + # + # @return [Types::DescribeReleaseLabelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DescribeReleaseLabelOutput#release_label #release_label} => String + # * {Types::DescribeReleaseLabelOutput#applications #applications} => Array&lt;Types::SimplifiedApplication&gt; + # * {Types::DescribeReleaseLabelOutput#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.describe_release_label({ + # release_label: "String", + # next_token: "String", + # max_results: 1, + # }) + # + # @example Response structure + # + # resp.release_label #=> String + # resp.applications #=> Array + # resp.applications[0].name #=> String + # resp.applications[0].version #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/DescribeReleaseLabel AWS API Documentation + # + # @overload describe_release_label(params = {}) + # @param [Hash] params ({}) + def describe_release_label(params = {}, options = {}) + req = build_request(:describe_release_label, params) + req.send_request(options) + end + # Provides the details of a security configuration by returning the # configuration JSON. # # @option params [required, String] :name # The name of the security configuration. @@ -1397,11 +1453,11 @@ def describe_studio(params = {}, options = {}) req = build_request(:describe_studio, params) req.send_request(options) end - # Returns the Amazon EMR block public access configuration for your AWS + # Returns the Amazon EMR block public access configuration for your # account in the current Region. For more information see [Configure # Block Public Access for Amazon EMR][1] in the *Amazon EMR Management # Guide*. # # @@ -1470,23 +1526,24 @@ # @option params [required, String] :studio_id # 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 - # specified. + # information, see [UserId][1] and [GroupId][2] in the *Amazon Web + # Services 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 # [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 or group to fetch. For more information, see - # [UserName][1] and [DisplayName][2] in the *AWS SSO Identity Store API - # Reference*. Either `IdentityName` or `IdentityId` must be specified. + # [UserName][1] and [DisplayName][2] in the *Amazon Web Services 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-UserName # [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName @@ -1566,26 +1623,28 @@ def list_bootstrap_actions(params = {}, options = {}) req = build_request(:list_bootstrap_actions, params) req.send_request(options) end - # Provides the status of all clusters visible to this AWS account. - # Allows you to filter the list of clusters based on certain criteria; - # for example, filtering by cluster creation date and time or by status. - # This call returns a maximum of 50 clusters per call, but returns a - # marker to track the paging of the cluster list across multiple - # ListClusters calls. + # Provides the status of all clusters visible to this account. Allows + # you to filter the list of clusters based on certain criteria; for + # example, filtering by cluster creation date and time or by status. + # This call returns a maximum of 50 clusters in unsorted order per call, + # but returns a marker to track the paging of the cluster list across + # multiple ListClusters calls. # # @option params [Time,DateTime,Date,Integer,String] :created_after # The creation date and time beginning value filter for listing # clusters. # # @option params [Time,DateTime,Date,Integer,String] :created_before # The creation date and time end value filter for listing clusters. # # @option params [Array<String>] :cluster_states - # The cluster state filters to apply when listing clusters. + # The cluster state filters to apply when listing clusters. Clusters + # that change state while this action runs may be not be returned as + # expected in the list of clusters. # # @option params [String] :marker # The pagination token that indicates the next set of results to # retrieve. # @@ -1975,10 +2034,64 @@ 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. + # + # @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. + # + # @option params [String] :next_token + # Specifies the next page of results. If `NextToken` is not specified, + # which is usually the case for the first request of ListReleaseLabels, + # the first page of results are determined by other filtering parameters + # or by the latest version. The `ListReleaseLabels` request fails if the + # identity (AWS AccountID) and all filtering parameters are different + # from the original request, or if the `NextToken` is expired or + # tampered with. + # + # @option params [Integer] :max_results + # Defines the maximum number of release labels to return in a single + # response. The default is `100`. + # + # @return [Types::ListReleaseLabelsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListReleaseLabelsOutput#release_labels #release_labels} => Array&lt;String&gt; + # * {Types::ListReleaseLabelsOutput#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_release_labels({ + # filters: { + # prefix: "String", + # application: "String", + # }, + # next_token: "String", + # max_results: 1, + # }) + # + # @example Response structure + # + # resp.release_labels #=> Array + # resp.release_labels[0] #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/ListReleaseLabels AWS API Documentation + # + # @overload list_release_labels(params = {}) + # @param [Hash] params ({}) + def list_release_labels(params = {}, options = {}) + req = build_request(:list_release_labels, params) + req.send_request(options) + end + # Lists all the security configurations visible to this account, # providing their creation dates and times, and their names. This call # returns a maximum of 50 clusters per call, but returns a marker to # track the paging of the cluster list across multiple # ListSecurityConfigurations calls. @@ -2014,12 +2127,15 @@ req = build_request(:list_security_configurations, params) 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 10 `stepIDs`. + # specify `stepIds` with the request or filter by `StepStates`. You can + # specify a maximum of 10 `stepIDs`. The CLI automatically paginates + # results to return a list greater than 50 steps. To return more than 50 + # steps using the CLI, specify a `Marker`, which is a pagination token + # that indicates the next set of steps to retrieve. # # @option params [required, String] :cluster_id # The identifier of the cluster for which to list the steps. # # @option params [Array<String>] :step_states @@ -2029,12 +2145,14 @@ # The filter to limit the step list based on the identifier of the # steps. You can specify a maximum of ten Step IDs. The character # constraint applies to the overall length of the array. # # @option params [String] :marker - # The pagination token that indicates the next set of results to - # retrieve. + # The maximum number of steps that a single `ListSteps` action returns + # is 50. To return a longer list of steps, use multiple `ListSteps` + # actions along with the `Marker` parameter, which is a pagination token + # that indicates the next set of results to retrieve. # # @return [Types::ListStepsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListStepsOutput#steps #steps} => Array&lt;Types::StepSummary&gt; # * {Types::ListStepsOutput#marker #marker} => String @@ -2129,13 +2247,13 @@ def list_studio_session_mappings(params = {}, options = {}) req = build_request(:list_studio_session_mappings, params) req.send_request(options) end - # 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. + # Returns a list of all Amazon EMR Studios associated with the account. + # The list includes details such as ID, Studio Access URL, and creation + # time for each Studio. # # @option params [String] :marker # The pagination token that indicates the set of results to retrieve. # # @return [Types::ListStudiosOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2177,11 +2295,14 @@ # @option params [required, String] :cluster_id # The unique identifier of the cluster. # # @option params [Integer] :step_concurrency_level # The number of steps that can be executed concurrently. You can specify - # a minimum of 1 step and a maximum of 256 steps. + # 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 see Step$ActionOnFailure. # # @return [Types::ModifyClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyClusterOutput#step_concurrency_level #step_concurrency_level} => Integer # @@ -2217,11 +2338,11 @@ # # @option params [required, String] :cluster_id # The unique identifier of the cluster. # # @option params [required, Types::InstanceFleetModifyConfig] :instance_fleet - # The unique identifier of the instance fleet. + # The configuration parameters of the instance fleet. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2403,11 +2524,11 @@ req = build_request(:put_auto_scaling_policy, params) req.send_request(options) end # Creates or updates an Amazon EMR block public access configuration for - # your AWS account in the current Region. For more information see + # your account in the current Region. For more information see # [Configure Block Public Access for Amazon EMR][1] in the *Amazon EMR # Management Guide*. # # # @@ -2630,14 +2751,13 @@ # @option params [String] :log_uri # The location in Amazon S3 to write the log files of the job flow. If a # value is not provided, logs are not created. # # @option params [String] :log_encryption_kms_key_id - # The AWS KMS customer master key (CMK) 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. + # 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. # # @option params [String] :additional_info # A JSON string for selecting additional features. # # @option params [String] :ami_version @@ -2738,24 +2858,36 @@ # @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. # # @option params [Boolean] :visible_to_all_users - # A value of `true` indicates that all IAM users in the AWS account can - # perform cluster actions if they have the proper IAM policy - # permissions. This is the default. A value of `false` indicates that - # only the IAM user who created the cluster can perform actions. + # Set this value to `true` so that IAM principals in the account + # associated with the cluster can perform EMR actions on the cluster + # that their IAM policies allow. This value defaults to `false` for + # clusters created using the EMR API or the CLI [create-cluster][1] + # command. # + # When set to `false`, only the IAM principal that created the cluster + # and the 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 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 + # # @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. # # @option params [String] :service_role # The IAM role that will be assumed by the Amazon EMR service to access - # AWS resources on your behalf. + # Amazon Web Services resources on your behalf. # # @option params [Array<Types::Tag>] :tags # A list of tags to associate with a cluster and propagate to Amazon EC2 # instances. # @@ -3157,29 +3289,36 @@ def set_termination_protection(params = {}, options = {}) req = build_request(:set_termination_protection, params) req.send_request(options) end - # Sets the Cluster$VisibleToAllUsers value, which determines whether the - # cluster is visible to all IAM users of the AWS account associated with - # the cluster. Only the IAM user who created the cluster or the AWS - # account root user can call this action. The default value, `true`, - # indicates that all IAM users in the AWS account can perform cluster - # actions if they have the proper IAM policy permissions. If set to - # `false`, only the IAM user that created the cluster can perform - # actions. This action works on running clusters. You can override the - # default `true` setting when you create a cluster by using the - # `VisibleToAllUsers` parameter with `RunJobFlow`. + # Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When + # `true`, IAM principals in the account can perform EMR cluster actions + # that their IAM policies allow. When `false`, only the IAM principal + # that created the cluster and the account root user can perform 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][1] in the *Amazon EMR Management Guide*. + # + # + # + # [1]: 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 all IAM users in the AWS account can - # perform cluster actions if they have the proper IAM policy - # permissions. This is the default. A value of `false` indicates that - # only the IAM user who created the cluster can perform actions. + # A value of `true` indicates that an IAM principal in the 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -3382,23 +3521,24 @@ # @option params [required, String] :studio_id # 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 - # specified. + # information, see [UserId][1] and [GroupId][2] in the *Amazon Web + # Services 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 # [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 or group to update. For more information, see - # [UserName][1] and [DisplayName][2] in the *AWS SSO Identity Store API - # Reference*. Either `IdentityName` or `IdentityId` must be specified. + # [UserName][1] and [DisplayName][2] in the *Amazon Web Services 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-UserName # [2]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName @@ -3442,10 +3582,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-emr' - context[:gem_version] = '1.45.0' + context[:gem_version] = '1.46.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #