Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateInstance

Enables you to programmatically update an AWS Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.

Request Syntax


PATCH /api/instance/instanceId HTTP/1.1
Content-type: application/json

{
   "instanceDescription": "string",
   "instanceName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

instanceId

The AWS Supply Chain instance identifier.

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

instanceDescription

The AWS Supply Chain instance description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 501.

Pattern: ([a-zA-Z0-9., _ʼ'%-]){0,500}

Required: No

instanceName

The AWS Supply Chain instance name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9]

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "instance": { 
      "awsAccountId": "string",
      "createdTime": number,
      "errorMessage": "string",
      "instanceDescription": "string",
      "instanceId": "string",
      "instanceName": "string",
      "kmsKeyArn": "string",
      "lastModifiedTime": number,
      "state": "string",
      "versionNumber": number,
      "webAppDnsDomain": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

instance

The instance resource data details.

Type: Instance object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have the required privileges to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400