[ aws . servicecatalog ]

list-record-history

Description

Lists the specified requests or all performed requests.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-record-history is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: RecordDetails

Synopsis

  list-record-history
[--accept-language <value>]
[--access-level-filter <value>]
[--search-filter <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--accept-language (string)

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

--access-level-filter (structure)

The access level to use to obtain results. The default is User .

Key -> (string)

The access level.

  • Account - Filter results based on the account.

  • Role - Filter results based on the federated role of the specified user.

  • User - Filter results based on the specified user.

Value -> (string)

The user to which the access level applies. The only supported value is Self .

Shorthand Syntax:

Key=string,Value=string

JSON Syntax:

{
  "Key": "Account"|"Role"|"User",
  "Value": "string"
}

--search-filter (structure)

The search filter to scope the results.

Key -> (string)

The filter key.

  • product - Filter results based on the specified product identifier.

  • provisionedproduct - Filter results based on the provisioned product identifier.

Value -> (string)

The filter value.

Shorthand Syntax:

Key=string,Value=string

JSON Syntax:

{
  "Key": "string",
  "Value": "string"
}

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

RecordDetails -> (list)

The records, in reverse chronological order.

(structure)

Information about a request operation.

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.

NextPageToken -> (string)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.