Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class GetConfigurationProfileCommandProtected

Retrieves information about a configuration profile.

Example

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

import { AppConfigClient, GetConfigurationProfileCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
// const { AppConfigClient, GetConfigurationProfileCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
const client = new AppConfigClient(config);
const input = { // GetConfigurationProfileRequest
ApplicationId: "STRING_VALUE", // required
ConfigurationProfileId: "STRING_VALUE", // required
};
const command = new GetConfigurationProfileCommand(input);
const response = await client.send(command);
// { // ConfigurationProfile
// ApplicationId: "STRING_VALUE",
// Id: "STRING_VALUE",
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// LocationUri: "STRING_VALUE",
// RetrievalRoleArn: "STRING_VALUE",
// Validators: [ // ValidatorList
// { // Validator
// Type: "JSON_SCHEMA" || "LAMBDA", // required
// Content: "STRING_VALUE", // required
// },
// ],
// Type: "STRING_VALUE",
// };

Param

GetConfigurationProfileCommandInput

Returns

GetConfigurationProfileCommandOutput

See

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 retrieve configuration profile details

// The following get-configuration-profile example returns the details of the specified configuration profile.
const input = {
"ApplicationId": "339ohji",
"ConfigurationProfileId": "ur8hx2f"
};
const command = new GetConfigurationProfileCommand(input);
const response = await client.send(command);
/* response ==
{
"ApplicationId": "339ohji",
"Id": "ur8hx2f",
"LocationUri": "ssm-parameter://Example-Parameter",
"Name": "Example-Configuration-Profile",
"RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role"
}
*/
// example id: to-retrieve-configuration-profile-details-1632266081013

Hierarchy

Constructors

Properties

Methods