Class UpdateStudioComponentCommandProtected

Updates a studio component resource.

Example

Use a bare-bones client and the command you need to make an API call.

import { NimbleClient, UpdateStudioComponentCommand } from "@aws-sdk/client-nimble"; // ES Modules import
// const { NimbleClient, UpdateStudioComponentCommand } = require("@aws-sdk/client-nimble"); // CommonJS import
const client = new NimbleClient(config);
const input = { // UpdateStudioComponentRequest
  clientToken: "STRING_VALUE",
  configuration: { // StudioComponentConfiguration
    activeDirectoryConfiguration: { // ActiveDirectoryConfiguration
      computerAttributes: [ // ActiveDirectoryComputerAttributeList
        { // ActiveDirectoryComputerAttribute
          name: "STRING_VALUE",
          value: "STRING_VALUE",
        },
      ],
      directoryId: "STRING_VALUE",
      organizationalUnitDistinguishedName: "STRING_VALUE",
    },
    computeFarmConfiguration: { // ComputeFarmConfiguration
      activeDirectoryUser: "STRING_VALUE",
      endpoint: "STRING_VALUE",
    },
    licenseServiceConfiguration: { // LicenseServiceConfiguration
      endpoint: "STRING_VALUE",
    },
    sharedFileSystemConfiguration: { // SharedFileSystemConfiguration
      endpoint: "STRING_VALUE",
      fileSystemId: "STRING_VALUE",
      linuxMountPoint: "STRING_VALUE",
      shareName: "STRING_VALUE",
      windowsMountDrive: "STRING_VALUE",
    },
  },
  description: "STRING_VALUE",
  ec2SecurityGroupIds: [ // StudioComponentSecurityGroupIdList
    "STRING_VALUE",
  ],
  initializationScripts: [ // StudioComponentInitializationScriptList
    { // StudioComponentInitializationScript
      launchProfileProtocolVersion: "STRING_VALUE",
      platform: "LINUX" || "WINDOWS",
      runContext: "SYSTEM_INITIALIZATION" || "USER_INITIALIZATION",
      script: "STRING_VALUE",
    },
  ],
  name: "STRING_VALUE",
  scriptParameters: [ // StudioComponentScriptParameterKeyValueList
    { // ScriptParameterKeyValue
      key: "STRING_VALUE",
      value: "STRING_VALUE",
    },
  ],
  studioComponentId: "STRING_VALUE", // required
  studioId: "STRING_VALUE", // required
  subtype: "AWS_MANAGED_MICROSOFT_AD" || "AMAZON_FSX_FOR_WINDOWS" || "AMAZON_FSX_FOR_LUSTRE" || "CUSTOM",
  type: "ACTIVE_DIRECTORY" || "SHARED_FILE_SYSTEM" || "COMPUTE_FARM" || "LICENSE_SERVICE" || "CUSTOM",
  secureInitializationRoleArn: "STRING_VALUE",
  runtimeRoleArn: "STRING_VALUE",
};
const command = new UpdateStudioComponentCommand(input);
const response = await client.send(command);
// { // UpdateStudioComponentResponse
//   studioComponent: { // StudioComponent
//     arn: "STRING_VALUE",
//     configuration: { // StudioComponentConfiguration
//       activeDirectoryConfiguration: { // ActiveDirectoryConfiguration
//         computerAttributes: [ // ActiveDirectoryComputerAttributeList
//           { // ActiveDirectoryComputerAttribute
//             name: "STRING_VALUE",
//             value: "STRING_VALUE",
//           },
//         ],
//         directoryId: "STRING_VALUE",
//         organizationalUnitDistinguishedName: "STRING_VALUE",
//       },
//       computeFarmConfiguration: { // ComputeFarmConfiguration
//         activeDirectoryUser: "STRING_VALUE",
//         endpoint: "STRING_VALUE",
//       },
//       licenseServiceConfiguration: { // LicenseServiceConfiguration
//         endpoint: "STRING_VALUE",
//       },
//       sharedFileSystemConfiguration: { // SharedFileSystemConfiguration
//         endpoint: "STRING_VALUE",
//         fileSystemId: "STRING_VALUE",
//         linuxMountPoint: "STRING_VALUE",
//         shareName: "STRING_VALUE",
//         windowsMountDrive: "STRING_VALUE",
//       },
//     },
//     createdAt: new Date("TIMESTAMP"),
//     createdBy: "STRING_VALUE",
//     description: "STRING_VALUE",
//     ec2SecurityGroupIds: [ // StudioComponentSecurityGroupIdList
//       "STRING_VALUE",
//     ],
//     initializationScripts: [ // StudioComponentInitializationScriptList
//       { // StudioComponentInitializationScript
//         launchProfileProtocolVersion: "STRING_VALUE",
//         platform: "LINUX" || "WINDOWS",
//         runContext: "SYSTEM_INITIALIZATION" || "USER_INITIALIZATION",
//         script: "STRING_VALUE",
//       },
//     ],
//     name: "STRING_VALUE",
//     scriptParameters: [ // StudioComponentScriptParameterKeyValueList
//       { // ScriptParameterKeyValue
//         key: "STRING_VALUE",
//         value: "STRING_VALUE",
//       },
//     ],
//     state: "CREATE_IN_PROGRESS" || "READY" || "UPDATE_IN_PROGRESS" || "DELETE_IN_PROGRESS" || "DELETED" || "DELETE_FAILED" || "CREATE_FAILED" || "UPDATE_FAILED",
//     statusCode: "ACTIVE_DIRECTORY_ALREADY_EXISTS" || "STUDIO_COMPONENT_CREATED" || "STUDIO_COMPONENT_UPDATED" || "STUDIO_COMPONENT_DELETED" || "ENCRYPTION_KEY_ACCESS_DENIED" || "ENCRYPTION_KEY_NOT_FOUND" || "STUDIO_COMPONENT_CREATE_IN_PROGRESS" || "STUDIO_COMPONENT_UPDATE_IN_PROGRESS" || "STUDIO_COMPONENT_DELETE_IN_PROGRESS" || "INTERNAL_ERROR",
//     statusMessage: "STRING_VALUE",
//     studioComponentId: "STRING_VALUE",
//     subtype: "AWS_MANAGED_MICROSOFT_AD" || "AMAZON_FSX_FOR_WINDOWS" || "AMAZON_FSX_FOR_LUSTRE" || "CUSTOM",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     type: "ACTIVE_DIRECTORY" || "SHARED_FILE_SYSTEM" || "COMPUTE_FARM" || "LICENSE_SERVICE" || "CUSTOM",
//     updatedAt: new Date("TIMESTAMP"),
//     updatedBy: "STRING_VALUE",
//     secureInitializationRoleArn: "STRING_VALUE",
//     runtimeRoleArn: "STRING_VALUE",
//   },
// };

Param

UpdateStudioComponentCommandInput

Returns

UpdateStudioComponentCommandOutput

See

• UpdateStudioComponentCommandInput for command's input shape.
• UpdateStudioComponentCommandOutput for command's response shape.
• config for NimbleClient's config shape.

Throws

AccessDeniedException (client fault)

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

Throws

ConflictException (client fault)

Another operation is in progress.

Throws

InternalServerErrorException (server fault)

An internal error has occurred. Please retry your request.

Throws

ResourceNotFoundException (client fault)

The specified resource could not be found.

Throws

ServiceQuotaExceededException (client fault)

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

Throws

ThrottlingException (client fault)

The request throughput limit was exceeded.

Throws

ValidationException (client fault)

One of the parameters in the request is invalid.

Throws

NimbleServiceException

Base exception class for all service exceptions from Nimble service.