Class ListConfigurationProfilesCommandProtected

Lists the configuration profiles for an application.

Example

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

import { AppConfigClient, ListConfigurationProfilesCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
// const { AppConfigClient, ListConfigurationProfilesCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
const client = new AppConfigClient(config);
const input = { // ListConfigurationProfilesRequest
  ApplicationId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  Type: "STRING_VALUE",
};
const command = new ListConfigurationProfilesCommand(input);
const response = await client.send(command);
// { // ConfigurationProfiles
//   Items: [ // ConfigurationProfileSummaryList
//     { // ConfigurationProfileSummary
//       ApplicationId: "STRING_VALUE",
//       Id: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       LocationUri: "STRING_VALUE",
//       ValidatorTypes: [ // ValidatorTypeList
//         "JSON_SCHEMA" || "LAMBDA",
//       ],
//       Type: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListConfigurationProfilesCommandInput

Returns

ListConfigurationProfilesCommandOutput

See

• ListConfigurationProfilesCommandInput for command's input shape.
• ListConfigurationProfilesCommandOutput for command's response shape.
• config for AppConfigClient's config shape.

Throws

BadRequestException (client fault)

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Throws

InternalServerException (server fault)

There was an internal failure in the AppConfig service.

Throws

ResourceNotFoundException (client fault)

The requested resource could not be found.

Throws

AppConfigServiceException

Base exception class for all service exceptions from AppConfig service.

Example

To list the available configuration profiles

// The following list-configuration-profiles example lists the available configuration profiles for the specified application.
const input = {
  "ApplicationId": "339ohji"
};
const command = new ListConfigurationProfilesCommand(input);
const response = await client.send(command);
/* response ==
{
  "Items": [
    {
      "ApplicationId": "339ohji",
      "Id": "ur8hx2f",
      "LocationUri": "ssm-parameter://Example-Parameter",
      "Name": "Example-Configuration-Profile"
    }
  ]
}
*/
// example id: to-list-the-available-configuration-profiles-1632267193265