GetProvisionedProductOutputsCommand

Suggest an Edit

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ServiceCatalogClient, GetProvisionedProductOutputsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import
// const { ServiceCatalogClient, GetProvisionedProductOutputsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import
const client = new ServiceCatalogClient(config);
const input = { // GetProvisionedProductOutputsInput
  AcceptLanguage: "STRING_VALUE",
  ProvisionedProductId: "STRING_VALUE",
  ProvisionedProductName: "STRING_VALUE",
  OutputKeys: [ // OutputKeys
    "STRING_VALUE",
  ],
  PageSize: Number("int"),
  PageToken: "STRING_VALUE",
};
const command = new GetProvisionedProductOutputsCommand(input);
const response = await client.send(command);
// { // GetProvisionedProductOutputsOutput
//   Outputs: [ // RecordOutputs
//     { // RecordOutput
//       OutputKey: "STRING_VALUE",
//       OutputValue: "STRING_VALUE",
//       Description: "STRING_VALUE",
//     },
//   ],
//   NextPageToken: "STRING_VALUE",
// };

GetProvisionedProductOutputsCommand Input

See GetProvisionedProductOutputsCommandInput for more details

Parameter
Type
Description
AcceptLanguage
string | undefined

The language code.

  • jp - Japanese

  • zh - Chinese

OutputKeys
string[] | undefined

The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

PageSize
number | undefined

The maximum number of items to return with this call.

PageToken
string | undefined

The page token for the next set of results. To retrieve the first set of results, use null.

ProvisionedProductId
string | undefined

The identifier of the provisioned product that you want the outputs from.

ProvisionedProductName
string | undefined

The name of the provisioned product that you want the outputs from.

GetProvisionedProductOutputsCommand Output

See GetProvisionedProductOutputsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextPageToken
string | undefined

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

Outputs
RecordOutput[] | undefined

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

Throws

Name
Fault
Details
InvalidParametersException
client

One or more parameters provided to the operation are not valid.

ResourceNotFoundException
client

The specified resource was not found.

ServiceCatalogServiceException
Base exception class for all service exceptions from ServiceCatalog service.