GenerateCredentialReport - AWS Identity and Access Management

GenerateCredentialReport

Generates a credential report for the AWS account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

Response Syntax

{ "Description": "string", "State": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Description

Information about the credential report.

Type: String

State

Information about the state of the credential report.

Type: String

Valid Values: STARTED | INPROGRESS | COMPLETE

Errors

For information about the errors that are common to all actions, see Common Errors.

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

HTTP Status Code: 400

ServiceFailureException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GenerateCredentialReport.

Sample Request

https://iam.amazonaws.com/?Action=GenerateCredentialReport &Version=2010-05-08 &AUTHPARAMS

Sample Response

<GenerateCredentialReportResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <GenerateCredentialReportResult> <Description>No report exists. Starting a new report generation task</Description> <State>STARTED</State> </GenerateCredentialReportResult> <ResponseMetadata> <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId> </ResponseMetadata> </GenerateCredentialReportResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: