Returns a list of image build versions.
Parameters:
-
image_version_arn
(Optional[ImageVersionArn], default:
None
)
–
The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve. The ARN must specify an exact version (..) - wildcards aren't allowed. This parameter is optional. If you don't specify it, Image Builder returns build versions for all of the images in your account.
-
filters
(Optional[FilterList], default:
None
)
–
Use the following filters to streamline results:
-
name
-
osVersion
-
platform
-
type
-
version
-
max_results
(Optional[RestrictedInteger], default:
None
)
–
The maximum number of items to return in a single request.
-
next_token
(Optional[PaginationToken], default:
None
)
–
A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
Raises:
-
CallRateLimitExceededException
–
You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
-
ClientException
–
A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
-
ForbiddenException
–
You are not authorized to perform the requested operation.
-
InvalidPaginationTokenException
–
You have provided an invalid pagination token in your request.
-
InvalidRequestException
–
The request is malformed or otherwise invalid. Verify the request and try again.
-
ServiceException
–
An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
-
ServiceUnavailableException
–
The service is unable to process your request at this time.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
List the build versions of an image
The following example lists the build versions that exist for version 1.0.0 of the specified image, with the output AMI that each build produced.
>>> client.list_image_build_versions(image_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0')
Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py
| def list_image_build_versions(
self,
*,
config_overrides: Optional[imagebuilderClientConfig] = None,
image_version_arn: Optional[
"capo_imagebuilder.types.image_version_arn.ImageVersionArn"
] = None,
filters: Optional["capo_imagebuilder.types.filter_list.FilterList"] = None,
max_results: Optional[
"capo_imagebuilder.types.restricted_integer.RestrictedInteger"
] = None,
next_token: Optional[
"capo_imagebuilder.types.pagination_token.PaginationToken"
] = None,
) -> "capo_imagebuilder.types.list_image_build_versions_response.ListImageBuildVersionsResponse":
"""<p>Returns a list of image build versions.</p>
Args:
image_version_arn: <p>The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve. The ARN must specify an exact version (<code><major>.<minor>.<patch></code>) - wildcards aren't allowed. This parameter is optional. If you don't specify it, Image Builder returns build versions for all of the images in your account.</p>
filters: <p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>osVersion</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>
max_results: <p>The maximum number of items to return in a single request.</p>
next_token: <p>A token to specify where to start paginating. Use the <code>nextToken</code> value from a previously truncated response.</p>
Raises:
capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
capo_imagebuilder.errors.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>You have provided an invalid pagination token in your request.</p>
capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
List the build versions of an image
The following example lists the build versions that exist for version 1.0.0 of the specified image, with the output AMI that each build produced.
>>> client.list_image_build_versions(image_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0')
"""
def _handler(
req: "OperationRequest[capo_imagebuilder.types.list_image_build_versions_request.ListImageBuildVersionsRequest]",
) -> OperationResponse[
"capo_imagebuilder.types.list_image_build_versions_response.ListImageBuildVersionsResponse"
]:
import capo_imagebuilder._operations.imagebuilder.list_image_build_versions
output, http_response = (
capo_imagebuilder._operations.imagebuilder.list_image_build_versions.list_image_build_versions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListImageBuildVersions")
)
input_: capo_imagebuilder.types.list_image_build_versions_request.ListImageBuildVersionsRequest = {}
if image_version_arn is not None:
input_["image_version_arn"] = image_version_arn
if filters is not None:
input_["filters"] = filters
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
|