Interface ImagebuilderAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface ImagebuilderAsyncClient extends AwsClient
Service client for accessing imagebuilder asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images (AMIs) and container images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

For an introduction to the service concepts that these API operations work with, see How Image Builder works in the EC2 Image Builder User Guide.

  • Field Details

  • Method Details

    • cancelImageCreation

      default CompletableFuture<CancelImageCreationResponse> cancelImageCreation(CancelImageCreationRequest cancelImageCreationRequest)

      Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren't removed.

      Parameters:
      cancelImageCreationRequest -
      Returns:
      A Java Future containing the result of the CancelImageCreation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelImageCreation

      default CompletableFuture<CancelImageCreationResponse> cancelImageCreation(Consumer<CancelImageCreationRequest.Builder> cancelImageCreationRequest)

      Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren't removed.


      This is a convenience which creates an instance of the CancelImageCreationRequest.Builder avoiding the need to create one manually via CancelImageCreationRequest.builder()

      Parameters:
      cancelImageCreationRequest - A Consumer that will call methods on CancelImageCreationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelImageCreation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelLifecycleExecution

      default CompletableFuture<CancelLifecycleExecutionResponse> cancelLifecycleExecution(CancelLifecycleExecutionRequest cancelLifecycleExecutionRequest)

      Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel an execution that hasn't reached a terminal state. Cancellation is asynchronous and doesn't undo completed lifecycle actions.

      Parameters:
      cancelLifecycleExecutionRequest -
      Returns:
      A Java Future containing the result of the CancelLifecycleExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelLifecycleExecution

      default CompletableFuture<CancelLifecycleExecutionResponse> cancelLifecycleExecution(Consumer<CancelLifecycleExecutionRequest.Builder> cancelLifecycleExecutionRequest)

      Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel an execution that hasn't reached a terminal state. Cancellation is asynchronous and doesn't undo completed lifecycle actions.


      This is a convenience which creates an instance of the CancelLifecycleExecutionRequest.Builder avoiding the need to create one manually via CancelLifecycleExecutionRequest.builder()

      Parameters:
      cancelLifecycleExecutionRequest - A Consumer that will call methods on CancelLifecycleExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelLifecycleExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createComponent

      default CompletableFuture<CreateComponentResponse> createComponent(CreateComponentRequest createComponentRequest)

      Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

      • Inline, using the data property in the request body.

      • A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

      Image Builder determines the component type from the document. If the document contains a single phase named test, the component type is TEST. Otherwise, the component type is BUILD.

      Parameters:
      createComponentRequest -
      Returns:
      A Java Future containing the result of the CreateComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createComponent

      default CompletableFuture<CreateComponentResponse> createComponent(Consumer<CreateComponentRequest.Builder> createComponentRequest)

      Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

      • Inline, using the data property in the request body.

      • A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

      Image Builder determines the component type from the document. If the document contains a single phase named test, the component type is TEST. Otherwise, the component type is BUILD.


      This is a convenience which creates an instance of the CreateComponentRequest.Builder avoiding the need to create one manually via CreateComponentRequest.builder()

      Parameters:
      createComponentRequest - A Consumer that will call methods on CreateComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerRecipe

      default CompletableFuture<CreateContainerRecipeResponse> createContainerRecipe(CreateContainerRecipeRequest createContainerRecipeRequest)

      Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

      Parameters:
      createContainerRecipeRequest -
      Returns:
      A Java Future containing the result of the CreateContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerRecipe

      default CompletableFuture<CreateContainerRecipeResponse> createContainerRecipe(Consumer<CreateContainerRecipeRequest.Builder> createContainerRecipeRequest)

      Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.


      This is a convenience which creates an instance of the CreateContainerRecipeRequest.Builder avoiding the need to create one manually via CreateContainerRecipeRequest.builder()

      Parameters:
      createContainerRecipeRequest - A Consumer that will call methods on CreateContainerRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDistributionConfiguration

      default CompletableFuture<CreateDistributionConfigurationResponse> createDistributionConfiguration(CreateDistributionConfigurationRequest createDistributionConfigurationRequest)

      Creates a new distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.

      Parameters:
      createDistributionConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDistributionConfiguration

      default CompletableFuture<CreateDistributionConfigurationResponse> createDistributionConfiguration(Consumer<CreateDistributionConfigurationRequest.Builder> createDistributionConfigurationRequest)

      Creates a new distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.


      This is a convenience which creates an instance of the CreateDistributionConfigurationRequest.Builder avoiding the need to create one manually via CreateDistributionConfigurationRequest.builder()

      Parameters:
      createDistributionConfigurationRequest - A Consumer that will call methods on CreateDistributionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImage

      default CompletableFuture<CreateImageResponse> createImage(CreateImageRequest createImageRequest)

      Creates a new image along with all configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

      The response returns as soon as Image Builder creates the new image resource. The image build process runs asynchronously. To check its progress, call GetImage and check the image status.

      Parameters:
      createImageRequest -
      Returns:
      A Java Future containing the result of the CreateImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImage

      default CompletableFuture<CreateImageResponse> createImage(Consumer<CreateImageRequest.Builder> createImageRequest)

      Creates a new image along with all configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

      The response returns as soon as Image Builder creates the new image resource. The image build process runs asynchronously. To check its progress, call GetImage and check the image status.


      This is a convenience which creates an instance of the CreateImageRequest.Builder avoiding the need to create one manually via CreateImageRequest.builder()

      Parameters:
      createImageRequest - A Consumer that will call methods on CreateImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImagePipeline

      default CompletableFuture<CreateImagePipelineResponse> createImagePipeline(CreateImagePipelineRequest createImagePipelineRequest)

      Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline, using either a containerRecipeArn or an imageRecipeArn.

      Parameters:
      createImagePipelineRequest -
      Returns:
      A Java Future containing the result of the CreateImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImagePipeline

      default CompletableFuture<CreateImagePipelineResponse> createImagePipeline(Consumer<CreateImagePipelineRequest.Builder> createImagePipelineRequest)

      Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline, using either a containerRecipeArn or an imageRecipeArn.


      This is a convenience which creates an instance of the CreateImagePipelineRequest.Builder avoiding the need to create one manually via CreateImagePipelineRequest.builder()

      Parameters:
      createImagePipelineRequest - A Consumer that will call methods on CreateImagePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImageRecipe

      default CompletableFuture<CreateImageRecipeResponse> createImageRecipe(CreateImageRecipeRequest createImageRecipeRequest)

      Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

      Parameters:
      createImageRecipeRequest -
      Returns:
      A Java Future containing the result of the CreateImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImageRecipe

      default CompletableFuture<CreateImageRecipeResponse> createImageRecipe(Consumer<CreateImageRecipeRequest.Builder> createImageRecipeRequest)

      Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.


      This is a convenience which creates an instance of the CreateImageRecipeRequest.Builder avoiding the need to create one manually via CreateImageRecipeRequest.builder()

      Parameters:
      createImageRecipeRequest - A Consumer that will call methods on CreateImageRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInfrastructureConfiguration

      default CompletableFuture<CreateInfrastructureConfigurationResponse> createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest createInfrastructureConfigurationRequest)

      Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

      Parameters:
      createInfrastructureConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInfrastructureConfiguration

      default CompletableFuture<CreateInfrastructureConfigurationResponse> createInfrastructureConfiguration(Consumer<CreateInfrastructureConfigurationRequest.Builder> createInfrastructureConfigurationRequest)

      Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.


      This is a convenience which creates an instance of the CreateInfrastructureConfigurationRequest.Builder avoiding the need to create one manually via CreateInfrastructureConfigurationRequest.builder()

      Parameters:
      createInfrastructureConfigurationRequest - A Consumer that will call methods on CreateInfrastructureConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLifecyclePolicy

      default CompletableFuture<CreateLifecyclePolicyResponse> createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)

      Creates a lifecycle policy resource.

      Parameters:
      createLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the CreateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLifecyclePolicy

      default CompletableFuture<CreateLifecyclePolicyResponse> createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)

      Creates a lifecycle policy resource.


      This is a convenience which creates an instance of the CreateLifecyclePolicyRequest.Builder avoiding the need to create one manually via CreateLifecyclePolicyRequest.builder()

      Parameters:
      createLifecyclePolicyRequest - A Consumer that will call methods on CreateLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ResourceAlreadyExistsException The resource that you are trying to create already exists.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkflow

      default CompletableFuture<CreateWorkflowResponse> createWorkflow(CreateWorkflowRequest createWorkflowRequest)

      Creates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request changes its configuration, Image Builder creates a new build version. If the configuration is identical to the latest build version, the request fails because that workflow configuration already exists.

      Parameters:
      createWorkflowRequest -
      Returns:
      A Java Future containing the result of the CreateWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkflow

      default CompletableFuture<CreateWorkflowResponse> createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest)

      Creates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request changes its configuration, Image Builder creates a new build version. If the configuration is identical to the latest build version, the request fails because that workflow configuration already exists.


      This is a convenience which creates an instance of the CreateWorkflowRequest.Builder avoiding the need to create one manually via CreateWorkflowRequest.builder()

      Parameters:
      createWorkflowRequest - A Consumer that will call methods on CreateWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • DryRunOperationException The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteComponent

      default CompletableFuture<DeleteComponentResponse> deleteComponent(DeleteComponentRequest deleteComponentRequest)

      Deletes a component build version. The request fails with ResourceDependencyException if an image recipe or container recipe references this component version. It also fails if the component build version is shared with other accounts.

      Parameters:
      deleteComponentRequest -
      Returns:
      A Java Future containing the result of the DeleteComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteComponent

      default CompletableFuture<DeleteComponentResponse> deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest)

      Deletes a component build version. The request fails with ResourceDependencyException if an image recipe or container recipe references this component version. It also fails if the component build version is shared with other accounts.


      This is a convenience which creates an instance of the DeleteComponentRequest.Builder avoiding the need to create one manually via DeleteComponentRequest.builder()

      Parameters:
      deleteComponentRequest - A Consumer that will call methods on DeleteComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerRecipe

      default CompletableFuture<DeleteContainerRecipeResponse> deleteContainerRecipe(DeleteContainerRecipeRequest deleteContainerRecipeRequest)

      Deletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references it.

      Parameters:
      deleteContainerRecipeRequest -
      Returns:
      A Java Future containing the result of the DeleteContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerRecipe

      default CompletableFuture<DeleteContainerRecipeResponse> deleteContainerRecipe(Consumer<DeleteContainerRecipeRequest.Builder> deleteContainerRecipeRequest)

      Deletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references it.


      This is a convenience which creates an instance of the DeleteContainerRecipeRequest.Builder avoiding the need to create one manually via DeleteContainerRecipeRequest.builder()

      Parameters:
      deleteContainerRecipeRequest - A Consumer that will call methods on DeleteContainerRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDistributionConfiguration

      default CompletableFuture<DeleteDistributionConfigurationResponse> deleteDistributionConfiguration(DeleteDistributionConfigurationRequest deleteDistributionConfigurationRequest)

      Deletes a distribution configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.

      Parameters:
      deleteDistributionConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDistributionConfiguration

      default CompletableFuture<DeleteDistributionConfigurationResponse> deleteDistributionConfiguration(Consumer<DeleteDistributionConfigurationRequest.Builder> deleteDistributionConfigurationRequest)

      Deletes a distribution configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.


      This is a convenience which creates an instance of the DeleteDistributionConfigurationRequest.Builder avoiding the need to create one manually via DeleteDistributionConfigurationRequest.builder()

      Parameters:
      deleteDistributionConfigurationRequest - A Consumer that will call methods on DeleteDistributionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImage

      default CompletableFuture<DeleteImageResponse> deleteImage(DeleteImageRequest deleteImageRequest)

      Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.

      The request fails with ResourceDependencyException if the image is shared with other accounts, or if other resources depend on it. It also fails while the image build is still running. Cancel an in-progress build with CancelImageCreation before you delete the image.

      Parameters:
      deleteImageRequest -
      Returns:
      A Java Future containing the result of the DeleteImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImage

      default CompletableFuture<DeleteImageResponse> deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest)

      Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.

      The request fails with ResourceDependencyException if the image is shared with other accounts, or if other resources depend on it. It also fails while the image build is still running. Cancel an in-progress build with CancelImageCreation before you delete the image.


      This is a convenience which creates an instance of the DeleteImageRequest.Builder avoiding the need to create one manually via DeleteImageRequest.builder()

      Parameters:
      deleteImageRequest - A Consumer that will call methods on DeleteImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImagePipeline

      default CompletableFuture<DeleteImagePipelineResponse> deleteImagePipeline(DeleteImagePipelineRequest deleteImagePipelineRequest)

      Deletes an image pipeline. Images that the pipeline created aren't deleted - remove those separately with DeleteImage. You can delete a pipeline while a build that it started is still running. The build continues independently.

      Parameters:
      deleteImagePipelineRequest -
      Returns:
      A Java Future containing the result of the DeleteImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImagePipeline

      default CompletableFuture<DeleteImagePipelineResponse> deleteImagePipeline(Consumer<DeleteImagePipelineRequest.Builder> deleteImagePipelineRequest)

      Deletes an image pipeline. Images that the pipeline created aren't deleted - remove those separately with DeleteImage. You can delete a pipeline while a build that it started is still running. The build continues independently.


      This is a convenience which creates an instance of the DeleteImagePipelineRequest.Builder avoiding the need to create one manually via DeleteImagePipelineRequest.builder()

      Parameters:
      deleteImagePipelineRequest - A Consumer that will call methods on DeleteImagePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageRecipe

      default CompletableFuture<DeleteImageRecipeResponse> deleteImageRecipe(DeleteImageRecipeRequest deleteImageRecipeRequest)

      Deletes an image recipe.

      Parameters:
      deleteImageRecipeRequest -
      Returns:
      A Java Future containing the result of the DeleteImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageRecipe

      default CompletableFuture<DeleteImageRecipeResponse> deleteImageRecipe(Consumer<DeleteImageRecipeRequest.Builder> deleteImageRecipeRequest)

      Deletes an image recipe.


      This is a convenience which creates an instance of the DeleteImageRecipeRequest.Builder avoiding the need to create one manually via DeleteImageRecipeRequest.builder()

      Parameters:
      deleteImageRecipeRequest - A Consumer that will call methods on DeleteImageRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInfrastructureConfiguration

      default CompletableFuture<DeleteInfrastructureConfigurationResponse> deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest deleteInfrastructureConfigurationRequest)

      Deletes an infrastructure configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.

      Parameters:
      deleteInfrastructureConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInfrastructureConfiguration

      default CompletableFuture<DeleteInfrastructureConfigurationResponse> deleteInfrastructureConfiguration(Consumer<DeleteInfrastructureConfigurationRequest.Builder> deleteInfrastructureConfigurationRequest)

      Deletes an infrastructure configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.


      This is a convenience which creates an instance of the DeleteInfrastructureConfigurationRequest.Builder avoiding the need to create one manually via DeleteInfrastructureConfigurationRequest.builder()

      Parameters:
      deleteInfrastructureConfigurationRequest - A Consumer that will call methods on DeleteInfrastructureConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLifecyclePolicy

      default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)

      Deletes the specified lifecycle policy resource. Deleting the policy removes its schedule, so no further lifecycle runs occur for that policy. If a lifecycle execution is in progress for the policy, Image Builder cancels it. Deletion doesn't revert actions that the policy already applied to your resources.

      Parameters:
      deleteLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLifecyclePolicy

      default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)

      Deletes the specified lifecycle policy resource. Deleting the policy removes its schedule, so no further lifecycle runs occur for that policy. If a lifecycle execution is in progress for the policy, Image Builder cancels it. Deletion doesn't revert actions that the policy already applied to your resources.


      This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the need to create one manually via DeleteLifecyclePolicyRequest.builder()

      Parameters:
      deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

      Deletes a specific workflow resource. You can't delete a workflow build version while an image pipeline references it. The request fails with ResourceDependencyException.

      Parameters:
      deleteWorkflowRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkflow

      default CompletableFuture<DeleteWorkflowResponse> deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest)

      Deletes a specific workflow resource. You can't delete a workflow build version while an image pipeline references it. The request fails with ResourceDependencyException.


      This is a convenience which creates an instance of the DeleteWorkflowRequest.Builder avoiding the need to create one manually via DeleteWorkflowRequest.builder()

      Parameters:
      deleteWorkflowRequest - A Consumer that will call methods on DeleteWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceDependencyException You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • distributeImage

      default CompletableFuture<DistributeImageResponse> distributeImage(DistributeImageRequest distributeImageRequest)

      Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.

      Parameters:
      distributeImageRequest -
      Returns:
      A Java Future containing the result of the DistributeImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • AccessDeniedException You do not have permissions to perform the requested operation.
      • TooManyRequestsException You have attempted too many requests for the specific operation.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • distributeImage

      default CompletableFuture<DistributeImageResponse> distributeImage(Consumer<DistributeImageRequest.Builder> distributeImageRequest)

      Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.


      This is a convenience which creates an instance of the DistributeImageRequest.Builder avoiding the need to create one manually via DistributeImageRequest.builder()

      Parameters:
      distributeImageRequest - A Consumer that will call methods on DistributeImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DistributeImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • ServiceQuotaExceededException You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
      • AccessDeniedException You do not have permissions to perform the requested operation.
      • TooManyRequestsException You have attempted too many requests for the specific operation.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(GetComponentRequest getComponentRequest)

      Retrieves a component object.

      Parameters:
      getComponentRequest -
      Returns:
      A Java Future containing the result of the GetComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)

      Retrieves a component object.


      This is a convenience which creates an instance of the GetComponentRequest.Builder avoiding the need to create one manually via GetComponentRequest.builder()

      Parameters:
      getComponentRequest - A Consumer that will call methods on GetComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponentPolicy

      default CompletableFuture<GetComponentPolicyResponse> getComponentPolicy(GetComponentPolicyRequest getComponentPolicyRequest)

      Retrieves a component policy.

      Parameters:
      getComponentPolicyRequest -
      Returns:
      A Java Future containing the result of the GetComponentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponentPolicy

      default CompletableFuture<GetComponentPolicyResponse> getComponentPolicy(Consumer<GetComponentPolicyRequest.Builder> getComponentPolicyRequest)

      Retrieves a component policy.


      This is a convenience which creates an instance of the GetComponentPolicyRequest.Builder avoiding the need to create one manually via GetComponentPolicyRequest.builder()

      Parameters:
      getComponentPolicyRequest - A Consumer that will call methods on GetComponentPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetComponentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerRecipe

      default CompletableFuture<GetContainerRecipeResponse> getContainerRecipe(GetContainerRecipeRequest getContainerRecipeRequest)

      Retrieves a container recipe.

      Parameters:
      getContainerRecipeRequest -
      Returns:
      A Java Future containing the result of the GetContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerRecipe

      default CompletableFuture<GetContainerRecipeResponse> getContainerRecipe(Consumer<GetContainerRecipeRequest.Builder> getContainerRecipeRequest)

      Retrieves a container recipe.


      This is a convenience which creates an instance of the GetContainerRecipeRequest.Builder avoiding the need to create one manually via GetContainerRecipeRequest.builder()

      Parameters:
      getContainerRecipeRequest - A Consumer that will call methods on GetContainerRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerRecipePolicy

      default CompletableFuture<GetContainerRecipePolicyResponse> getContainerRecipePolicy(GetContainerRecipePolicyRequest getContainerRecipePolicyRequest)

      Retrieves the policy for a container recipe.

      Parameters:
      getContainerRecipePolicyRequest -
      Returns:
      A Java Future containing the result of the GetContainerRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerRecipePolicy

      default CompletableFuture<GetContainerRecipePolicyResponse> getContainerRecipePolicy(Consumer<GetContainerRecipePolicyRequest.Builder> getContainerRecipePolicyRequest)

      Retrieves the policy for a container recipe.


      This is a convenience which creates an instance of the GetContainerRecipePolicyRequest.Builder avoiding the need to create one manually via GetContainerRecipePolicyRequest.builder()

      Parameters:
      getContainerRecipePolicyRequest - A Consumer that will call methods on GetContainerRecipePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionConfiguration

      default CompletableFuture<GetDistributionConfigurationResponse> getDistributionConfiguration(GetDistributionConfigurationRequest getDistributionConfigurationRequest)

      Retrieves a distribution configuration.

      Parameters:
      getDistributionConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionConfiguration

      default CompletableFuture<GetDistributionConfigurationResponse> getDistributionConfiguration(Consumer<GetDistributionConfigurationRequest.Builder> getDistributionConfigurationRequest)

      Retrieves a distribution configuration.


      This is a convenience which creates an instance of the GetDistributionConfigurationRequest.Builder avoiding the need to create one manually via GetDistributionConfigurationRequest.builder()

      Parameters:
      getDistributionConfigurationRequest - A Consumer that will call methods on GetDistributionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImage

      default CompletableFuture<GetImageResponse> getImage(GetImageRequest getImageRequest)

      Retrieves an image.

      Parameters:
      getImageRequest -
      Returns:
      A Java Future containing the result of the GetImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImage

      default CompletableFuture<GetImageResponse> getImage(Consumer<GetImageRequest.Builder> getImageRequest)

      Retrieves an image.


      This is a convenience which creates an instance of the GetImageRequest.Builder avoiding the need to create one manually via GetImageRequest.builder()

      Parameters:
      getImageRequest - A Consumer that will call methods on GetImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImagePipeline

      default CompletableFuture<GetImagePipelineResponse> getImagePipeline(GetImagePipelineRequest getImagePipelineRequest)

      Retrieves an image pipeline.

      Parameters:
      getImagePipelineRequest -
      Returns:
      A Java Future containing the result of the GetImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImagePipeline

      default CompletableFuture<GetImagePipelineResponse> getImagePipeline(Consumer<GetImagePipelineRequest.Builder> getImagePipelineRequest)

      Retrieves an image pipeline.


      This is a convenience which creates an instance of the GetImagePipelineRequest.Builder avoiding the need to create one manually via GetImagePipelineRequest.builder()

      Parameters:
      getImagePipelineRequest - A Consumer that will call methods on GetImagePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImagePolicy

      default CompletableFuture<GetImagePolicyResponse> getImagePolicy(GetImagePolicyRequest getImagePolicyRequest)

      Retrieves an image policy.

      Parameters:
      getImagePolicyRequest -
      Returns:
      A Java Future containing the result of the GetImagePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImagePolicy

      default CompletableFuture<GetImagePolicyResponse> getImagePolicy(Consumer<GetImagePolicyRequest.Builder> getImagePolicyRequest)

      Retrieves an image policy.


      This is a convenience which creates an instance of the GetImagePolicyRequest.Builder avoiding the need to create one manually via GetImagePolicyRequest.builder()

      Parameters:
      getImagePolicyRequest - A Consumer that will call methods on GetImagePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImagePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageRecipe

      default CompletableFuture<GetImageRecipeResponse> getImageRecipe(GetImageRecipeRequest getImageRecipeRequest)

      Retrieves an image recipe.

      Parameters:
      getImageRecipeRequest -
      Returns:
      A Java Future containing the result of the GetImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageRecipe

      default CompletableFuture<GetImageRecipeResponse> getImageRecipe(Consumer<GetImageRecipeRequest.Builder> getImageRecipeRequest)

      Retrieves an image recipe.


      This is a convenience which creates an instance of the GetImageRecipeRequest.Builder avoiding the need to create one manually via GetImageRecipeRequest.builder()

      Parameters:
      getImageRecipeRequest - A Consumer that will call methods on GetImageRecipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImageRecipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageRecipePolicy

      default CompletableFuture<GetImageRecipePolicyResponse> getImageRecipePolicy(GetImageRecipePolicyRequest getImageRecipePolicyRequest)

      Retrieves an image recipe policy.

      Parameters:
      getImageRecipePolicyRequest -
      Returns:
      A Java Future containing the result of the GetImageRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImageRecipePolicy

      default CompletableFuture<GetImageRecipePolicyResponse> getImageRecipePolicy(Consumer<GetImageRecipePolicyRequest.Builder> getImageRecipePolicyRequest)

      Retrieves an image recipe policy.


      This is a convenience which creates an instance of the GetImageRecipePolicyRequest.Builder avoiding the need to create one manually via GetImageRecipePolicyRequest.builder()

      Parameters:
      getImageRecipePolicyRequest - A Consumer that will call methods on GetImageRecipePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImageRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInfrastructureConfiguration

      default CompletableFuture<GetInfrastructureConfigurationResponse> getInfrastructureConfiguration(GetInfrastructureConfigurationRequest getInfrastructureConfigurationRequest)

      Retrieves an infrastructure configuration.

      Parameters:
      getInfrastructureConfigurationRequest - GetInfrastructureConfiguration request object.
      Returns:
      A Java Future containing the result of the GetInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInfrastructureConfiguration

      default CompletableFuture<GetInfrastructureConfigurationResponse> getInfrastructureConfiguration(Consumer<GetInfrastructureConfigurationRequest.Builder> getInfrastructureConfigurationRequest)

      Retrieves an infrastructure configuration.


      This is a convenience which creates an instance of the GetInfrastructureConfigurationRequest.Builder avoiding the need to create one manually via GetInfrastructureConfigurationRequest.builder()

      Parameters:
      getInfrastructureConfigurationRequest - A Consumer that will call methods on GetInfrastructureConfigurationRequest.Builder to create a request. GetInfrastructureConfiguration request object.
      Returns:
      A Java Future containing the result of the GetInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLifecycleExecution

      default CompletableFuture<GetLifecycleExecutionResponse> getLifecycleExecution(GetLifecycleExecutionRequest getLifecycleExecutionRequest)

      Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started.

      Parameters:
      getLifecycleExecutionRequest -
      Returns:
      A Java Future containing the result of the GetLifecycleExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLifecycleExecution

      default CompletableFuture<GetLifecycleExecutionResponse> getLifecycleExecution(Consumer<GetLifecycleExecutionRequest.Builder> getLifecycleExecutionRequest)

      Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started.


      This is a convenience which creates an instance of the GetLifecycleExecutionRequest.Builder avoiding the need to create one manually via GetLifecycleExecutionRequest.builder()

      Parameters:
      getLifecycleExecutionRequest - A Consumer that will call methods on GetLifecycleExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLifecycleExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLifecyclePolicy

      default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)

      Retrieves details for the specified image lifecycle policy.

      Parameters:
      getLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the GetLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLifecyclePolicy

      default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)

      Retrieves details for the specified image lifecycle policy.


      This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder avoiding the need to create one manually via GetLifecyclePolicyRequest.builder()

      Parameters:
      getLifecyclePolicyRequest - A Consumer that will call methods on GetLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMarketplaceResource

      default CompletableFuture<GetMarketplaceResourceResponse> getMarketplaceResource(GetMarketplaceResourceRequest getMarketplaceResourceRequest)

      Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. The caller must be entitled to the resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.

      Parameters:
      getMarketplaceResourceRequest -
      Returns:
      A Java Future containing the result of the GetMarketplaceResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMarketplaceResource

      default CompletableFuture<GetMarketplaceResourceResponse> getMarketplaceResource(Consumer<GetMarketplaceResourceRequest.Builder> getMarketplaceResourceRequest)

      Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. The caller must be entitled to the resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.


      This is a convenience which creates an instance of the GetMarketplaceResourceRequest.Builder avoiding the need to create one manually via GetMarketplaceResourceRequest.builder()

      Parameters:
      getMarketplaceResourceRequest - A Consumer that will call methods on GetMarketplaceResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMarketplaceResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflow

      default CompletableFuture<GetWorkflowResponse> getWorkflow(GetWorkflowRequest getWorkflowRequest)

      Retrieves a workflow resource object.

      Parameters:
      getWorkflowRequest -
      Returns:
      A Java Future containing the result of the GetWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflow

      default CompletableFuture<GetWorkflowResponse> getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest)

      Retrieves a workflow resource object.


      This is a convenience which creates an instance of the GetWorkflowRequest.Builder avoiding the need to create one manually via GetWorkflowRequest.builder()

      Parameters:
      getWorkflowRequest - A Consumer that will call methods on GetWorkflowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkflow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflowExecution

      default CompletableFuture<GetWorkflowExecutionResponse> getWorkflowExecution(GetWorkflowExecutionRequest getWorkflowExecutionRequest)

      Retrieves runtime information for a specific runtime instance of the workflow.

      Parameters:
      getWorkflowExecutionRequest -
      Returns:
      A Java Future containing the result of the GetWorkflowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflowExecution

      default CompletableFuture<GetWorkflowExecutionResponse> getWorkflowExecution(Consumer<GetWorkflowExecutionRequest.Builder> getWorkflowExecutionRequest)

      Retrieves runtime information for a specific runtime instance of the workflow.


      This is a convenience which creates an instance of the GetWorkflowExecutionRequest.Builder avoiding the need to create one manually via GetWorkflowExecutionRequest.builder()

      Parameters:
      getWorkflowExecutionRequest - A Consumer that will call methods on GetWorkflowExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkflowExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflowStepExecution

      default CompletableFuture<GetWorkflowStepExecutionResponse> getWorkflowStepExecution(GetWorkflowStepExecutionRequest getWorkflowStepExecutionRequest)

      Retrieves runtime information for a specific runtime instance of the workflow step.

      Parameters:
      getWorkflowStepExecutionRequest -
      Returns:
      A Java Future containing the result of the GetWorkflowStepExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkflowStepExecution

      default CompletableFuture<GetWorkflowStepExecutionResponse> getWorkflowStepExecution(Consumer<GetWorkflowStepExecutionRequest.Builder> getWorkflowStepExecutionRequest)

      Retrieves runtime information for a specific runtime instance of the workflow step.


      This is a convenience which creates an instance of the GetWorkflowStepExecutionRequest.Builder avoiding the need to create one manually via GetWorkflowStepExecutionRequest.builder()

      Parameters:
      getWorkflowStepExecutionRequest - A Consumer that will call methods on GetWorkflowStepExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkflowStepExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importComponent

      default CompletableFuture<ImportComponentResponse> importComponent(ImportComponentRequest importComponentRequest)

      Imports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a single step that runs the script.

      Parameters:
      importComponentRequest -
      Returns:
      A Java Future containing the result of the ImportComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importComponent

      default CompletableFuture<ImportComponentResponse> importComponent(Consumer<ImportComponentRequest.Builder> importComponentRequest)

      Imports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a single step that runs the script.


      This is a convenience which creates an instance of the ImportComponentRequest.Builder avoiding the need to create one manually via ImportComponentRequest.builder()

      Parameters:
      importComponentRequest - A Consumer that will call methods on ImportComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • InvalidVersionNumberException Your version number is out of bounds or does not follow the required syntax.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importDiskImage

      default CompletableFuture<ImportDiskImageResponse> importDiskImage(ImportDiskImageRequest importDiskImageRequest)

      Imports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

      • Windows 11 Enterprise

      The response returns as soon as Image Builder creates the new image resource in the PENDING state. The conversion from ISO file to AMI then runs asynchronously on an EC2 instance that Image Builder launches with the specified infrastructure configuration.

      Parameters:
      importDiskImageRequest -
      Returns:
      A Java Future containing the result of the ImportDiskImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • AccessDeniedException You do not have permissions to perform the requested operation.
      • TooManyRequestsException You have attempted too many requests for the specific operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importDiskImage

      default CompletableFuture<ImportDiskImageResponse> importDiskImage(Consumer<ImportDiskImageRequest.Builder> importDiskImageRequest)

      Imports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

      • Windows 11 Enterprise

      The response returns as soon as Image Builder creates the new image resource in the PENDING state. The conversion from ISO file to AMI then runs asynchronously on an EC2 instance that Image Builder launches with the specified infrastructure configuration.


      This is a convenience which creates an instance of the ImportDiskImageRequest.Builder avoiding the need to create one manually via ImportDiskImageRequest.builder()

      Parameters:
      importDiskImageRequest - A Consumer that will call methods on ImportDiskImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportDiskImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • AccessDeniedException You do not have permissions to perform the requested operation.
      • TooManyRequestsException You have attempted too many requests for the specific operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importVmImage

      default CompletableFuture<ImportVmImageResponse> importVmImage(ImportVmImageRequest importVmImageRequest)

      Creates an Image Builder image resource from an Amazon EC2 VM import task. The response returns as soon as Image Builder creates the image resource in the PENDING state. Image Builder then monitors the import task asynchronously. When the task completes, Image Builder records the AMI that it produced as the new image's output resource and marks the image AVAILABLE. You can then use the imported image as the base image for your recipes.

      To create the VM import task, use the Amazon EC2 API ImportImage operation, or the import-image CLI command.

      Parameters:
      importVmImageRequest -
      Returns:
      A Java Future containing the result of the ImportVmImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importVmImage

      default CompletableFuture<ImportVmImageResponse> importVmImage(Consumer<ImportVmImageRequest.Builder> importVmImageRequest)

      Creates an Image Builder image resource from an Amazon EC2 VM import task. The response returns as soon as Image Builder creates the image resource in the PENDING state. Image Builder then monitors the import task asynchronously. When the task completes, Image Builder records the AMI that it produced as the new image's output resource and marks the image AVAILABLE. You can then use the imported image as the base image for your recipes.

      To create the VM import task, use the Amazon EC2 API ImportImage operation, or the import-image CLI command.


      This is a convenience which creates an instance of the ImportVmImageRequest.Builder avoiding the need to create one manually via ImportVmImageRequest.builder()

      Parameters:
      importVmImageRequest - A Consumer that will call methods on ImportVmImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportVmImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentBuildVersions

      default CompletableFuture<ListComponentBuildVersionsResponse> listComponentBuildVersions(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest)

      Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.

      Parameters:
      listComponentBuildVersionsRequest -
      Returns:
      A Java Future containing the result of the ListComponentBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentBuildVersions

      default CompletableFuture<ListComponentBuildVersionsResponse> listComponentBuildVersions(Consumer<ListComponentBuildVersionsRequest.Builder> listComponentBuildVersionsRequest)

      Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.


      This is a convenience which creates an instance of the ListComponentBuildVersionsRequest.Builder avoiding the need to create one manually via ListComponentBuildVersionsRequest.builder()

      Parameters:
      listComponentBuildVersionsRequest - A Consumer that will call methods on ListComponentBuildVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponentBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentBuildVersionsPaginator

      default ListComponentBuildVersionsPublisher listComponentBuildVersionsPaginator(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest)

      This is a variant of listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsPublisher publisher = client.listComponentBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsPublisher publisher = client.listComponentBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest) operation.

      Parameters:
      listComponentBuildVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentBuildVersionsPaginator

      default ListComponentBuildVersionsPublisher listComponentBuildVersionsPaginator(Consumer<ListComponentBuildVersionsRequest.Builder> listComponentBuildVersionsRequest)

      This is a variant of listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsPublisher publisher = client.listComponentBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsPublisher publisher = client.listComponentBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest) operation.


      This is a convenience which creates an instance of the ListComponentBuildVersionsRequest.Builder avoiding the need to create one manually via ListComponentBuildVersionsRequest.builder()

      Parameters:
      listComponentBuildVersionsRequest - A Consumer that will call methods on ListComponentBuildVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest)

      Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

      Parameters:
      listComponentsRequest -
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.


      This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest)

      This is a variant of listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest) operation.

      Parameters:
      listComponentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      This is a variant of listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest) operation.


      This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContainerRecipes

      default CompletableFuture<ListContainerRecipesResponse> listContainerRecipes(ListContainerRecipesRequest listContainerRecipesRequest)

      Returns a list of container recipes.

      Parameters:
      listContainerRecipesRequest -
      Returns:
      A Java Future containing the result of the ListContainerRecipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContainerRecipes

      default CompletableFuture<ListContainerRecipesResponse> listContainerRecipes(Consumer<ListContainerRecipesRequest.Builder> listContainerRecipesRequest)

      Returns a list of container recipes.


      This is a convenience which creates an instance of the ListContainerRecipesRequest.Builder avoiding the need to create one manually via ListContainerRecipesRequest.builder()

      Parameters:
      listContainerRecipesRequest - A Consumer that will call methods on ListContainerRecipesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContainerRecipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContainerRecipesPaginator

      default ListContainerRecipesPublisher listContainerRecipesPaginator(ListContainerRecipesRequest listContainerRecipesRequest)

      This is a variant of listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesPublisher publisher = client.listContainerRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesPublisher publisher = client.listContainerRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest) operation.

      Parameters:
      listContainerRecipesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContainerRecipesPaginator

      default ListContainerRecipesPublisher listContainerRecipesPaginator(Consumer<ListContainerRecipesRequest.Builder> listContainerRecipesRequest)

      This is a variant of listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesPublisher publisher = client.listContainerRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesPublisher publisher = client.listContainerRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest) operation.


      This is a convenience which creates an instance of the ListContainerRecipesRequest.Builder avoiding the need to create one manually via ListContainerRecipesRequest.builder()

      Parameters:
      listContainerRecipesRequest - A Consumer that will call methods on ListContainerRecipesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDistributionConfigurations

      default CompletableFuture<ListDistributionConfigurationsResponse> listDistributionConfigurations(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest)

      Returns a list of distribution configurations.

      Parameters:
      listDistributionConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListDistributionConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDistributionConfigurations

      default CompletableFuture<ListDistributionConfigurationsResponse> listDistributionConfigurations(Consumer<ListDistributionConfigurationsRequest.Builder> listDistributionConfigurationsRequest)

      Returns a list of distribution configurations.


      This is a convenience which creates an instance of the ListDistributionConfigurationsRequest.Builder avoiding the need to create one manually via ListDistributionConfigurationsRequest.builder()

      Parameters:
      listDistributionConfigurationsRequest - A Consumer that will call methods on ListDistributionConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDistributionConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDistributionConfigurationsPaginator

      default ListDistributionConfigurationsPublisher listDistributionConfigurationsPaginator(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest)

      This is a variant of listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsPublisher publisher = client.listDistributionConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsPublisher publisher = client.listDistributionConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest) operation.

      Parameters:
      listDistributionConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDistributionConfigurationsPaginator

      default ListDistributionConfigurationsPublisher listDistributionConfigurationsPaginator(Consumer<ListDistributionConfigurationsRequest.Builder> listDistributionConfigurationsRequest)

      This is a variant of listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsPublisher publisher = client.listDistributionConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsPublisher publisher = client.listDistributionConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest) operation.


      This is a convenience which creates an instance of the ListDistributionConfigurationsRequest.Builder avoiding the need to create one manually via ListDistributionConfigurationsRequest.builder()

      Parameters:
      listDistributionConfigurationsRequest - A Consumer that will call methods on ListDistributionConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageBuildVersions

      default CompletableFuture<ListImageBuildVersionsResponse> listImageBuildVersions(ListImageBuildVersionsRequest listImageBuildVersionsRequest)

      Returns a list of image build versions.

      Parameters:
      listImageBuildVersionsRequest -
      Returns:
      A Java Future containing the result of the ListImageBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageBuildVersions

      default CompletableFuture<ListImageBuildVersionsResponse> listImageBuildVersions(Consumer<ListImageBuildVersionsRequest.Builder> listImageBuildVersionsRequest)

      Returns a list of image build versions.


      This is a convenience which creates an instance of the ListImageBuildVersionsRequest.Builder avoiding the need to create one manually via ListImageBuildVersionsRequest.builder()

      Parameters:
      listImageBuildVersionsRequest - A Consumer that will call methods on ListImageBuildVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageBuildVersionsPaginator

      default ListImageBuildVersionsPublisher listImageBuildVersionsPaginator(ListImageBuildVersionsRequest listImageBuildVersionsRequest)

      This is a variant of listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsPublisher publisher = client.listImageBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsPublisher publisher = client.listImageBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest) operation.

      Parameters:
      listImageBuildVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageBuildVersionsPaginator

      default ListImageBuildVersionsPublisher listImageBuildVersionsPaginator(Consumer<ListImageBuildVersionsRequest.Builder> listImageBuildVersionsRequest)

      This is a variant of listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsPublisher publisher = client.listImageBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsPublisher publisher = client.listImageBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest) operation.


      This is a convenience which creates an instance of the ListImageBuildVersionsRequest.Builder avoiding the need to create one manually via ListImageBuildVersionsRequest.builder()

      Parameters:
      listImageBuildVersionsRequest - A Consumer that will call methods on ListImageBuildVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePackages

      default CompletableFuture<ListImagePackagesResponse> listImagePackages(ListImagePackagesRequest listImagePackagesRequest)

      Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.

      Parameters:
      listImagePackagesRequest -
      Returns:
      A Java Future containing the result of the ListImagePackages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePackages

      default CompletableFuture<ListImagePackagesResponse> listImagePackages(Consumer<ListImagePackagesRequest.Builder> listImagePackagesRequest)

      Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.


      This is a convenience which creates an instance of the ListImagePackagesRequest.Builder avoiding the need to create one manually via ListImagePackagesRequest.builder()

      Parameters:
      listImagePackagesRequest - A Consumer that will call methods on ListImagePackagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImagePackages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePackagesPaginator

      default ListImagePackagesPublisher listImagePackagesPaginator(ListImagePackagesRequest listImagePackagesRequest)

      This is a variant of listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesPublisher publisher = client.listImagePackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesPublisher publisher = client.listImagePackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest) operation.

      Parameters:
      listImagePackagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePackagesPaginator

      default ListImagePackagesPublisher listImagePackagesPaginator(Consumer<ListImagePackagesRequest.Builder> listImagePackagesRequest)

      This is a variant of listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesPublisher publisher = client.listImagePackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesPublisher publisher = client.listImagePackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest) operation.


      This is a convenience which creates an instance of the ListImagePackagesRequest.Builder avoiding the need to create one manually via ListImagePackagesRequest.builder()

      Parameters:
      listImagePackagesRequest - A Consumer that will call methods on ListImagePackagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelineImages

      default CompletableFuture<ListImagePipelineImagesResponse> listImagePipelineImages(ListImagePipelineImagesRequest listImagePipelineImagesRequest)

      Returns a list of images created by the specified pipeline.

      Parameters:
      listImagePipelineImagesRequest -
      Returns:
      A Java Future containing the result of the ListImagePipelineImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelineImages

      default CompletableFuture<ListImagePipelineImagesResponse> listImagePipelineImages(Consumer<ListImagePipelineImagesRequest.Builder> listImagePipelineImagesRequest)

      Returns a list of images created by the specified pipeline.


      This is a convenience which creates an instance of the ListImagePipelineImagesRequest.Builder avoiding the need to create one manually via ListImagePipelineImagesRequest.builder()

      Parameters:
      listImagePipelineImagesRequest - A Consumer that will call methods on ListImagePipelineImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImagePipelineImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelineImagesPaginator

      default ListImagePipelineImagesPublisher listImagePipelineImagesPaginator(ListImagePipelineImagesRequest listImagePipelineImagesRequest)

      This is a variant of listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest) operation.

      Parameters:
      listImagePipelineImagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelineImagesPaginator

      default ListImagePipelineImagesPublisher listImagePipelineImagesPaginator(Consumer<ListImagePipelineImagesRequest.Builder> listImagePipelineImagesRequest)

      This is a variant of listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest) operation.


      This is a convenience which creates an instance of the ListImagePipelineImagesRequest.Builder avoiding the need to create one manually via ListImagePipelineImagesRequest.builder()

      Parameters:
      listImagePipelineImagesRequest - A Consumer that will call methods on ListImagePipelineImagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelines

      default CompletableFuture<ListImagePipelinesResponse> listImagePipelines(ListImagePipelinesRequest listImagePipelinesRequest)

      Returns a list of image pipelines.

      Parameters:
      listImagePipelinesRequest -
      Returns:
      A Java Future containing the result of the ListImagePipelines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelines

      default CompletableFuture<ListImagePipelinesResponse> listImagePipelines(Consumer<ListImagePipelinesRequest.Builder> listImagePipelinesRequest)

      Returns a list of image pipelines.


      This is a convenience which creates an instance of the ListImagePipelinesRequest.Builder avoiding the need to create one manually via ListImagePipelinesRequest.builder()

      Parameters:
      listImagePipelinesRequest - A Consumer that will call methods on ListImagePipelinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImagePipelines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelinesPaginator

      default ListImagePipelinesPublisher listImagePipelinesPaginator(ListImagePipelinesRequest listImagePipelinesRequest)

      This is a variant of listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesPublisher publisher = client.listImagePipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesPublisher publisher = client.listImagePipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest) operation.

      Parameters:
      listImagePipelinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagePipelinesPaginator

      default ListImagePipelinesPublisher listImagePipelinesPaginator(Consumer<ListImagePipelinesRequest.Builder> listImagePipelinesRequest)

      This is a variant of listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesPublisher publisher = client.listImagePipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesPublisher publisher = client.listImagePipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest) operation.


      This is a convenience which creates an instance of the ListImagePipelinesRequest.Builder avoiding the need to create one manually via ListImagePipelinesRequest.builder()

      Parameters:
      listImagePipelinesRequest - A Consumer that will call methods on ListImagePipelinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageRecipes

      default CompletableFuture<ListImageRecipesResponse> listImageRecipes(ListImageRecipesRequest listImageRecipesRequest)

      Returns a list of image recipes.

      Parameters:
      listImageRecipesRequest -
      Returns:
      A Java Future containing the result of the ListImageRecipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageRecipes

      default CompletableFuture<ListImageRecipesResponse> listImageRecipes(Consumer<ListImageRecipesRequest.Builder> listImageRecipesRequest)

      Returns a list of image recipes.


      This is a convenience which creates an instance of the ListImageRecipesRequest.Builder avoiding the need to create one manually via ListImageRecipesRequest.builder()

      Parameters:
      listImageRecipesRequest - A Consumer that will call methods on ListImageRecipesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageRecipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageRecipesPaginator

      default ListImageRecipesPublisher listImageRecipesPaginator(ListImageRecipesRequest listImageRecipesRequest)

      This is a variant of listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesPublisher publisher = client.listImageRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesPublisher publisher = client.listImageRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest) operation.

      Parameters:
      listImageRecipesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageRecipesPaginator

      default ListImageRecipesPublisher listImageRecipesPaginator(Consumer<ListImageRecipesRequest.Builder> listImageRecipesRequest)

      This is a variant of listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesPublisher publisher = client.listImageRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesPublisher publisher = client.listImageRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest) operation.


      This is a convenience which creates an instance of the ListImageRecipesRequest.Builder avoiding the need to create one manually via ListImageRecipesRequest.builder()

      Parameters:
      listImageRecipesRequest - A Consumer that will call methods on ListImageRecipesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingAggregations

      default CompletableFuture<ListImageScanFindingAggregationsResponse> listImageScanFindingAggregations(ListImageScanFindingAggregationsRequest listImageScanFindingAggregationsRequest)

      Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.

      To streamline results, you can use the following filters in your request:

      • imageBuildVersionArn

      • imagePipelineArn

      • vulnerabilityId

      Parameters:
      listImageScanFindingAggregationsRequest -
      Returns:
      A Java Future containing the result of the ListImageScanFindingAggregations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingAggregations

      default CompletableFuture<ListImageScanFindingAggregationsResponse> listImageScanFindingAggregations(Consumer<ListImageScanFindingAggregationsRequest.Builder> listImageScanFindingAggregationsRequest)

      Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.

      To streamline results, you can use the following filters in your request:

      • imageBuildVersionArn

      • imagePipelineArn

      • vulnerabilityId


      This is a convenience which creates an instance of the ListImageScanFindingAggregationsRequest.Builder avoiding the need to create one manually via ListImageScanFindingAggregationsRequest.builder()

      Parameters:
      listImageScanFindingAggregationsRequest - A Consumer that will call methods on ListImageScanFindingAggregationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageScanFindingAggregations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingAggregationsPaginator

      default ListImageScanFindingAggregationsPublisher listImageScanFindingAggregationsPaginator(ListImageScanFindingAggregationsRequest listImageScanFindingAggregationsRequest)

      This is a variant of listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsPublisher publisher = client.listImageScanFindingAggregationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsPublisher publisher = client.listImageScanFindingAggregationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest) operation.

      Parameters:
      listImageScanFindingAggregationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingAggregationsPaginator

      default ListImageScanFindingAggregationsPublisher listImageScanFindingAggregationsPaginator(Consumer<ListImageScanFindingAggregationsRequest.Builder> listImageScanFindingAggregationsRequest)

      This is a variant of listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsPublisher publisher = client.listImageScanFindingAggregationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsPublisher publisher = client.listImageScanFindingAggregationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest) operation.


      This is a convenience which creates an instance of the ListImageScanFindingAggregationsRequest.Builder avoiding the need to create one manually via ListImageScanFindingAggregationsRequest.builder()

      Parameters:
      listImageScanFindingAggregationsRequest - A Consumer that will call methods on ListImageScanFindingAggregationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindings

      default CompletableFuture<ListImageScanFindingsResponse> listImageScanFindings(ListImageScanFindingsRequest listImageScanFindingsRequest)

      Returns a list of image scan findings for your account. Amazon Inspector generates the findings when it scans images that have scanning enabled.

      Parameters:
      listImageScanFindingsRequest -
      Returns:
      A Java Future containing the result of the ListImageScanFindings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindings

      default CompletableFuture<ListImageScanFindingsResponse> listImageScanFindings(Consumer<ListImageScanFindingsRequest.Builder> listImageScanFindingsRequest)

      Returns a list of image scan findings for your account. Amazon Inspector generates the findings when it scans images that have scanning enabled.


      This is a convenience which creates an instance of the ListImageScanFindingsRequest.Builder avoiding the need to create one manually via ListImageScanFindingsRequest.builder()

      Parameters:
      listImageScanFindingsRequest - A Consumer that will call methods on ListImageScanFindingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageScanFindings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingsPaginator

      default ListImageScanFindingsPublisher listImageScanFindingsPaginator(ListImageScanFindingsRequest listImageScanFindingsRequest)

      This is a variant of listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsPublisher publisher = client.listImageScanFindingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsPublisher publisher = client.listImageScanFindingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest) operation.

      Parameters:
      listImageScanFindingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageScanFindingsPaginator

      default ListImageScanFindingsPublisher listImageScanFindingsPaginator(Consumer<ListImageScanFindingsRequest.Builder> listImageScanFindingsRequest)

      This is a variant of listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsPublisher publisher = client.listImageScanFindingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsPublisher publisher = client.listImageScanFindingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest) operation.


      This is a convenience which creates an instance of the ListImageScanFindingsRequest.Builder avoiding the need to create one manually via ListImageScanFindingsRequest.builder()

      Parameters:
      listImageScanFindingsRequest - A Consumer that will call methods on ListImageScanFindingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImages

      default CompletableFuture<ListImagesResponse> listImages(ListImagesRequest listImagesRequest)

      Returns the list of images that you have access to.

      Parameters:
      listImagesRequest -
      Returns:
      A Java Future containing the result of the ListImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImages

      default CompletableFuture<ListImagesResponse> listImages(Consumer<ListImagesRequest.Builder> listImagesRequest)

      Returns the list of images that you have access to.


      This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to create one manually via ListImagesRequest.builder()

      Parameters:
      listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagesPaginator

      default ListImagesPublisher listImagesPaginator(ListImagesRequest listImagesRequest)

      This is a variant of listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest) operation.

      Parameters:
      listImagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagesPaginator

      default ListImagesPublisher listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest)

      This is a variant of listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest) operation.


      This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to create one manually via ListImagesRequest.builder()

      Parameters:
      listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInfrastructureConfigurations

      default CompletableFuture<ListInfrastructureConfigurationsResponse> listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest)

      Returns a list of infrastructure configurations.

      Parameters:
      listInfrastructureConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListInfrastructureConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInfrastructureConfigurations

      default CompletableFuture<ListInfrastructureConfigurationsResponse> listInfrastructureConfigurations(Consumer<ListInfrastructureConfigurationsRequest.Builder> listInfrastructureConfigurationsRequest)

      Returns a list of infrastructure configurations.


      This is a convenience which creates an instance of the ListInfrastructureConfigurationsRequest.Builder avoiding the need to create one manually via ListInfrastructureConfigurationsRequest.builder()

      Parameters:
      listInfrastructureConfigurationsRequest - A Consumer that will call methods on ListInfrastructureConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInfrastructureConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInfrastructureConfigurationsPaginator

      default ListInfrastructureConfigurationsPublisher listInfrastructureConfigurationsPaginator(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest)

      This is a variant of listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsPublisher publisher = client.listInfrastructureConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsPublisher publisher = client.listInfrastructureConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest) operation.

      Parameters:
      listInfrastructureConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInfrastructureConfigurationsPaginator

      default ListInfrastructureConfigurationsPublisher listInfrastructureConfigurationsPaginator(Consumer<ListInfrastructureConfigurationsRequest.Builder> listInfrastructureConfigurationsRequest)

      This is a variant of listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsPublisher publisher = client.listInfrastructureConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsPublisher publisher = client.listInfrastructureConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest) operation.


      This is a convenience which creates an instance of the ListInfrastructureConfigurationsRequest.Builder avoiding the need to create one manually via ListInfrastructureConfigurationsRequest.builder()

      Parameters:
      listInfrastructureConfigurationsRequest - A Consumer that will call methods on ListInfrastructureConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionResources

      default CompletableFuture<ListLifecycleExecutionResourcesResponse> listLifecycleExecutionResources(ListLifecycleExecutionResourcesRequest listLifecycleExecutionResourcesRequest)

      Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.

      Parameters:
      listLifecycleExecutionResourcesRequest -
      Returns:
      A Java Future containing the result of the ListLifecycleExecutionResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionResources

      default CompletableFuture<ListLifecycleExecutionResourcesResponse> listLifecycleExecutionResources(Consumer<ListLifecycleExecutionResourcesRequest.Builder> listLifecycleExecutionResourcesRequest)

      Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.


      This is a convenience which creates an instance of the ListLifecycleExecutionResourcesRequest.Builder avoiding the need to create one manually via ListLifecycleExecutionResourcesRequest.builder()

      Parameters:
      listLifecycleExecutionResourcesRequest - A Consumer that will call methods on ListLifecycleExecutionResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLifecycleExecutionResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionResourcesPaginator

      default ListLifecycleExecutionResourcesPublisher listLifecycleExecutionResourcesPaginator(ListLifecycleExecutionResourcesRequest listLifecycleExecutionResourcesRequest)

      This is a variant of listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesPublisher publisher = client.listLifecycleExecutionResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesPublisher publisher = client.listLifecycleExecutionResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest) operation.

      Parameters:
      listLifecycleExecutionResourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionResourcesPaginator

      default ListLifecycleExecutionResourcesPublisher listLifecycleExecutionResourcesPaginator(Consumer<ListLifecycleExecutionResourcesRequest.Builder> listLifecycleExecutionResourcesRequest)

      This is a variant of listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesPublisher publisher = client.listLifecycleExecutionResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesPublisher publisher = client.listLifecycleExecutionResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest) operation.


      This is a convenience which creates an instance of the ListLifecycleExecutionResourcesRequest.Builder avoiding the need to create one manually via ListLifecycleExecutionResourcesRequest.builder()

      Parameters:
      listLifecycleExecutionResourcesRequest - A Consumer that will call methods on ListLifecycleExecutionResourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutions

      default CompletableFuture<ListLifecycleExecutionsResponse> listLifecycleExecutions(ListLifecycleExecutionsRequest listLifecycleExecutionsRequest)

      Retrieves the lifecycle runtime history for the specified resource.

      Parameters:
      listLifecycleExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListLifecycleExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutions

      default CompletableFuture<ListLifecycleExecutionsResponse> listLifecycleExecutions(Consumer<ListLifecycleExecutionsRequest.Builder> listLifecycleExecutionsRequest)

      Retrieves the lifecycle runtime history for the specified resource.


      This is a convenience which creates an instance of the ListLifecycleExecutionsRequest.Builder avoiding the need to create one manually via ListLifecycleExecutionsRequest.builder()

      Parameters:
      listLifecycleExecutionsRequest - A Consumer that will call methods on ListLifecycleExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLifecycleExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionsPaginator

      default ListLifecycleExecutionsPublisher listLifecycleExecutionsPaginator(ListLifecycleExecutionsRequest listLifecycleExecutionsRequest)

      This is a variant of listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsPublisher publisher = client.listLifecycleExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsPublisher publisher = client.listLifecycleExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest) operation.

      Parameters:
      listLifecycleExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecycleExecutionsPaginator

      default ListLifecycleExecutionsPublisher listLifecycleExecutionsPaginator(Consumer<ListLifecycleExecutionsRequest.Builder> listLifecycleExecutionsRequest)

      This is a variant of listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsPublisher publisher = client.listLifecycleExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsPublisher publisher = client.listLifecycleExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListLifecycleExecutionsRequest.Builder avoiding the need to create one manually via ListLifecycleExecutionsRequest.builder()

      Parameters:
      listLifecycleExecutionsRequest - A Consumer that will call methods on ListLifecycleExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePolicies

      default CompletableFuture<ListLifecyclePoliciesResponse> listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)

      Retrieves a list of lifecycle policies in your Amazon Web Services account.

      Parameters:
      listLifecyclePoliciesRequest -
      Returns:
      A Java Future containing the result of the ListLifecyclePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePolicies

      default CompletableFuture<ListLifecyclePoliciesResponse> listLifecyclePolicies(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)

      Retrieves a list of lifecycle policies in your Amazon Web Services account.


      This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

      Parameters:
      listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLifecyclePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePoliciesPaginator

      default ListLifecyclePoliciesPublisher listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)

      This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest) operation.

      Parameters:
      listLifecyclePoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePoliciesPaginator

      default ListLifecyclePoliciesPublisher listLifecyclePoliciesPaginator(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)

      This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest) operation.


      This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

      Parameters:
      listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns the list of tags for the specified resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns the list of tags for the specified resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWaitingWorkflowSteps

      default CompletableFuture<ListWaitingWorkflowStepsResponse> listWaitingWorkflowSteps(ListWaitingWorkflowStepsRequest listWaitingWorkflowStepsRequest)

      Lists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond. To send a response, call SendWorkflowStepAction.

      Parameters:
      listWaitingWorkflowStepsRequest -
      Returns:
      A Java Future containing the result of the ListWaitingWorkflowSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWaitingWorkflowSteps

      default CompletableFuture<ListWaitingWorkflowStepsResponse> listWaitingWorkflowSteps(Consumer<ListWaitingWorkflowStepsRequest.Builder> listWaitingWorkflowStepsRequest)

      Lists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond. To send a response, call SendWorkflowStepAction.


      This is a convenience which creates an instance of the ListWaitingWorkflowStepsRequest.Builder avoiding the need to create one manually via ListWaitingWorkflowStepsRequest.builder()

      Parameters:
      listWaitingWorkflowStepsRequest - A Consumer that will call methods on ListWaitingWorkflowStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWaitingWorkflowSteps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWaitingWorkflowStepsPaginator

      default ListWaitingWorkflowStepsPublisher listWaitingWorkflowStepsPaginator(ListWaitingWorkflowStepsRequest listWaitingWorkflowStepsRequest)

      This is a variant of listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsPublisher publisher = client.listWaitingWorkflowStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsPublisher publisher = client.listWaitingWorkflowStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest) operation.

      Parameters:
      listWaitingWorkflowStepsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWaitingWorkflowStepsPaginator

      default ListWaitingWorkflowStepsPublisher listWaitingWorkflowStepsPaginator(Consumer<ListWaitingWorkflowStepsRequest.Builder> listWaitingWorkflowStepsRequest)

      This is a variant of listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsPublisher publisher = client.listWaitingWorkflowStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsPublisher publisher = client.listWaitingWorkflowStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest) operation.


      This is a convenience which creates an instance of the ListWaitingWorkflowStepsRequest.Builder avoiding the need to create one manually via ListWaitingWorkflowStepsRequest.builder()

      Parameters:
      listWaitingWorkflowStepsRequest - A Consumer that will call methods on ListWaitingWorkflowStepsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowBuildVersions

      default CompletableFuture<ListWorkflowBuildVersionsResponse> listWorkflowBuildVersions(ListWorkflowBuildVersionsRequest listWorkflowBuildVersionsRequest)

      Returns a list of build versions for a specific workflow resource.

      Parameters:
      listWorkflowBuildVersionsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflowBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowBuildVersions

      default CompletableFuture<ListWorkflowBuildVersionsResponse> listWorkflowBuildVersions(Consumer<ListWorkflowBuildVersionsRequest.Builder> listWorkflowBuildVersionsRequest)

      Returns a list of build versions for a specific workflow resource.


      This is a convenience which creates an instance of the ListWorkflowBuildVersionsRequest.Builder avoiding the need to create one manually via ListWorkflowBuildVersionsRequest.builder()

      Parameters:
      listWorkflowBuildVersionsRequest - A Consumer that will call methods on ListWorkflowBuildVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflowBuildVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowBuildVersionsPaginator

      default ListWorkflowBuildVersionsPublisher listWorkflowBuildVersionsPaginator(ListWorkflowBuildVersionsRequest listWorkflowBuildVersionsRequest)

      This is a variant of listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsPublisher publisher = client.listWorkflowBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsPublisher publisher = client.listWorkflowBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest) operation.

      Parameters:
      listWorkflowBuildVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowBuildVersionsPaginator

      default ListWorkflowBuildVersionsPublisher listWorkflowBuildVersionsPaginator(Consumer<ListWorkflowBuildVersionsRequest.Builder> listWorkflowBuildVersionsRequest)

      This is a variant of listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsPublisher publisher = client.listWorkflowBuildVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsPublisher publisher = client.listWorkflowBuildVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest) operation.


      This is a convenience which creates an instance of the ListWorkflowBuildVersionsRequest.Builder avoiding the need to create one manually via ListWorkflowBuildVersionsRequest.builder()

      Parameters:
      listWorkflowBuildVersionsRequest - A Consumer that will call methods on ListWorkflowBuildVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowExecutions

      default CompletableFuture<ListWorkflowExecutionsResponse> listWorkflowExecutions(ListWorkflowExecutionsRequest listWorkflowExecutionsRequest)

      Returns a list of workflow runtime instance metadata objects for a specific image build version.

      Parameters:
      listWorkflowExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowExecutions

      default CompletableFuture<ListWorkflowExecutionsResponse> listWorkflowExecutions(Consumer<ListWorkflowExecutionsRequest.Builder> listWorkflowExecutionsRequest)

      Returns a list of workflow runtime instance metadata objects for a specific image build version.


      This is a convenience which creates an instance of the ListWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListWorkflowExecutionsRequest.builder()

      Parameters:
      listWorkflowExecutionsRequest - A Consumer that will call methods on ListWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowExecutionsPaginator

      default ListWorkflowExecutionsPublisher listWorkflowExecutionsPaginator(ListWorkflowExecutionsRequest listWorkflowExecutionsRequest)

      This is a variant of listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsPublisher publisher = client.listWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsPublisher publisher = client.listWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest) operation.

      Parameters:
      listWorkflowExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowExecutionsPaginator

      default ListWorkflowExecutionsPublisher listWorkflowExecutionsPaginator(Consumer<ListWorkflowExecutionsRequest.Builder> listWorkflowExecutionsRequest)

      This is a variant of listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsPublisher publisher = client.listWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsPublisher publisher = client.listWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListWorkflowExecutionsRequest.builder()

      Parameters:
      listWorkflowExecutionsRequest - A Consumer that will call methods on ListWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowStepExecutions

      default CompletableFuture<ListWorkflowStepExecutionsResponse> listWorkflowStepExecutions(ListWorkflowStepExecutionsRequest listWorkflowStepExecutionsRequest)

      Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

      Parameters:
      listWorkflowStepExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflowStepExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowStepExecutions

      default CompletableFuture<ListWorkflowStepExecutionsResponse> listWorkflowStepExecutions(Consumer<ListWorkflowStepExecutionsRequest.Builder> listWorkflowStepExecutionsRequest)

      Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.


      This is a convenience which creates an instance of the ListWorkflowStepExecutionsRequest.Builder avoiding the need to create one manually via ListWorkflowStepExecutionsRequest.builder()

      Parameters:
      listWorkflowStepExecutionsRequest - A Consumer that will call methods on ListWorkflowStepExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflowStepExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowStepExecutionsPaginator

      default ListWorkflowStepExecutionsPublisher listWorkflowStepExecutionsPaginator(ListWorkflowStepExecutionsRequest listWorkflowStepExecutionsRequest)

      This is a variant of listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsPublisher publisher = client.listWorkflowStepExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsPublisher publisher = client.listWorkflowStepExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest) operation.

      Parameters:
      listWorkflowStepExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowStepExecutionsPaginator

      default ListWorkflowStepExecutionsPublisher listWorkflowStepExecutionsPaginator(Consumer<ListWorkflowStepExecutionsRequest.Builder> listWorkflowStepExecutionsRequest)

      This is a variant of listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsPublisher publisher = client.listWorkflowStepExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsPublisher publisher = client.listWorkflowStepExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListWorkflowStepExecutionsRequest.Builder avoiding the need to create one manually via ListWorkflowStepExecutionsRequest.builder()

      Parameters:
      listWorkflowStepExecutionsRequest - A Consumer that will call methods on ListWorkflowStepExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

      Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call ListWorkflowBuildVersions.

      Parameters:
      listWorkflowsRequest -
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflows

      default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

      Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call ListWorkflowBuildVersions.


      This is a convenience which creates an instance of the ListWorkflowsRequest.Builder avoiding the need to create one manually via ListWorkflowsRequest.builder()

      Parameters:
      listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkflows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowsPaginator

      default ListWorkflowsPublisher listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest)

      This is a variant of listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest) operation.

      Parameters:
      listWorkflowsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkflowsPaginator

      default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest)

      This is a variant of listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest) operation.


      This is a convenience which creates an instance of the ListWorkflowsRequest.Builder avoiding the need to create one manually via ListWorkflowsRequest.builder()

      Parameters:
      listWorkflowsRequest - A Consumer that will call methods on ListWorkflowsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidPaginationTokenException You have provided an invalid pagination token in your request.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putComponentPolicy

      default CompletableFuture<PutComponentPolicyResponse> putComponentPolicy(PutComponentPolicyRequest putComponentPolicyRequest)

      Applies a policy to a component. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutComponentPolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.

      Parameters:
      putComponentPolicyRequest -
      Returns:
      A Java Future containing the result of the PutComponentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putComponentPolicy

      default CompletableFuture<PutComponentPolicyResponse> putComponentPolicy(Consumer<PutComponentPolicyRequest.Builder> putComponentPolicyRequest)

      Applies a policy to a component. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutComponentPolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.


      This is a convenience which creates an instance of the PutComponentPolicyRequest.Builder avoiding the need to create one manually via PutComponentPolicyRequest.builder()

      Parameters:
      putComponentPolicyRequest - A Consumer that will call methods on PutComponentPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutComponentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putContainerRecipePolicy

      default CompletableFuture<PutContainerRecipePolicyResponse> putContainerRecipePolicy(PutContainerRecipePolicyRequest putContainerRecipePolicyRequest)

      Applies a policy to a container recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutContainerRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.

      Parameters:
      putContainerRecipePolicyRequest -
      Returns:
      A Java Future containing the result of the PutContainerRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putContainerRecipePolicy

      default CompletableFuture<PutContainerRecipePolicyResponse> putContainerRecipePolicy(Consumer<PutContainerRecipePolicyRequest.Builder> putContainerRecipePolicyRequest)

      Applies a policy to a container recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutContainerRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.


      This is a convenience which creates an instance of the PutContainerRecipePolicyRequest.Builder avoiding the need to create one manually via PutContainerRecipePolicyRequest.builder()

      Parameters:
      putContainerRecipePolicyRequest - A Consumer that will call methods on PutContainerRecipePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutContainerRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putImagePolicy

      default CompletableFuture<PutImagePolicyResponse> putImagePolicy(PutImagePolicyRequest putImagePolicyRequest)

      Applies a policy to an image. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImagePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.

      Parameters:
      putImagePolicyRequest -
      Returns:
      A Java Future containing the result of the PutImagePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putImagePolicy

      default CompletableFuture<PutImagePolicyResponse> putImagePolicy(Consumer<PutImagePolicyRequest.Builder> putImagePolicyRequest)

      Applies a policy to an image. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImagePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.


      This is a convenience which creates an instance of the PutImagePolicyRequest.Builder avoiding the need to create one manually via PutImagePolicyRequest.builder()

      Parameters:
      putImagePolicyRequest - A Consumer that will call methods on PutImagePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutImagePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putImageRecipePolicy

      default CompletableFuture<PutImageRecipePolicyResponse> putImageRecipePolicy(PutImageRecipePolicyRequest putImageRecipePolicyRequest)

      Applies a policy to an image recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImageRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.

      Parameters:
      putImageRecipePolicyRequest -
      Returns:
      A Java Future containing the result of the PutImageRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putImageRecipePolicy

      default CompletableFuture<PutImageRecipePolicyResponse> putImageRecipePolicy(Consumer<PutImageRecipePolicyRequest.Builder> putImageRecipePolicyRequest)

      Applies a policy to an image recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImageRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.


      This is a convenience which creates an instance of the PutImageRecipePolicyRequest.Builder avoiding the need to create one manually via PutImageRecipePolicyRequest.builder()

      Parameters:
      putImageRecipePolicyRequest - A Consumer that will call methods on PutImageRecipePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutImageRecipePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retryImage

      default CompletableFuture<RetryImageResponse> retryImage(RetryImageRequest retryImageRequest)

      Retries a failed or canceled image build without rebuilding the phases that already completed. The image re-runs asynchronously in place: the same build version returns to the test or distribution phase where it failed and continues from there. No new image build version is created. Retry is only supported for AMI-based images.

      Parameters:
      retryImageRequest -
      Returns:
      A Java Future containing the result of the RetryImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retryImage

      default CompletableFuture<RetryImageResponse> retryImage(Consumer<RetryImageRequest.Builder> retryImageRequest)

      Retries a failed or canceled image build without rebuilding the phases that already completed. The image re-runs asynchronously in place: the same build version returns to the test or distribution phase where it failed and continues from there. No new image build version is created. Retry is only supported for AMI-based images.


      This is a convenience which creates an instance of the RetryImageRequest.Builder avoiding the need to create one manually via RetryImageRequest.builder()

      Parameters:
      retryImageRequest - A Consumer that will call methods on RetryImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RetryImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendWorkflowStepAction

      default CompletableFuture<SendWorkflowStepActionResponse> sendWorkflowStepAction(SendWorkflowStepActionRequest sendWorkflowStepActionRequest)

      Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an action, call ListWaitingWorkflowSteps.

      Parameters:
      sendWorkflowStepActionRequest -
      Returns:
      A Java Future containing the result of the SendWorkflowStepAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendWorkflowStepAction

      default CompletableFuture<SendWorkflowStepActionResponse> sendWorkflowStepAction(Consumer<SendWorkflowStepActionRequest.Builder> sendWorkflowStepActionRequest)

      Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an action, call ListWaitingWorkflowSteps.


      This is a convenience which creates an instance of the SendWorkflowStepActionRequest.Builder avoiding the need to create one manually via SendWorkflowStepActionRequest.builder()

      Parameters:
      sendWorkflowStepActionRequest - A Consumer that will call methods on SendWorkflowStepActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendWorkflowStepAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • InvalidParameterValueException The value that you provided for the specified parameter is invalid.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startImagePipelineExecution

      default CompletableFuture<StartImagePipelineExecutionResponse> startImagePipelineExecution(StartImagePipelineExecutionRequest startImagePipelineExecutionRequest)

      Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with GetImage to track build progress.

      Parameters:
      startImagePipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the StartImagePipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • 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.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startImagePipelineExecution

      default CompletableFuture<StartImagePipelineExecutionResponse> startImagePipelineExecution(Consumer<StartImagePipelineExecutionRequest.Builder> startImagePipelineExecutionRequest)

      Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with GetImage to track build progress.


      This is a convenience which creates an instance of the StartImagePipelineExecutionRequest.Builder avoiding the need to create one manually via StartImagePipelineExecutionRequest.builder()

      Parameters:
      startImagePipelineExecutionRequest - A Consumer that will call methods on StartImagePipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartImagePipelineExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • 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.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startResourceStateUpdate

      default CompletableFuture<StartResourceStateUpdateResponse> startResourceStateUpdate(StartResourceStateUpdateRequest startResourceStateUpdateRequest)

      Begins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the request includes underlying resources, or schedules the update far enough in the future, Image Builder runs the update as an asynchronous lifecycle execution and returns its identifier. Otherwise, for target states other than DELETED, the state change applies immediately. If a request that starts a lifecycle execution arrives while the image already has one in progress, Image Builder rejects it.

      Parameters:
      startResourceStateUpdateRequest -
      Returns:
      A Java Future containing the result of the StartResourceStateUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • 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.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startResourceStateUpdate

      default CompletableFuture<StartResourceStateUpdateResponse> startResourceStateUpdate(Consumer<StartResourceStateUpdateRequest.Builder> startResourceStateUpdateRequest)

      Begins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the request includes underlying resources, or schedules the update far enough in the future, Image Builder runs the update as an asynchronous lifecycle execution and returns its identifier. Otherwise, for target states other than DELETED, the state change applies immediately. If a request that starts a lifecycle execution arrives while the image already has one in progress, Image Builder rejects it.


      This is a convenience which creates an instance of the StartResourceStateUpdateRequest.Builder avoiding the need to create one manually via StartResourceStateUpdateRequest.builder()

      Parameters:
      startResourceStateUpdateRequest - A Consumer that will call methods on StartResourceStateUpdateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartResourceStateUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • 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.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds a tag to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds a tag to a resource.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a tag from a resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException At least one of the resources referenced by your request does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistributionConfiguration

      default CompletableFuture<UpdateDistributionConfigurationResponse> updateDistributionConfiguration(UpdateDistributionConfigurationRequest updateDistributionConfigurationRequest)

      Updates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.

      This operation doesn't support selective updates. The request replaces the stored configuration, so include every setting that you want to keep.

      Parameters:
      updateDistributionConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistributionConfiguration

      default CompletableFuture<UpdateDistributionConfigurationResponse> updateDistributionConfiguration(Consumer<UpdateDistributionConfigurationRequest.Builder> updateDistributionConfigurationRequest)

      Updates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.

      This operation doesn't support selective updates. The request replaces the stored configuration, so include every setting that you want to keep.


      This is a convenience which creates an instance of the UpdateDistributionConfigurationRequest.Builder avoiding the need to create one manually via UpdateDistributionConfigurationRequest.builder()

      Parameters:
      updateDistributionConfigurationRequest - A Consumer that will call methods on UpdateDistributionConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDistributionConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImagePipeline

      default CompletableFuture<UpdateImagePipelineResponse> updateImagePipeline(UpdateImagePipelineRequest updateImagePipelineRequest)

      Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.

      UpdateImagePipeline does not support selective updates. The request replaces the pipeline's entire configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.

      Parameters:
      updateImagePipelineRequest -
      Returns:
      A Java Future containing the result of the UpdateImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImagePipeline

      default CompletableFuture<UpdateImagePipelineResponse> updateImagePipeline(Consumer<UpdateImagePipelineRequest.Builder> updateImagePipelineRequest)

      Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.

      UpdateImagePipeline does not support selective updates. The request replaces the pipeline's entire configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.


      This is a convenience which creates an instance of the UpdateImagePipelineRequest.Builder avoiding the need to create one manually via UpdateImagePipelineRequest.builder()

      Parameters:
      updateImagePipelineRequest - A Consumer that will call methods on UpdateImagePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateImagePipeline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInfrastructureConfiguration

      default CompletableFuture<UpdateInfrastructureConfigurationResponse> updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest updateInfrastructureConfigurationRequest)

      Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.

      This operation doesn't support selective updates. The request replaces the configuration, so include every setting that you want to keep. Omitted optional properties are cleared.

      Parameters:
      updateInfrastructureConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInfrastructureConfiguration

      default CompletableFuture<UpdateInfrastructureConfigurationResponse> updateInfrastructureConfiguration(Consumer<UpdateInfrastructureConfigurationRequest.Builder> updateInfrastructureConfigurationRequest)

      Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.

      This operation doesn't support selective updates. The request replaces the configuration, so include every setting that you want to keep. Omitted optional properties are cleared.


      This is a convenience which creates an instance of the UpdateInfrastructureConfigurationRequest.Builder avoiding the need to create one manually via UpdateInfrastructureConfigurationRequest.builder()

      Parameters:
      updateInfrastructureConfigurationRequest - A Consumer that will call methods on UpdateInfrastructureConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInfrastructureConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLifecyclePolicy

      default CompletableFuture<UpdateLifecyclePolicyResponse> updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)

      Updates the specified lifecycle policy. The request replaces the existing policy configuration rather than merging changes, so re-specify every setting that you want to keep. The resourceType must match the existing policy's value.

      Parameters:
      updateLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLifecyclePolicy

      default CompletableFuture<UpdateLifecyclePolicyResponse> updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)

      Updates the specified lifecycle policy. The request replaces the existing policy configuration rather than merging changes, so re-specify every setting that you want to keep. The resourceType must match the existing policy's value.


      This is a convenience which creates an instance of the UpdateLifecyclePolicyRequest.Builder avoiding the need to create one manually via UpdateLifecyclePolicyRequest.builder()

      Parameters:
      updateLifecyclePolicyRequest - A Consumer that will call methods on UpdateLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
      • 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.
      • ServiceUnavailableException The service is unable to process your request at this time.
      • InvalidRequestException The request is malformed or otherwise invalid. Verify the request and try again.
      • IdempotentParameterMismatchException You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
      • ForbiddenException You are not authorized to perform the requested operation.
      • 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.
      • ResourceInUseException The resource that you are trying to operate on is currently in use. Review the message details and retry later.
      • InvalidParameterCombinationException You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ImagebuilderException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ImagebuilderServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ImagebuilderAsyncClient create()
      Create a ImagebuilderAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ImagebuilderAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ImagebuilderAsyncClient.