Skip to content

IAM  >  Operations  >  get_credential_report

get_credential_report

Operation

get_credential_report async 

get_credential_report(input: GetCredentialReportInput, plugins: list[Plugin] | None = None) -> GetCredentialReportOutput

Retrieves 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
input GetCredentialReportInput

An instance of GetCredentialReportInput.

 required
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
GetCredentialReportOutput

An instance of GetCredentialReportOutput.

Input

GetCredentialReportInput dataclass

Bases: _SerdeShape

Dataclass for GetCredentialReportInput structure.

Output

GetCredentialReportOutput dataclass

Bases: _SerdeShape

Contains the response to a successful GetCredentialReport request.

Attributes

content class-attribute instance-attribute 
content: bytes | None = ...

Contains the credential report. The report is Base64-encoded.

generated_time class-attribute instance-attribute 
generated_time: datetime | None = ...

The date and time when the credential report was created, in ISO 8601 date-time format.

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

The format (MIME type) of 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.