[ aws . servicecatalog ]

execute-provisioned-product-service-action

Description

Executes a self-service action against a provisioned product.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  execute-provisioned-product-service-action
--provisioned-product-id <value>
--service-action-id <value>
[--execute-token <value>]
[--accept-language <value>]
[--parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--provisioned-product-id (string)

The identifier of the provisioned product.

--service-action-id (string)

The self-service action identifier. For example, act-fs7abcd89wxyz .

--execute-token (string)

An idempotency token that uniquely identifies the execute request.

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--parameters (map)

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET , the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET .

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

RecordDetail -> (structure)

An object containing detailed information about the result of provisioning the product.

RecordId -> (string)

The identifier of the record.

ProvisionedProductName -> (string)

The user-friendly name of the provisioned product.

Status -> (string)

The status of the provisioned product.

• CREATED - The request was created but the operation has not started.

• IN_PROGRESS - The requested operation is in progress.

• IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

• SUCCEEDED - The requested operation has successfully completed.

• FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

CreatedTime -> (timestamp)

The UTC time stamp of the creation time.

UpdatedTime -> (timestamp)

The time when the record was last updated.

ProvisionedProductType -> (string)

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .

RecordType -> (string)

The record type.

• PROVISION_PRODUCT

• UPDATE_PROVISIONED_PRODUCT

• TERMINATE_PROVISIONED_PRODUCT

ProvisionedProductId -> (string)

The identifier of the provisioned product.

ProductId -> (string)

The product identifier.

ProvisioningArtifactId -> (string)

The identifier of the provisioning artifact.

PathId -> (string)

The path identifier.

RecordErrors -> (list)

The errors that occurred.

(structure)

The error code and description resulting from an operation.

Code -> (string)

The numeric value of the error.

Description -> (string)

The description of the error.

RecordTags -> (list)

One or more tags.

(structure)

Information about a tag, which is a key-value pair.

Key -> (string)

The key for this tag.

Value -> (string)

The value for this tag.

LaunchRoleArn -> (string)

The ARN of the launch role associated with the provisioned product.