list_image_pipeline_images
async
¶
list_image_pipeline_images(
image_pipeline_arn: ImagePipelineArn,
*,
config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
filters: Optional[FilterList] = None,
max_results: Optional[RestrictedInteger] = None,
next_token: Optional[PaginationToken] = None,
) -> ListImagePipelineImagesResponse
Returns a list of images created by the specified pipeline.
Parameters:
-
image_pipeline_arn(ImagePipelineArn) –The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
-
filters(Optional[FilterList], default:None) –Use the following filters to streamline results:
-
name -
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
nextTokenvalue 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.
-
ResourceNotFoundException–At least one of the resources referenced by your request does not exist.
-
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 images that an image pipeline created The following example lists the images that the specified pipeline created, including a build that is still in progress.
>>> await client.list_image_pipeline_images(image_pipeline_arn='arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline')
Source code in docs_src/capo_imagebuilder/_services/async_imagebuilder.py
4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 | |