Skip to content

get_image_findings

Operation

get_image_findings

get_image_findings(request: GetImageFindingsInput | GetImageFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetImageFindingsInputDict]) -> GetImageFindingsOutput

Describes the Amazon Inspector vulnerability findings for the specified AMI.

You can get findings for AMIs that you own, AMIs that are shared with you, and public AMIs. Amazon Inspector returns findings only for AMIs that it has scanned.

Parameters:

Name Type Description Default
request GetImageFindingsInput | GetImageFindingsInputDict | 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[GetImageFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetImageFindingsOutput

An instance of GetImageFindingsOutput.

get_image_findings async

get_image_findings(request: GetImageFindingsInput | GetImageFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetImageFindingsInputDict]) -> GetImageFindingsOutput

Describes the Amazon Inspector vulnerability findings for the specified AMI.

You can get findings for AMIs that you own, AMIs that are shared with you, and public AMIs. Amazon Inspector returns findings only for AMIs that it has scanned.

Parameters:

Name Type Description Default
request GetImageFindingsInput | GetImageFindingsInputDict | 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[GetImageFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetImageFindingsOutput

An instance of GetImageFindingsOutput.

Input

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

GetImageFindingsInputDict

Bases: TypedDict

Dictionary form of GetImageFindingsInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

image_id instance-attribute
image_id: Required[str]

The ID of the AMI.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

GetImageFindingsInput dataclass

Bases: _SerdeShape

Dataclass for GetImageFindingsInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

The ID of the AMI.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Output

GetImageFindingsOutput dataclass

Bases: _SerdeShape

Dataclass for GetImageFindingsOutput structure.

Attributes

image_findings class-attribute instance-attribute
image_findings: list[ImageFinding] | None = ...

The Amazon Inspector findings for the AMI.

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

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

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.