get-studio¶

Description¶

Get a Studio resource.

Synopsis¶

  get-studio
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--studio-id (string)

The studio ID.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about your studio

The following get-studio example lists the studios in your AWS account.

aws nimble get-studio \
    --studio-id "StudioID"

Output:

{
    "studio": {
        "adminRoleArn": "arn:aws:iam::123456789012:role/studio-admin-role",
        "arn": "arn:aws:nimble:us-west-2:123456789012:studio/stid-EXAMPLE11111",
        "createdAt": "2022-01-27T20:29:35+00:00",
        "displayName": "studio-name",
        "homeRegion": "us-west-2",
        "ssoClientId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "state": "READY",
        "statusCode": "STUDIO_CREATED",
        "statusMessage": "The studio has been created successfully ",
        "studioEncryptionConfiguration": {
            "keyType": "AWS_OWNED_KEY"
        },
        "studioId": "us-west-2:stid-EXAMPLE11111",
        "studioName": "studio-name",
        "studioUrl": "https://studio-name.nimblestudio.us-west-2.amazonaws.com",
        "tags": {},
        "updatedAt": "2022-01-27T20:29:37+00:00",
        "userRoleArn": "arn:aws:iam::123456789012:role/studio-user-role"
    }
}

For more information, see What is Amazon Nimble Studio? in the Amazon Nimble Studio User Guide.

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 Studio 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.

Table of Contents

Feedback

User Guide