Instance - AWS Supply Chain

Instance

The details of the instance.

Contents

awsAccountId

The AWS account ID that owns the instance.

Type: String

Pattern: [0-9]{12}

Required: Yes

instanceId

The AWS Supply Chain instance identifier.

Type: String

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

state

The state of the instance.

Type: String

Valid Values: Initializing | Active | CreateFailed | DeleteFailed | Deleting | Deleted

Required: Yes

createdTime

The instance creation timestamp.

Type: Timestamp

Required: No

errorMessage

The AWS Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

Type: String

Required: No

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

kmsKeyArn

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the AWS owned KMS key and nothing is returned.

Type: String

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

Pattern: arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:key/.{0,1019}

Required: No

lastModifiedTime

The instance last modified timestamp.

Type: Timestamp

Required: No

versionNumber

The version number of the instance.

Type: Double

Required: No

webAppDnsDomain

The WebApp DNS domain name of the instance.

Type: String

Pattern: [A-Za-z0-9]+(.[A-Za-z0-9]+)+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: