update-studio¶
Description¶
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-studio
[--admin-role-arn <value>]
[--client-token <value>]
[--display-name <value>]
--studio-id <value>
[--user-role-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--admin-role-arn (string)
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
--client-token (string)
To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.
--display-name (string)
A friendly name for the studio.
--studio-id (string)
The studio ID.
--user-role-arn (string)
The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
studio -> (structure)
Information about a studio.
adminRoleArn -> (string)
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
arn -> (string)
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
createdAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was created.
displayName -> (string)
A friendly name for the studio.
homeRegion -> (string)
The Amazon Web Services Region where the studio resource is located.
ssoClientId -> (string)
The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble portal.
state -> (string)
The current state of the studio resource.
statusCode -> (string)
Status codes that provide additional detail on the studio state.
statusMessage -> (string)
Additional detail on the studio state.
studioEncryptionConfiguration -> (structure)
Configuration of the encryption method that is used for the studio.
keyArn -> (string)
The ARN for a KMS key that is used to encrypt studio data.
keyType -> (string)
The type of KMS key that is used to encrypt studio data.
studioId -> (string)
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
studioName -> (string)
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
studioUrl -> (string)
The address of the web page for the studio.
tags -> (map)
A collection of labels, in the form of key:value pairs, that apply to this resource.
key -> (string)
value -> (string)
updatedAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was updated.
userRoleArn -> (string)
The IAM role that studio users assume when logging in to the Nimble Studio portal.