updateImagePipeline method

Future<UpdateImagePipelineResponse> updateImagePipeline({ required String imagePipelineArn, required String infrastructureConfigurationArn, String? clientToken, String? containerRecipeArn, String? description, String? distributionConfigurationArn, bool? enhancedImageMetadataEnabled, String? imageRecipeArn, ImageTestsConfiguration? imageTestsConfiguration, Schedule? schedule, PipelineStatus? status, })

Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

May throw ServiceException. May throw ClientException. May throw ServiceUnavailableException. May throw InvalidRequestException. May throw IdempotentParameterMismatchException. May throw ForbiddenException. May throw CallRateLimitExceededException. May throw ResourceInUseException.

Parameter imagePipelineArn : The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Parameter infrastructureConfigurationArn : The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

Parameter clientToken : The idempotency token used to make this request idempotent.

Parameter containerRecipeArn : The Amazon Resource Name (ARN) of the container pipeline to update.

Parameter description : The description of the image pipeline.

Parameter distributionConfigurationArn : The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

Parameter enhancedImageMetadataEnabled : Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Parameter imageRecipeArn : The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

Parameter imageTestsConfiguration : The image test configuration of the image pipeline.

Parameter schedule : The schedule of the image pipeline.

Parameter status : The status of the image pipeline.

Implementation

Future<UpdateImagePipelineResponse> updateImagePipeline({
  required String imagePipelineArn,
  required String infrastructureConfigurationArn,
  String? clientToken,
  String? containerRecipeArn,
  String? description,
  String? distributionConfigurationArn,
  bool? enhancedImageMetadataEnabled,
  String? imageRecipeArn,
  ImageTestsConfiguration? imageTestsConfiguration,
  Schedule? schedule,
  PipelineStatus? status,
}) async {
  ArgumentError.checkNotNull(imagePipelineArn, 'imagePipelineArn');
  ArgumentError.checkNotNull(
      infrastructureConfigurationArn, 'infrastructureConfigurationArn');
  _s.validateStringLength(
    'clientToken',
    clientToken,
    1,
    36,
  );
  _s.validateStringLength(
    'description',
    description,
    1,
    1024,
  );
  final $payload = <String, dynamic>{
    'imagePipelineArn': imagePipelineArn,
    'infrastructureConfigurationArn': infrastructureConfigurationArn,
    'clientToken': clientToken ?? _s.generateIdempotencyToken(),
    if (containerRecipeArn != null) 'containerRecipeArn': containerRecipeArn,
    if (description != null) 'description': description,
    if (distributionConfigurationArn != null)
      'distributionConfigurationArn': distributionConfigurationArn,
    if (enhancedImageMetadataEnabled != null)
      'enhancedImageMetadataEnabled': enhancedImageMetadataEnabled,
    if (imageRecipeArn != null) 'imageRecipeArn': imageRecipeArn,
    if (imageTestsConfiguration != null)
      'imageTestsConfiguration': imageTestsConfiguration,
    if (schedule != null) 'schedule': schedule,
    if (status != null) 'status': status.toValue(),
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri: '/UpdateImagePipeline',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateImagePipelineResponse.fromJson(response);
}