DescribeServiceActionCommand

Suggest an Edit

Describes a self-service action.

Example Syntax

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

import { ServiceCatalogClient, DescribeServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import
// const { ServiceCatalogClient, DescribeServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import
const client = new ServiceCatalogClient(config);
const input = { // DescribeServiceActionInput
  Id: "STRING_VALUE", // required
  AcceptLanguage: "STRING_VALUE",
};
const command = new DescribeServiceActionCommand(input);
const response = await client.send(command);
// { // DescribeServiceActionOutput
//   ServiceActionDetail: { // ServiceActionDetail
//     ServiceActionSummary: { // ServiceActionSummary
//       Id: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       DefinitionType: "SSM_AUTOMATION",
//     },
//     Definition: { // ServiceActionDefinitionMap
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

DescribeServiceActionCommand Input

See DescribeServiceActionCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The self-service action identifier.

AcceptLanguage
string | undefined

The language code.

  • jp - Japanese

  • zh - Chinese

DescribeServiceActionCommand Output

See DescribeServiceActionCommandOutput for details

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

Detailed information about the self-service action.

Throws

Name
Fault
Details
ResourceNotFoundException
client

The specified resource was not found.

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