Skip to content

get_credential_report

Operation

get_credential_report

get_credential_report(request: GetCredentialReportInput | GetCredentialReportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCredentialReportInputDict]) -> 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
request GetCredentialReportInput | GetCredentialReportInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetCredentialReportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCredentialReportOutput

An instance of GetCredentialReportOutput.

get_credential_report async

get_credential_report(request: GetCredentialReportInput | GetCredentialReportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCredentialReportInputDict]) -> 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
request GetCredentialReportInput | GetCredentialReportInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetCredentialReportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCredentialReportOutput

An instance of GetCredentialReportOutput.

Input

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

GetCredentialReportInputDict

Bases: TypedDict

Dictionary form of GetCredentialReportInput.

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.