SetVisibleToAllUsers - Amazon EMR

SetVisibleToAllUsers

Important

This API has been deprecated. You will receive an error if you use this action when creating a new cluster.

Sets the Cluster:VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the AWS account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the AWS 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 RunJobFlow:VisibleToAllUsers parameter.

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Request Syntax

{ "JobFlowIds": [ "string" ], "VisibleToAllUsers": boolean }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

JobFlowIds

The unique identifier of the job flow (cluster).

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

VisibleToAllUsers

A value of true indicates that an IAM principal in the AWS 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 AWS root user can perform EMR actions on the cluster.

Type: Boolean

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

Indicates that an error occurred while processing the request and that the request was not completed.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of SetVisibleToAllUsers.

Sample Request

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: ElasticMapReduce.SetVisibleToAllUsers Content-Length: 58 User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32 Host: us-east-1.elasticmapreduce.amazonaws.com X-Amz-Date: 20130715T221616Z X-Amz-Content-Sha256: 2ff32d11eab2383d764ffcb97571454e798689ecd09a7b1bb2327e22b0b930d4 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=e1a00b37787d9ccc43c9de32f1f0a73813b0bd6643d4db7762b62a7092d51997 Accept: */* { "JobFlowIds": ["j-ZKIY4CKQRX72"], "VisibleToAllUsers": true }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 2be9cde9-ed9c-11e2-82b6-2351cde3f33f Content-Type: application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 15 Jul 2013 22:16:18 GMT

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: