Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProvisioningArtifact

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

Request Syntax


{
   "AcceptLanguage": "string",
   "Active": boolean,
   "Description": "string",
   "Guidance": "string",
   "Name": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

jp - Japanese
zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

Active

Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

Type: Boolean

Required: No

Description

The updated description of the provisioning artifact.

Type: String

Length Constraints: Maximum length of 8192.

Required: No

Guidance

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

Type: String

Valid Values: DEFAULT | DEPRECATED

Required: No

Name

The updated name of the provisioning artifact.

Type: String

Length Constraints: Maximum length of 8192.

Required: No

ProductId

The product identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

ProvisioningArtifactId

The identifier of the provisioning artifact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

Response Syntax


{
   "Info": { 
      "string" : "string" 
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Status": "string"
}