SetVisibleToAllUsers
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
.
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 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 offalse
indicates that only the IAM user who created the cluster can perform actions.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: