- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GenerateCredentialReportCommand
Generates a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IAMClient, GenerateCredentialReportCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GenerateCredentialReportCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = {};
const command = new GenerateCredentialReportCommand(input);
const response = await client.send(command);
// { // GenerateCredentialReportResponse
// State: "STARTED" || "INPROGRESS" || "COMPLETE",
// Description: "STRING_VALUE",
// };
GenerateCredentialReportCommand Input
See GenerateCredentialReportCommandInput for more details
GenerateCredentialReportCommandInput GenerateCredentialReportCommand Output
See GenerateCredentialReportCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Description | string | undefined | Information about the credential report. |
State | ReportStateType | undefined | Information about the state of the credential report. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| LimitExceededException | client | The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded. |
| ServiceFailureException | server | The request processing has failed because of an unknown error, exception or failure. |
| IAMServiceException | Base exception class for all service exceptions from IAM service. |