Nimble Studio examples using Amazon CLI - Amazon Command Line Interface
Actions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Nimble Studio examples using Amazon CLI

The following code examples show you how to perform actions and implement common scenarios by using the Amazon Command Line Interface with Nimble Studio.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios and cross-service examples.

Scenarios are code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

Each example includes a link to GitHub, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use get-eula.

Amazon CLI

To get information about your studio

The following get-eula example lists the information about an EULA.

aws nimble get-eula \
    --eula-id "EULAid"

Output:

{
    "eula": {
        "content": "https://www.mozilla.org/en-US/MPL/2.0/",
        "createdAt": "2021-04-20T16:45:23+00:00",
        "eulaId": "gJZLygd-Srq_5NNbSfiaLg",
        "name": "Mozilla-FireFox",
        "updatedAt": "2021-04-20T16:45:23+00:00"
    }
}

For more information, see Accept the EULA in the Amazon Nimble Studio User Guide.

  • For API details, see GetEula in Amazon CLI Command Reference.

The following code example shows how to use get-launch-profile-details.

Amazon CLI

To list the available widgets

The following get-launch-profile-details example lists the details about a launch profile.

aws nimble get-launch-profile-details \
    --studio-id "StudioID" \
    --launch-profile-id "LaunchProfileID"

Output:

{
    "launchProfile": {
        "arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/yeG7lDwNQEiwNTRT7DrV7Q",
        "createdAt": "2022-01-27T21:18:59+00:00",
        "createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
        "description": "The Launch Profile for the Render workers created by StudioBuilder.",
        "ec2SubnetIds": [
            "subnet-EXAMPLE11111"
        ],
        "launchProfileId": "yeG7lDwNQEiwNTRT7DrV7Q",
        "launchProfileProtocolVersions": [
            "2021-03-31"
        ],
        "name": "RenderWorker-Default",
        "state": "READY",
        "statusCode": "LAUNCH_PROFILE_CREATED",
        "statusMessage": "Launch Profile has been created",
        "streamConfiguration": {
            "clipboardMode": "ENABLED",
            "ec2InstanceTypes": [
                "g4dn.4xlarge",
                "g4dn.8xlarge"
            ],
            "maxSessionLengthInMinutes": 690,
            "maxStoppedSessionLengthInMinutes": 0,
            "streamingImageIds": [
                "Cw_jXnp1QcSSXhE2hkNRoQ",
                "YGXAqgoWTnCNSV8VP20sHQ"
            ]
        },
        "studioComponentIds": [
            "_hR_-RaAReSOjAnLakbX7Q",
            "vQ5w_TbIRayPkAZgcbyYRA",
            "ZQuMxN99Qfa_Js6ma9TwdA",
            "45KjOSPPRzK2OyvpCuQ6qw"
        ],
        "tags": {
            "resourceArn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/yeG7lDwNQEiwNTRT7DrV7Q"
        },
        "updatedAt": "2022-01-27T21:19:13+00:00",
        "updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-00b98256b04d9e989",
        "validationResults": [
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_SUBNET_ASSOCIATION"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
            }
        ]
    },
    "streamingImages": [
        {
            "arn": "arn:aws:nimble:us-west-2:123456789012:streaming-image/Cw_jXnp1QcSSXhE2hkNRoQ",
            "description": "Base windows image for NimbleStudio",
            "ec2ImageId": "ami-EXAMPLE11111",
            "eulaIds": [
                "gJZLygd-Srq_5NNbSfiaLg",
                "ggK2eIw6RQyt8PIeeOlD3g",
                "a-D9Wc0VQCKUfxAinCDxaw",
                "RvoNmVXiSrS4LhLTb6ybkw",
                "wtp85BcSTa2NZeNRnMKdjw",
                "Rl-J0fM5Sl2hyIiwWIV6hw"
            ],
            "name": "NimbleStudioWindowsStreamImage",
            "owner": "amazon",
            "platform": "WINDOWS",
            "state": "READY",
            "streamingImageId": "Cw_jXnp1QcSSXhE2hkNRoQ",
            "tags": {
                "resourceArn": "arn:aws:nimble:us-west-2:123456789012:streaming-image/Cw_jXnp1QcSSXhE2hkNRoQ"
            }
        },
        {
            "arn": "arn:aws:nimble:us-west-2:123456789012:streaming-image/YGXAqgoWTnCNSV8VP20sHQ",
            "description": "Base linux image for NimbleStudio",
            "ec2ImageId": "ami-EXAMPLE11111",
            "eulaIds": [
                "gJZLygd-Srq_5NNbSfiaLg",
                "ggK2eIw6RQyt8PIeeOlD3g",
                "a-D9Wc0VQCKUfxAinCDxaw",
                "RvoNmVXiSrS4LhLTb6ybkw",
                "wtp85BcSTa2NZeNRnMKdjw",
                "Rl-J0fM5Sl2hyIiwWIV6hw"
            ],
            "name": "NimbleStudioLinuxStreamImage",
            "owner": "amazon",
            "platform": "LINUX",
            "state": "READY",
            "streamingImageId": "YGXAqgoWTnCNSV8VP20sHQ",
            "tags": {
                "resourceArn": "arn:aws:nimble:us-west-2:123456789012:streaming-image/YGXAqgoWTnCNSV8VP20sHQ"
            }
        }
    ],
    "studioComponentSummaries": [
        {
            "description": "FSx for Windows",
            "name": "FSxWindows",
            "studioComponentId": "ZQuMxN99Qfa_Js6ma9TwdA",
            "subtype": "AMAZON_FSX_FOR_WINDOWS",
            "type": "SHARED_FILE_SYSTEM"
        },
        {
            "description": "Instance configuration studio component.",
            "name": "InstanceConfiguration",
            "studioComponentId": "vQ5w_TbIRayPkAZgcbyYRA",
            "subtype": "CUSTOM",
            "type": "CUSTOM"
        },
        {
            "name": "ActiveDirectory",
            "studioComponentId": "_hR_-RaAReSOjAnLakbX7Q",
            "subtype": "AWS_MANAGED_MICROSOFT_AD",
            "type": "ACTIVE_DIRECTORY"
        },
        {
            "description": "Render farm running Deadline",
            "name": "RenderFarm",
            "studioComponentId": "45KjOSPPRzK2OyvpCuQ6qw",
            "subtype": "CUSTOM",
            "type": "COMPUTE_FARM"
        }
    ]
}

For more information, see Creating launch profiles in the Amazon Nimble Studio User Guide.

The following code example shows how to use get-launch-profile.

Amazon CLI

To list the available widgets

The following get-launch-profile example lists information about a launch profile.

aws nimble get-launch-profile \
    --studio-id "StudioID" \
    --launch-profile-id "LaunchProfileID"

Output:

{
    "launchProfile": {
        "arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/yeG7lDwNQEiwNTRT7DrV7Q",
        "createdAt": "2022-01-27T21:18:59+00:00",
        "createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
        "description": "The Launch Profile for the Render workers created by StudioBuilder.",
        "ec2SubnetIds": [
            "subnet-EXAMPLE11111"
        ],
        "launchProfileId": "yeG7lDwNQEiwNTRT7DrV7Q",
        "launchProfileProtocolVersions": [
            "2021-03-31"
        ],
        "name": "RenderWorker-Default",
        "state": "READY",
        "statusCode": "LAUNCH_PROFILE_CREATED",
        "statusMessage": "Launch Profile has been created",
        "streamConfiguration": {
            "clipboardMode": "ENABLED",
            "ec2InstanceTypes": [
                "g4dn.4xlarge",
                "g4dn.8xlarge"
            ],
            "maxSessionLengthInMinutes": 690,
            "maxStoppedSessionLengthInMinutes": 0,
            "streamingImageIds": [
                "Cw_jXnp1QcSSXhE2hkNRoQ",
                "YGXAqgoWTnCNSV8VP20sHQ"
            ]
        },
        "studioComponentIds": [
            "_hR_-RaAReSOjAnLakbX7Q",
            "vQ5w_TbIRayPkAZgcbyYRA",
            "ZQuMxN99Qfa_Js6ma9TwdA",
            "45KjOSPPRzK2OyvpCuQ6qw"
        ],
        "tags": {},
        "updatedAt": "2022-01-27T21:19:13+00:00",
        "updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-00b98256b04d9e989",
        "validationResults": [
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_SUBNET_ASSOCIATION"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
            },
            {
                "state": "VALIDATION_SUCCESS",
                "statusCode": "VALIDATION_SUCCESS",
                "statusMessage": "The validation succeeded.",
                "type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
            }
        ]
    }
}

For more information, see Creating launch profiles in the Amazon Nimble Studio User Guide.

The following code example shows how to use get-studio.

Amazon CLI

To get information about your studio

The following get-studio example lists the studios in your Amazon 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.

  • For API details, see GetStudio in Amazon CLI Command Reference.

The following code example shows how to use list-eula-acceptances.

Amazon CLI

To list the available widgets

The following list-eula-acceptances example lists the accepted EULAs in your Amazon account.

aws nimble list-eula-acceptances \
    --studio-id "StudioID"

Output:

{
    "eulaAcceptances": [
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "V0JlpZQaSx6yHcUuX0qfQw",
            "eulaId": "Rl-J0fM5Sl2hyIiwWIV6hw"
        },
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "YY_uDFW-SVibc627qbug0Q",
            "eulaId": "RvoNmVXiSrS4LhLTb6ybkw"
        },
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "ovO87PnhQ4-MpttiL5uN6Q",
            "eulaId": "a-D9Wc0VQCKUfxAinCDxaw"
        },
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "5YeXje4yROamuTESGvqIAQ",
            "eulaId": "gJZLygd-Srq_5NNbSfiaLg"
        },
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "W1sIn8PtScqeJEn8sxxhgw",
            "eulaId": "ggK2eIw6RQyt8PIeeOlD3g"
        },
        {
            "acceptedAt": "2022-01-28T17:44:35+00:00",
            "acceptedBy": "92677b4b19-e9fd012a-94ad-4f16-9866-c69a63ab6486",
            "accepteeId": "us-west-2:stid-nyoqq12fteqy1x48",
            "eulaAcceptanceId": "Zq9KNEQPRMWJ7FolSoQgUA",
            "eulaId": "wtp85BcSTa2NZeNRnMKdjw"
        }
    ]
}

For more information, see Accept the EULA in the Amazon Nimble Studio User Guide.

The following code example shows how to use list-eulas.

Amazon CLI

To list the available widgets

The following list-eulas example lists the EULAs in your Amazon account.

aws nimble list-eulas

Output:

{
    "eulas": [
        {
            "content": "https://www.mozilla.org/en-US/MPL/2.0/",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "gJZLygd-Srq_5NNbSfiaLg",
            "name": "Mozilla-FireFox",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        },
        {
            "content": "https://www.awsthinkbox.com/end-user-license-agreement",
            "createdAt": "2021-04-20T16:45:24+00:00",
            "eulaId": "RvoNmVXiSrS4LhLTb6ybkw",
            "name": "Thinkbox-Deadline",
            "updatedAt": "2021-04-20T16:45:24+00:00"
        },
        {
            "content": "https://www.videolan.org/legal.html",
            "createdAt": "2021-04-20T16:45:24+00:00",
            "eulaId": "Rl-J0fM5Sl2hyIiwWIV6hw",
            "name": "Videolan-VLC",
            "updatedAt": "2021-04-20T16:45:24+00:00"
        },
        {
            "content": "https://code.visualstudio.com/license",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "ggK2eIw6RQyt8PIeeOlD3g",
            "name": "Microsoft-VSCode",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        },
        {
            "content": "https://darbyjohnston.github.io/DJV/legal.html#License",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "wtp85BcSTa2NZeNRnMKdjw",
            "name": "DJV-DJV",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        },
        {
            "content": "https://www.sidefx.com/legal/license-agreement/",
            "createdAt": "2021-04-20T16:45:24+00:00",
            "eulaId": "uu2VDLo-QJeIGWWLBae_UA",
            "name": "SideFX-Houdini",
            "updatedAt": "2021-04-20T16:45:24+00:00"
        },
        {
            "content": "https://www.chaosgroup.com/eula",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "L0HS4P3CRYKVXc2J2LO7Vw",
            "name": "ChaosGroup-Vray",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        },
        {
            "content": "https://www.foundry.com/eula",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "SAuhfHmmSAeUuq3wsMiMlw",
            "name": "Foundry-Nuke",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        },
        {
            "content": "https://download.blender.org/release/GPL3-license.txt",
            "createdAt": "2021-04-20T16:45:23+00:00",
            "eulaId": "a-D9Wc0VQCKUfxAinCDxaw",
            "name": "BlenderFoundation-Blender",
            "updatedAt": "2021-04-20T16:45:23+00:00"
        }
    ]
}

For more information, see Accept the EULA in the Amazon Nimble Studio User Guide.

  • For API details, see ListEulas in Amazon CLI Command Reference.

The following code example shows how to use list-launch-profiles.

Amazon CLI

To list the available widgets

The following list-launch-profiles example lists the launch profiles in your Amazon account.

aws nimble list-launch-profiles \
    --studio-id "StudioID"

Output:

{
    "launchProfiles": [
        {
            "arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/yeG7lDwNQEiwNTRT7DrV7Q",
            "createdAt": "2022-01-27T21:18:59+00:00",
            "createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
            "description": "The Launch Profile for the Render workers created by StudioBuilder.",
            "ec2SubnetIds": [
                "subnet-EXAMPLE11111"
            ],
            "launchProfileId": "yeG7lDwNQEiwNTRT7DrV7Q",
            "launchProfileProtocolVersions": [
                "2021-03-31"
            ],
            "name": "RenderWorker-Default",
            "state": "READY",
            "statusCode": "LAUNCH_PROFILE_CREATED",
            "statusMessage": "Launch Profile has been created",
            "streamConfiguration": {
                "clipboardMode": "ENABLED",
                "ec2InstanceTypes": [
                    "g4dn.4xlarge",
                    "g4dn.8xlarge"
                ],
                "maxSessionLengthInMinutes": 690,
                "maxStoppedSessionLengthInMinutes": 0,
                "streamingImageIds": [
                    "Cw_jXnp1QcSSXhE2hkNRoQ",
                    "YGXAqgoWTnCNSV8VP20sHQ"
                ]
            },
            "studioComponentIds": [
                "_hR_-RaAReSOjAnLakbX7Q",
                "vQ5w_TbIRayPkAZgcbyYRA",
                "ZQuMxN99Qfa_Js6ma9TwdA",
                "45KjOSPPRzK2OyvpCuQ6qw"
            ],
            "tags": {},
            "updatedAt": "2022-01-27T21:19:13+00:00",
            "updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
            "validationResults": [
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_SUBNET_ASSOCIATION"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
                }
            ]
        },
        {
            "arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/jDCIm1jRSaa9e44PZ3w7gg",
            "createdAt": "2022-01-27T21:19:26+00:00",
            "createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
            "description": "This Workstation Launch Profile was created by StudioBuilder",
            "ec2SubnetIds": [
                "subnet-046f4205ae535b2cc"
            ],
            "launchProfileId": "jDCIm1jRSaa9e44PZ3w7gg",
            "launchProfileProtocolVersions": [
                "2021-03-31"
            ],
            "name": "Workstation-Default",
            "state": "READY",
            "statusCode": "LAUNCH_PROFILE_CREATED",
            "statusMessage": "Launch Profile has been created",
            "streamConfiguration": {
                "clipboardMode": "ENABLED",
                "ec2InstanceTypes": [
                    "g4dn.4xlarge",
                    "g4dn.8xlarge"
                ],
                "maxSessionLengthInMinutes": 690,
                "maxStoppedSessionLengthInMinutes": 0,
                "streamingImageIds": [
                    "Cw_jXnp1QcSSXhE2hkNRoQ",
                    "YGXAqgoWTnCNSV8VP20sHQ"
                ]
            },
            "studioComponentIds": [
                "_hR_-RaAReSOjAnLakbX7Q",
                "vQ5w_TbIRayPkAZgcbyYRA",
                "ZQuMxN99Qfa_Js6ma9TwdA",
                "yJSbsHXAQYWk9FXLNusXlQ",
                "45KjOSPPRzK2OyvpCuQ6qw"
            ],
            "tags": {},
            "updatedAt": "2022-01-27T21:19:40+00:00",
            "updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
            "validationResults": [
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_SUBNET_ASSOCIATION"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
                },
                {
                    "state": "VALIDATION_SUCCESS",
                    "statusCode": "VALIDATION_SUCCESS",
                    "statusMessage": "The validation succeeded.",
                    "type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
                }
            ]
        }
    ]
}

For more information, see Creating launch profiles in the Amazon Nimble Studio User Guide.

The following code example shows how to use list-studio-components.

Amazon CLI

To list the available widgets

The following list-studio-components example lists the studio components in your Amazon account.

aws nimble list-studio-components \
    --studio-id "StudioID"

Output:

{
    "studioComponents": [
        {
            "arn": "arn:aws:nimble:us-west-2:123456789012:studio-component/ZQuMxN99Qfa_Js6ma9TwdA",
            "configuration": {
                "sharedFileSystemConfiguration": {
                    "fileSystemId": "fs-EXAMPLE11111",
                    "linuxMountPoint": "/mnt/fsxshare",
                    "shareName": "share",
                    "windowsMountDrive": "Z"
                }
            },
            "createdAt": "2022-01-27T21:15:34+00:00",
            "createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
            "description": "FSx for Windows",
            "ec2SecurityGroupIds": [
                "sg-EXAMPLE11111"
            ],
            "name": "FSxWindows",
            "state": "READY",
            "statusCode": "STUDIO_COMPONENT_CREATED",
            "statusMessage": "Studio Component has been created",
            "studioComponentId": "ZQuMxN99Qfa_Js6ma9TwdA",
            "subtype": "AMAZON_FSX_FOR_WINDOWS",
            "tags": {},
            "type": "SHARED_FILE_SYSTEM",
            "updatedAt": "2022-01-27T21:15:35+00:00",
            "updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111"
        },
    ...
}

For more information, see How StudioBuilder works with Amazon Nimble Studio in the Amazon Nimble Studio User Guide.

The following code example shows how to use list-studio-members.

Amazon CLI

To list the available widgets

The following list-studio-members example lists the available studio members in your Amazon account.

aws nimble list-studio-members \
    --studio-id "StudioID"

Output:

{
    "members": [
        {
            "identityStoreId": "d-EXAMPLE11111",
            "persona": "ADMINISTRATOR",
            "principalId": "EXAMPLE11111-e9fd012a-94ad-4f16-9866-c69a63ab6486"
        }
    ]
}

For more information, see Adding studio users in the Amazon Nimble Studio User Guide.

The following code example shows how to use list-studios.

Amazon CLI

To list your studios

The following list-studios example lists the studios in your Amazon account.

aws nimble list-studios

Output:

{
    "studios": [
        {
            "adminRoleArn": "arn:aws:iam::123456789012:role/studio-admin-role",
            "arn": "arn:aws:nimble:us-west-2:123456789012:studio/studio-id",
            "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:studio-id",
            "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.

  • For API details, see ListStudios in Amazon CLI Command Reference.