Skip to content

IAM  >  Operations  >  generate_credential_report

generate_credential_report

Operation

generate_credential_report async

generate_credential_report(request: GenerateCredentialReportInput | GenerateCredentialReportInputDict, /, *, plugins: list[Plugin] | None = None) -> GenerateCredentialReportOutput
generate_credential_report(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GenerateCredentialReportInputDict]) -> GenerateCredentialReportOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GenerateCredentialReportOutput

An instance of GenerateCredentialReportOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

GenerateCredentialReportInput dataclass

Bases: _SerdeShape

Dataclass for GenerateCredentialReportInput structure.

Dictionaries

GenerateCredentialReportInputDict

Bases: TypedDict

Dictionary form of GenerateCredentialReportInput.

Output

GenerateCredentialReportOutput dataclass

Bases: _SerdeShape

Contains the response to a successful GenerateCredentialReport request.

Attributes

description class-attribute instance-attribute
description: str | None = ...

Information about the credential report.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

state class-attribute instance-attribute
state: str | None = ...

Information about the state of the credential report.