Returns a list of clusters and metadata associated with an image.
Parameters:
Raises:
-
AccessDeniedException
–
You do not have sufficient access to perform this action.
For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.
-
InternalServerException
–
The request has failed due to an internal failure of the Amazon Inspector service.
-
ThrottlingException
–
The limit on the number of requests per second was exceeded.
-
ValidationException
–
The request has failed validation due to missing required fields or having invalid inputs.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_inspector2/_services/inspector2.py
| def get_clusters_for_image(
self,
filter: "capo_inspector2.types.cluster_for_image_filter_criteria.ClusterForImageFilterCriteria",
*,
config_overrides: Optional[Inspector2ClientConfig] = None,
max_results: Optional[int] = None,
next_token: Optional[
"capo_inspector2.types.get_clusters_for_image_next_token.GetClustersForImageNextToken"
] = None,
) -> "capo_inspector2.types.get_clusters_for_image_response.GetClustersForImageResponse":
"""<p>Returns a list of clusters and metadata associated with an image.</p>
Args:
filter: <p>The resource Id for the Amazon ECR image.</p>
max_results: <p>The maximum number of results to be returned in a single page of results.</p>
next_token: <p>The pagination token from a previous request used to retrieve the next page of results.</p>
Raises:
capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_inspector2.types.get_clusters_for_image_request.GetClustersForImageRequest]",
) -> OperationResponse[
"capo_inspector2.types.get_clusters_for_image_response.GetClustersForImageResponse"
]:
import capo_inspector2._operations.inspector2.get_clusters_for_image
output, http_response = (
capo_inspector2._operations.inspector2.get_clusters_for_image.get_clusters_for_image(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetClustersForImage")
)
input_: capo_inspector2.types.get_clusters_for_image_request.GetClustersForImageRequest = {
"filter": filter
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|