PATCH

/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}

http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}

Updates a studio component resource.

Access Token Required: API Key

Path Parameters

studioComponentIdstringrequired

The studio component ID.

studioIdstringrequired

The studio ID.

Body Params

namestring

The name for the studio component.

typestring

The type of the studio component.

subtypestring

The specific subtype of a studio component.

descriptionstring

The description.

configurationobject

The configuration of the studio component, based on component type.

runtimeRoleArnstring

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

scriptParametersarray

Parameters for the studio component scripts.

ec2SecurityGroupIdsarray

The EC2 security groups that control access to the studio component.

initializationScriptsarray

Initialization scripts for studio components.

secureInitializationRoleArnstring

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://nimble.{region}.amazonaws.com/2020-08-01/studios/{studioId}/studio-components/{studioComponentId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}