Interface ImagebuilderClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ImagebuilderClient extends AwsClient
Service client for accessing imagebuilder. This can be created using the staticbuilder()method.EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelImageCreation
default CancelImageCreationResponse cancelImageCreation(CancelImageCreationRequest cancelImageCreationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
- Parameters:
cancelImageCreationRequest-- Returns:
- Result of the CancelImageCreation operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelImageCreation
default CancelImageCreationResponse cancelImageCreation(Consumer<CancelImageCreationRequest.Builder> cancelImageCreationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
This is a convenience which creates an instance of the
CancelImageCreationRequest.Builderavoiding the need to create one manually viaCancelImageCreationRequest.builder()- Parameters:
cancelImageCreationRequest- AConsumerthat will call methods onCancelImageCreationRequest.Builderto create a request.- Returns:
- Result of the CancelImageCreation operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelLifecycleExecution
default CancelLifecycleExecutionResponse cancelLifecycleExecution(CancelLifecycleExecutionRequest cancelLifecycleExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Cancel a specific image lifecycle policy runtime instance.
- Parameters:
cancelLifecycleExecutionRequest-- Returns:
- Result of the CancelLifecycleExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelLifecycleExecution
default CancelLifecycleExecutionResponse cancelLifecycleExecution(Consumer<CancelLifecycleExecutionRequest.Builder> cancelLifecycleExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Cancel a specific image lifecycle policy runtime instance.
This is a convenience which creates an instance of the
CancelLifecycleExecutionRequest.Builderavoiding the need to create one manually viaCancelLifecycleExecutionRequest.builder()- Parameters:
cancelLifecycleExecutionRequest- AConsumerthat will call methods onCancelLifecycleExecutionRequest.Builderto create a request.- Returns:
- Result of the CancelLifecycleExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
createComponent
default CreateComponentResponse createComponent(CreateComponentRequest createComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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
dataproperty in the request body. -
A URL that points to a YAML document file stored in Amazon S3, using the
uriproperty in the request body.
- Parameters:
createComponentRequest-- Returns:
- Result of the CreateComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createComponent
default CreateComponentResponse createComponent(Consumer<CreateComponentRequest.Builder> createComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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
dataproperty in the request body. -
A URL that points to a YAML document file stored in Amazon S3, using the
uriproperty in the request body.
This is a convenience which creates an instance of the
CreateComponentRequest.Builderavoiding the need to create one manually viaCreateComponentRequest.builder()- Parameters:
createComponentRequest- AConsumerthat will call methods onCreateComponentRequest.Builderto create a request.- Returns:
- Result of the CreateComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createContainerRecipe
default CreateContainerRecipeResponse createContainerRecipe(CreateContainerRecipeRequest createContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
- Parameters:
createContainerRecipeRequest-- Returns:
- Result of the CreateContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createContainerRecipe
default CreateContainerRecipeResponse createContainerRecipe(Consumer<CreateContainerRecipeRequest.Builder> createContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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.Builderavoiding the need to create one manually viaCreateContainerRecipeRequest.builder()- Parameters:
createContainerRecipeRequest- AConsumerthat will call methods onCreateContainerRecipeRequest.Builderto create a request.- Returns:
- Result of the CreateContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createDistributionConfiguration
default CreateDistributionConfigurationResponse createDistributionConfiguration(CreateDistributionConfigurationRequest createDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
- Parameters:
createDistributionConfigurationRequest-- Returns:
- Result of the CreateDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createDistributionConfiguration
default CreateDistributionConfigurationResponse createDistributionConfiguration(Consumer<CreateDistributionConfigurationRequest.Builder> createDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
This is a convenience which creates an instance of the
CreateDistributionConfigurationRequest.Builderavoiding the need to create one manually viaCreateDistributionConfigurationRequest.builder()- Parameters:
createDistributionConfigurationRequest- AConsumerthat will call methods onCreateDistributionConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImage
default CreateImageResponse createImage(CreateImageRequest createImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
- Parameters:
createImageRequest-- Returns:
- Result of the CreateImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImage
default CreateImageResponse createImage(Consumer<CreateImageRequest.Builder> createImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
This is a convenience which creates an instance of the
CreateImageRequest.Builderavoiding the need to create one manually viaCreateImageRequest.builder()- Parameters:
createImageRequest- AConsumerthat will call methods onCreateImageRequest.Builderto create a request.- Returns:
- Result of the CreateImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImagePipeline
default CreateImagePipelineResponse createImagePipeline(CreateImagePipelineRequest createImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
- Parameters:
createImagePipelineRequest-- Returns:
- Result of the CreateImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImagePipeline
default CreateImagePipelineResponse createImagePipeline(Consumer<CreateImagePipelineRequest.Builder> createImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
This is a convenience which creates an instance of the
CreateImagePipelineRequest.Builderavoiding the need to create one manually viaCreateImagePipelineRequest.builder()- Parameters:
createImagePipelineRequest- AConsumerthat will call methods onCreateImagePipelineRequest.Builderto create a request.- Returns:
- Result of the CreateImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImageRecipe
default CreateImageRecipeResponse createImageRecipe(CreateImageRecipeRequest createImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
- Parameters:
createImageRecipeRequest-- Returns:
- Result of the CreateImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createImageRecipe
default CreateImageRecipeResponse createImageRecipe(Consumer<CreateImageRecipeRequest.Builder> createImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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.Builderavoiding the need to create one manually viaCreateImageRecipeRequest.builder()- Parameters:
createImageRecipeRequest- AConsumerthat will call methods onCreateImageRecipeRequest.Builderto create a request.- Returns:
- Result of the CreateImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createInfrastructureConfiguration
default CreateInfrastructureConfigurationResponse createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest createInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
- Parameters:
createInfrastructureConfigurationRequest-- Returns:
- Result of the CreateInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createInfrastructureConfiguration
default CreateInfrastructureConfigurationResponse createInfrastructureConfiguration(Consumer<CreateInfrastructureConfigurationRequest.Builder> createInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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.Builderavoiding the need to create one manually viaCreateInfrastructureConfigurationRequest.builder()- Parameters:
createInfrastructureConfigurationRequest- AConsumerthat will call methods onCreateInfrastructureConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createLifecyclePolicy
default CreateLifecyclePolicyResponse createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Create a lifecycle policy resource.
- Parameters:
createLifecyclePolicyRequest-- Returns:
- Result of the CreateLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createLifecyclePolicy
default CreateLifecyclePolicyResponse createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, ResourceAlreadyExistsException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Create a lifecycle policy resource.
This is a convenience which creates an instance of the
CreateLifecyclePolicyRequest.Builderavoiding the need to create one manually viaCreateLifecyclePolicyRequest.builder()- Parameters:
createLifecyclePolicyRequest- AConsumerthat will call methods onCreateLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the CreateLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkflow
default CreateWorkflowResponse createWorkflow(CreateWorkflowRequest createWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Create a new workflow or a new version of an existing workflow.
- Parameters:
createWorkflowRequest-- Returns:
- Result of the CreateWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkflow
default CreateWorkflowResponse createWorkflow(Consumer<CreateWorkflowRequest.Builder> createWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Create a new workflow or a new version of an existing workflow.
This is a convenience which creates an instance of the
CreateWorkflowRequest.Builderavoiding the need to create one manually viaCreateWorkflowRequest.builder()- Parameters:
createWorkflowRequest- AConsumerthat will call methods onCreateWorkflowRequest.Builderto create a request.- Returns:
- Result of the CreateWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteComponent
default DeleteComponentResponse deleteComponent(DeleteComponentRequest deleteComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a component build version.
- Parameters:
deleteComponentRequest-- Returns:
- Result of the DeleteComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteComponent
default DeleteComponentResponse deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a component build version.
This is a convenience which creates an instance of the
DeleteComponentRequest.Builderavoiding the need to create one manually viaDeleteComponentRequest.builder()- Parameters:
deleteComponentRequest- AConsumerthat will call methods onDeleteComponentRequest.Builderto create a request.- Returns:
- Result of the DeleteComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContainerRecipe
default DeleteContainerRecipeResponse deleteContainerRecipe(DeleteContainerRecipeRequest deleteContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a container recipe.
- Parameters:
deleteContainerRecipeRequest-- Returns:
- Result of the DeleteContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContainerRecipe
default DeleteContainerRecipeResponse deleteContainerRecipe(Consumer<DeleteContainerRecipeRequest.Builder> deleteContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a container recipe.
This is a convenience which creates an instance of the
DeleteContainerRecipeRequest.Builderavoiding the need to create one manually viaDeleteContainerRecipeRequest.builder()- Parameters:
deleteContainerRecipeRequest- AConsumerthat will call methods onDeleteContainerRecipeRequest.Builderto create a request.- Returns:
- Result of the DeleteContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDistributionConfiguration
default DeleteDistributionConfigurationResponse deleteDistributionConfiguration(DeleteDistributionConfigurationRequest deleteDistributionConfigurationRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a distribution configuration.
- Parameters:
deleteDistributionConfigurationRequest-- Returns:
- Result of the DeleteDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDistributionConfiguration
default DeleteDistributionConfigurationResponse deleteDistributionConfiguration(Consumer<DeleteDistributionConfigurationRequest.Builder> deleteDistributionConfigurationRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a distribution configuration.
This is a convenience which creates an instance of the
DeleteDistributionConfigurationRequest.Builderavoiding the need to create one manually viaDeleteDistributionConfigurationRequest.builder()- Parameters:
deleteDistributionConfigurationRequest- AConsumerthat will call methods onDeleteDistributionConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImage
default DeleteImageResponse deleteImage(DeleteImageRequest deleteImageRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
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.
-
To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
-
To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
-
To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.
- Parameters:
deleteImageRequest-- Returns:
- Result of the DeleteImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteImage
default DeleteImageResponse deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
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.
-
To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
-
To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
-
To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.
This is a convenience which creates an instance of the
DeleteImageRequest.Builderavoiding the need to create one manually viaDeleteImageRequest.builder()- Parameters:
deleteImageRequest- AConsumerthat will call methods onDeleteImageRequest.Builderto create a request.- Returns:
- Result of the DeleteImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteImagePipeline
default DeleteImagePipelineResponse deleteImagePipeline(DeleteImagePipelineRequest deleteImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an image pipeline.
- Parameters:
deleteImagePipelineRequest-- Returns:
- Result of the DeleteImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImagePipeline
default DeleteImagePipelineResponse deleteImagePipeline(Consumer<DeleteImagePipelineRequest.Builder> deleteImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an image pipeline.
This is a convenience which creates an instance of the
DeleteImagePipelineRequest.Builderavoiding the need to create one manually viaDeleteImagePipelineRequest.builder()- Parameters:
deleteImagePipelineRequest- AConsumerthat will call methods onDeleteImagePipelineRequest.Builderto create a request.- Returns:
- Result of the DeleteImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImageRecipe
default DeleteImageRecipeResponse deleteImageRecipe(DeleteImageRecipeRequest deleteImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an image recipe.
- Parameters:
deleteImageRecipeRequest-- Returns:
- Result of the DeleteImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImageRecipe
default DeleteImageRecipeResponse deleteImageRecipe(Consumer<DeleteImageRecipeRequest.Builder> deleteImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an image recipe.
This is a convenience which creates an instance of the
DeleteImageRecipeRequest.Builderavoiding the need to create one manually viaDeleteImageRecipeRequest.builder()- Parameters:
deleteImageRecipeRequest- AConsumerthat will call methods onDeleteImageRecipeRequest.Builderto create a request.- Returns:
- Result of the DeleteImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInfrastructureConfiguration
default DeleteInfrastructureConfigurationResponse deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest deleteInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an infrastructure configuration.
- Parameters:
deleteInfrastructureConfigurationRequest-- Returns:
- Result of the DeleteInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteInfrastructureConfiguration
default DeleteInfrastructureConfigurationResponse deleteInfrastructureConfiguration(Consumer<DeleteInfrastructureConfigurationRequest.Builder> deleteInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes an infrastructure configuration.
This is a convenience which creates an instance of the
DeleteInfrastructureConfigurationRequest.Builderavoiding the need to create one manually viaDeleteInfrastructureConfigurationRequest.builder()- Parameters:
deleteInfrastructureConfigurationRequest- AConsumerthat will call methods onDeleteInfrastructureConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Delete the specified lifecycle policy resource.
- Parameters:
deleteLifecyclePolicyRequest-- Returns:
- Result of the DeleteLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ServiceException, ClientException, InvalidRequestException, ServiceUnavailableException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Delete the specified lifecycle policy resource.
This is a convenience which creates an instance of the
DeleteLifecyclePolicyRequest.Builderavoiding the need to create one manually viaDeleteLifecyclePolicyRequest.builder()- Parameters:
deleteLifecyclePolicyRequest- AConsumerthat will call methods onDeleteLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkflow
default DeleteWorkflowResponse deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a specific workflow resource.
- Parameters:
deleteWorkflowRequest-- Returns:
- Result of the DeleteWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkflow
default DeleteWorkflowResponse deleteWorkflow(Consumer<DeleteWorkflowRequest.Builder> deleteWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, ResourceDependencyException, AwsServiceException, SdkClientException, ImagebuilderException
Deletes a specific workflow resource.
This is a convenience which creates an instance of the
DeleteWorkflowRequest.Builderavoiding the need to create one manually viaDeleteWorkflowRequest.builder()- Parameters:
deleteWorkflowRequest- AConsumerthat will call methods onDeleteWorkflowRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate for the specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponent
default GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a component object.
- Parameters:
getComponentRequest-- Returns:
- Result of the GetComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponent
default GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a component object.
This is a convenience which creates an instance of the
GetComponentRequest.Builderavoiding the need to create one manually viaGetComponentRequest.builder()- Parameters:
getComponentRequest- AConsumerthat will call methods onGetComponentRequest.Builderto create a request.- Returns:
- Result of the GetComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponentPolicy
default GetComponentPolicyResponse getComponentPolicy(GetComponentPolicyRequest getComponentPolicyRequest) throws ServiceException, ServiceUnavailableException, ResourceNotFoundException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a component policy.
- Parameters:
getComponentPolicyRequest-- Returns:
- Result of the GetComponentPolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponentPolicy
default GetComponentPolicyResponse getComponentPolicy(Consumer<GetComponentPolicyRequest.Builder> getComponentPolicyRequest) throws ServiceException, ServiceUnavailableException, ResourceNotFoundException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a component policy.
This is a convenience which creates an instance of the
GetComponentPolicyRequest.Builderavoiding the need to create one manually viaGetComponentPolicyRequest.builder()- Parameters:
getComponentPolicyRequest- AConsumerthat will call methods onGetComponentPolicyRequest.Builderto create a request.- Returns:
- Result of the GetComponentPolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getContainerRecipe
default GetContainerRecipeResponse getContainerRecipe(GetContainerRecipeRequest getContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Retrieves a container recipe.
- Parameters:
getContainerRecipeRequest-- Returns:
- Result of the GetContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getContainerRecipe
default GetContainerRecipeResponse getContainerRecipe(Consumer<GetContainerRecipeRequest.Builder> getContainerRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Retrieves a container recipe.
This is a convenience which creates an instance of the
GetContainerRecipeRequest.Builderavoiding the need to create one manually viaGetContainerRecipeRequest.builder()- Parameters:
getContainerRecipeRequest- AConsumerthat will call methods onGetContainerRecipeRequest.Builderto create a request.- Returns:
- Result of the GetContainerRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getContainerRecipePolicy
default GetContainerRecipePolicyResponse getContainerRecipePolicy(GetContainerRecipePolicyRequest getContainerRecipePolicyRequest) throws ServiceException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Retrieves the policy for a container recipe.
- Parameters:
getContainerRecipePolicyRequest-- Returns:
- Result of the GetContainerRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
getContainerRecipePolicy
default GetContainerRecipePolicyResponse getContainerRecipePolicy(Consumer<GetContainerRecipePolicyRequest.Builder> getContainerRecipePolicyRequest) throws ServiceException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Retrieves the policy for a container recipe.
This is a convenience which creates an instance of the
GetContainerRecipePolicyRequest.Builderavoiding the need to create one manually viaGetContainerRecipePolicyRequest.builder()- Parameters:
getContainerRecipePolicyRequest- AConsumerthat will call methods onGetContainerRecipePolicyRequest.Builderto create a request.- Returns:
- Result of the GetContainerRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
getDistributionConfiguration
default GetDistributionConfigurationResponse getDistributionConfiguration(GetDistributionConfigurationRequest getDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a distribution configuration.
- Parameters:
getDistributionConfigurationRequest-- Returns:
- Result of the GetDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getDistributionConfiguration
default GetDistributionConfigurationResponse getDistributionConfiguration(Consumer<GetDistributionConfigurationRequest.Builder> getDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets a distribution configuration.
This is a convenience which creates an instance of the
GetDistributionConfigurationRequest.Builderavoiding the need to create one manually viaGetDistributionConfigurationRequest.builder()- Parameters:
getDistributionConfigurationRequest- AConsumerthat will call methods onGetDistributionConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImage
default GetImageResponse getImage(GetImageRequest getImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image.
- Parameters:
getImageRequest-- Returns:
- Result of the GetImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImage
default GetImageResponse getImage(Consumer<GetImageRequest.Builder> getImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image.
This is a convenience which creates an instance of the
GetImageRequest.Builderavoiding the need to create one manually viaGetImageRequest.builder()- Parameters:
getImageRequest- AConsumerthat will call methods onGetImageRequest.Builderto create a request.- Returns:
- Result of the GetImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImagePipeline
default GetImagePipelineResponse getImagePipeline(GetImagePipelineRequest getImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image pipeline.
- Parameters:
getImagePipelineRequest-- Returns:
- Result of the GetImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImagePipeline
default GetImagePipelineResponse getImagePipeline(Consumer<GetImagePipelineRequest.Builder> getImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image pipeline.
This is a convenience which creates an instance of the
GetImagePipelineRequest.Builderavoiding the need to create one manually viaGetImagePipelineRequest.builder()- Parameters:
getImagePipelineRequest- AConsumerthat will call methods onGetImagePipelineRequest.Builderto create a request.- Returns:
- Result of the GetImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImagePolicy
default GetImagePolicyResponse getImagePolicy(GetImagePolicyRequest getImagePolicyRequest) throws ServiceException, ServiceUnavailableException, ResourceNotFoundException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image policy.
- Parameters:
getImagePolicyRequest-- Returns:
- Result of the GetImagePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImagePolicy
default GetImagePolicyResponse getImagePolicy(Consumer<GetImagePolicyRequest.Builder> getImagePolicyRequest) throws ServiceException, ServiceUnavailableException, ResourceNotFoundException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image policy.
This is a convenience which creates an instance of the
GetImagePolicyRequest.Builderavoiding the need to create one manually viaGetImagePolicyRequest.builder()- Parameters:
getImagePolicyRequest- AConsumerthat will call methods onGetImagePolicyRequest.Builderto create a request.- Returns:
- Result of the GetImagePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImageRecipe
default GetImageRecipeResponse getImageRecipe(GetImageRecipeRequest getImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image recipe.
- Parameters:
getImageRecipeRequest-- Returns:
- Result of the GetImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImageRecipe
default GetImageRecipeResponse getImageRecipe(Consumer<GetImageRecipeRequest.Builder> getImageRecipeRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image recipe.
This is a convenience which creates an instance of the
GetImageRecipeRequest.Builderavoiding the need to create one manually viaGetImageRecipeRequest.builder()- Parameters:
getImageRecipeRequest- AConsumerthat will call methods onGetImageRecipeRequest.Builderto create a request.- Returns:
- Result of the GetImageRecipe operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImageRecipePolicy
default GetImageRecipePolicyResponse getImageRecipePolicy(GetImageRecipePolicyRequest getImageRecipePolicyRequest) throws ServiceException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image recipe policy.
- Parameters:
getImageRecipePolicyRequest-- Returns:
- Result of the GetImageRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
getImageRecipePolicy
default GetImageRecipePolicyResponse getImageRecipePolicy(Consumer<GetImageRecipePolicyRequest.Builder> getImageRecipePolicyRequest) throws ServiceException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an image recipe policy.
This is a convenience which creates an instance of the
GetImageRecipePolicyRequest.Builderavoiding the need to create one manually viaGetImageRecipePolicyRequest.builder()- Parameters:
getImageRecipePolicyRequest- AConsumerthat will call methods onGetImageRecipePolicyRequest.Builderto create a request.- Returns:
- Result of the GetImageRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
getInfrastructureConfiguration
default GetInfrastructureConfigurationResponse getInfrastructureConfiguration(GetInfrastructureConfigurationRequest getInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an infrastructure configuration.
- Parameters:
getInfrastructureConfigurationRequest- GetInfrastructureConfiguration request object.- Returns:
- Result of the GetInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getInfrastructureConfiguration
default GetInfrastructureConfigurationResponse getInfrastructureConfiguration(Consumer<GetInfrastructureConfigurationRequest.Builder> getInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Gets an infrastructure configuration.
This is a convenience which creates an instance of the
GetInfrastructureConfigurationRequest.Builderavoiding the need to create one manually viaGetInfrastructureConfigurationRequest.builder()- Parameters:
getInfrastructureConfigurationRequest- AConsumerthat will call methods onGetInfrastructureConfigurationRequest.Builderto create a request. GetInfrastructureConfiguration request object.- Returns:
- Result of the GetInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecycleExecution
default GetLifecycleExecutionResponse getLifecycleExecution(GetLifecycleExecutionRequest getLifecycleExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
- Parameters:
getLifecycleExecutionRequest-- Returns:
- Result of the GetLifecycleExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecycleExecution
default GetLifecycleExecutionResponse getLifecycleExecution(Consumer<GetLifecycleExecutionRequest.Builder> getLifecycleExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
This is a convenience which creates an instance of the
GetLifecycleExecutionRequest.Builderavoiding the need to create one manually viaGetLifecycleExecutionRequest.builder()- Parameters:
getLifecycleExecutionRequest- AConsumerthat will call methods onGetLifecycleExecutionRequest.Builderto create a request.- Returns:
- Result of the GetLifecycleExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get details for the specified image lifecycle policy.
- Parameters:
getLifecyclePolicyRequest-- Returns:
- Result of the GetLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get details for the specified image lifecycle policy.
This is a convenience which creates an instance of the
GetLifecyclePolicyRequest.Builderavoiding the need to create one manually viaGetLifecyclePolicyRequest.builder()- Parameters:
getLifecyclePolicyRequest- AConsumerthat will call methods onGetLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the GetLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflow
default GetWorkflowResponse getWorkflow(GetWorkflowRequest getWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a workflow resource object.
- Parameters:
getWorkflowRequest-- Returns:
- Result of the GetWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflow
default GetWorkflowResponse getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a workflow resource object.
This is a convenience which creates an instance of the
GetWorkflowRequest.Builderavoiding the need to create one manually viaGetWorkflowRequest.builder()- Parameters:
getWorkflowRequest- AConsumerthat will call methods onGetWorkflowRequest.Builderto create a request.- Returns:
- Result of the GetWorkflow operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflowExecution
default GetWorkflowExecutionResponse getWorkflowExecution(GetWorkflowExecutionRequest getWorkflowExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the workflow.
- Parameters:
getWorkflowExecutionRequest-- Returns:
- Result of the GetWorkflowExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflowExecution
default GetWorkflowExecutionResponse getWorkflowExecution(Consumer<GetWorkflowExecutionRequest.Builder> getWorkflowExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the workflow.
This is a convenience which creates an instance of the
GetWorkflowExecutionRequest.Builderavoiding the need to create one manually viaGetWorkflowExecutionRequest.builder()- Parameters:
getWorkflowExecutionRequest- AConsumerthat will call methods onGetWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the GetWorkflowExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflowStepExecution
default GetWorkflowStepExecutionResponse getWorkflowStepExecution(GetWorkflowStepExecutionRequest getWorkflowStepExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the workflow step.
- Parameters:
getWorkflowStepExecutionRequest-- Returns:
- Result of the GetWorkflowStepExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkflowStepExecution
default GetWorkflowStepExecutionResponse getWorkflowStepExecution(Consumer<GetWorkflowStepExecutionRequest.Builder> getWorkflowStepExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the runtime information that was logged for a specific runtime instance of the workflow step.
This is a convenience which creates an instance of the
GetWorkflowStepExecutionRequest.Builderavoiding the need to create one manually viaGetWorkflowStepExecutionRequest.builder()- Parameters:
getWorkflowStepExecutionRequest- AConsumerthat will call methods onGetWorkflowStepExecutionRequest.Builderto create a request.- Returns:
- Result of the GetWorkflowStepExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.ForbiddenException- You are not authorized to perform the requested operation.CallRateLimitExceededException- You have exceeded the permitted request rate 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.AwsServiceException- See Also:
- AWS API Documentation
-
importComponent
default ImportComponentResponse importComponent(ImportComponentRequest importComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Imports a component and transforms its data into a component document.
- Parameters:
importComponentRequest-- Returns:
- Result of the ImportComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
importComponent
default ImportComponentResponse importComponent(Consumer<ImportComponentRequest.Builder> importComponentRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, InvalidVersionNumberException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Imports a component and transforms its data into a component document.
This is a convenience which creates an instance of the
ImportComponentRequest.Builderavoiding the need to create one manually viaImportComponentRequest.builder()- Parameters:
importComponentRequest- AConsumerthat will call methods onImportComponentRequest.Builderto create a request.- Returns:
- Result of the ImportComponent operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
importVmImage
default ImportVmImageResponse importVmImage(ImportVmImageRequest importVmImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, AwsServiceException, SdkClientException, ImagebuilderException
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image
You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.
- Parameters:
importVmImageRequest-- Returns:
- Result of the ImportVmImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.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.AwsServiceException- See Also:
- AWS API Documentation
-
importVmImage
default ImportVmImageResponse importVmImage(Consumer<ImportVmImageRequest.Builder> importVmImageRequest) throws ServiceException, ClientException, ServiceUnavailableException, AwsServiceException, SdkClientException, ImagebuilderException
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image
You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.
This is a convenience which creates an instance of the
ImportVmImageRequest.Builderavoiding the need to create one manually viaImportVmImageRequest.builder()- Parameters:
importVmImageRequest- AConsumerthat will call methods onImportVmImageRequest.Builderto create a request.- Returns:
- Result of the ImportVmImage operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentBuildVersions
default ListComponentBuildVersionsResponse listComponentBuildVersions(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of component build versions for the specified semantic version.
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: With semantic versioning, you have the flexibility to 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:
listComponentBuildVersionsRequest-- Returns:
- Result of the ListComponentBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentBuildVersions
default ListComponentBuildVersionsResponse listComponentBuildVersions(Consumer<ListComponentBuildVersionsRequest.Builder> listComponentBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of component build versions for the specified semantic version.
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: With semantic versioning, you have the flexibility to 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
ListComponentBuildVersionsRequest.Builderavoiding the need to create one manually viaListComponentBuildVersionsRequest.builder()- Parameters:
listComponentBuildVersionsRequest- AConsumerthat will call methods onListComponentBuildVersionsRequest.Builderto create a request.- Returns:
- Result of the ListComponentBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentBuildVersionsPaginator
default ListComponentBuildVersionsIterable listComponentBuildVersionsPaginator(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client.listComponentBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client .listComponentBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client.listComponentBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentBuildVersionsPaginator
default ListComponentBuildVersionsIterable listComponentBuildVersionsPaginator(Consumer<ListComponentBuildVersionsRequest.Builder> listComponentBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listComponentBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client.listComponentBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client .listComponentBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListComponentBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentBuildVersionsIterable responses = client.listComponentBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListComponentBuildVersionsRequest.builder()- Parameters:
listComponentBuildVersionsRequest- AConsumerthat will call methods onListComponentBuildVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponents
default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of components that can be filtered by name, or by using the listed
filtersto streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.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: With semantic versioning, you have the flexibility to 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:
- Result of the ListComponents operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponents
default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of components that can be filtered by name, or by using the listed
filtersto streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.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: With semantic versioning, you have the flexibility to 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.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- Returns:
- Result of the ListComponents operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listComponents(software.amazon.awssdk.services.imagebuilder.model.ListComponentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListComponentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listContainerRecipes
default ListContainerRecipesResponse listContainerRecipes(ListContainerRecipesRequest listContainerRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of container recipes.
- Parameters:
listContainerRecipesRequest-- Returns:
- Result of the ListContainerRecipes operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listContainerRecipes
default ListContainerRecipesResponse listContainerRecipes(Consumer<ListContainerRecipesRequest.Builder> listContainerRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of container recipes.
This is a convenience which creates an instance of the
ListContainerRecipesRequest.Builderavoiding the need to create one manually viaListContainerRecipesRequest.builder()- Parameters:
listContainerRecipesRequest- AConsumerthat will call methods onListContainerRecipesRequest.Builderto create a request.- Returns:
- Result of the ListContainerRecipes operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listContainerRecipesPaginator
default ListContainerRecipesIterable listContainerRecipesPaginator(ListContainerRecipesRequest listContainerRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client.listContainerRecipesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client .listContainerRecipesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client.listContainerRecipesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listContainerRecipesPaginator
default ListContainerRecipesIterable listContainerRecipesPaginator(Consumer<ListContainerRecipesRequest.Builder> listContainerRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listContainerRecipes(software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client.listContainerRecipesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client .listContainerRecipesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListContainerRecipesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListContainerRecipesIterable responses = client.listContainerRecipesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListContainerRecipesRequest.builder()- Parameters:
listContainerRecipesRequest- AConsumerthat will call methods onListContainerRecipesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDistributionConfigurations
default ListDistributionConfigurationsResponse listDistributionConfigurations(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of distribution configurations.
- Parameters:
listDistributionConfigurationsRequest-- Returns:
- Result of the ListDistributionConfigurations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDistributionConfigurations
default ListDistributionConfigurationsResponse listDistributionConfigurations(Consumer<ListDistributionConfigurationsRequest.Builder> listDistributionConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of distribution configurations.
This is a convenience which creates an instance of the
ListDistributionConfigurationsRequest.Builderavoiding the need to create one manually viaListDistributionConfigurationsRequest.builder()- Parameters:
listDistributionConfigurationsRequest- AConsumerthat will call methods onListDistributionConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListDistributionConfigurations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDistributionConfigurationsPaginator
default ListDistributionConfigurationsIterable listDistributionConfigurationsPaginator(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client.listDistributionConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client .listDistributionConfigurationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client.listDistributionConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDistributionConfigurationsPaginator
default ListDistributionConfigurationsIterable listDistributionConfigurationsPaginator(Consumer<ListDistributionConfigurationsRequest.Builder> listDistributionConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listDistributionConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client.listDistributionConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client .listDistributionConfigurationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListDistributionConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListDistributionConfigurationsIterable responses = client.listDistributionConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDistributionConfigurationsRequest.builder()- Parameters:
listDistributionConfigurationsRequest- AConsumerthat will call methods onListDistributionConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageBuildVersions
default ListImageBuildVersionsResponse listImageBuildVersions(ListImageBuildVersionsRequest listImageBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image build versions.
- Parameters:
listImageBuildVersionsRequest-- Returns:
- Result of the ListImageBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageBuildVersions
default ListImageBuildVersionsResponse listImageBuildVersions(Consumer<ListImageBuildVersionsRequest.Builder> listImageBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image build versions.
This is a convenience which creates an instance of the
ListImageBuildVersionsRequest.Builderavoiding the need to create one manually viaListImageBuildVersionsRequest.builder()- Parameters:
listImageBuildVersionsRequest- AConsumerthat will call methods onListImageBuildVersionsRequest.Builderto create a request.- Returns:
- Result of the ListImageBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageBuildVersionsPaginator
default ListImageBuildVersionsIterable listImageBuildVersionsPaginator(ListImageBuildVersionsRequest listImageBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client.listImageBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client .listImageBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client.listImageBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageBuildVersionsPaginator
default ListImageBuildVersionsIterable listImageBuildVersionsPaginator(Consumer<ListImageBuildVersionsRequest.Builder> listImageBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client.listImageBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client .listImageBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageBuildVersionsIterable responses = client.listImageBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImageBuildVersionsRequest.builder()- Parameters:
listImageBuildVersionsRequest- AConsumerthat will call methods onListImageBuildVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePackages
default ListImagePackagesResponse listImagePackages(ListImagePackagesRequest listImagePackagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
List 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:
- Result of the ListImagePackages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePackages
default ListImagePackagesResponse listImagePackages(Consumer<ListImagePackagesRequest.Builder> listImagePackagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
List 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.Builderavoiding the need to create one manually viaListImagePackagesRequest.builder()- Parameters:
listImagePackagesRequest- AConsumerthat will call methods onListImagePackagesRequest.Builderto create a request.- Returns:
- Result of the ListImagePackages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePackagesPaginator
default ListImagePackagesIterable listImagePackagesPaginator(ListImagePackagesRequest listImagePackagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client.listImagePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client .listImagePackagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client.listImagePackagesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePackagesPaginator
default ListImagePackagesIterable listImagePackagesPaginator(Consumer<ListImagePackagesRequest.Builder> listImagePackagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePackages(software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client.listImagePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client .listImagePackagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePackagesIterable responses = client.listImagePackagesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImagePackagesRequest.builder()- Parameters:
listImagePackagesRequest- AConsumerthat will call methods onListImagePackagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelineImages
default ListImagePipelineImagesResponse listImagePipelineImages(ListImagePipelineImagesRequest listImagePipelineImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of images created by the specified pipeline.
- Parameters:
listImagePipelineImagesRequest-- Returns:
- Result of the ListImagePipelineImages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelineImages
default ListImagePipelineImagesResponse listImagePipelineImages(Consumer<ListImagePipelineImagesRequest.Builder> listImagePipelineImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of images created by the specified pipeline.
This is a convenience which creates an instance of the
ListImagePipelineImagesRequest.Builderavoiding the need to create one manually viaListImagePipelineImagesRequest.builder()- Parameters:
listImagePipelineImagesRequest- AConsumerthat will call methods onListImagePipelineImagesRequest.Builderto create a request.- Returns:
- Result of the ListImagePipelineImages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelineImagesPaginator
default ListImagePipelineImagesIterable listImagePipelineImagesPaginator(ListImagePipelineImagesRequest listImagePipelineImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client.listImagePipelineImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client .listImagePipelineImagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client.listImagePipelineImagesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelineImagesPaginator
default ListImagePipelineImagesIterable listImagePipelineImagesPaginator(Consumer<ListImagePipelineImagesRequest.Builder> listImagePipelineImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client.listImagePipelineImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client .listImagePipelineImagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesIterable responses = client.listImagePipelineImagesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImagePipelineImagesRequest.builder()- Parameters:
listImagePipelineImagesRequest- AConsumerthat will call methods onListImagePipelineImagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelines
default ListImagePipelinesResponse listImagePipelines(ListImagePipelinesRequest listImagePipelinesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image pipelines.
- Parameters:
listImagePipelinesRequest-- Returns:
- Result of the ListImagePipelines operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelines
default ListImagePipelinesResponse listImagePipelines(Consumer<ListImagePipelinesRequest.Builder> listImagePipelinesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image pipelines.
This is a convenience which creates an instance of the
ListImagePipelinesRequest.Builderavoiding the need to create one manually viaListImagePipelinesRequest.builder()- Parameters:
listImagePipelinesRequest- AConsumerthat will call methods onListImagePipelinesRequest.Builderto create a request.- Returns:
- Result of the ListImagePipelines operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelinesPaginator
default ListImagePipelinesIterable listImagePipelinesPaginator(ListImagePipelinesRequest listImagePipelinesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client.listImagePipelinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client .listImagePipelinesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client.listImagePipelinesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagePipelinesPaginator
default ListImagePipelinesIterable listImagePipelinesPaginator(Consumer<ListImagePipelinesRequest.Builder> listImagePipelinesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImagePipelines(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client.listImagePipelinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client .listImagePipelinesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagePipelinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelinesIterable responses = client.listImagePipelinesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImagePipelinesRequest.builder()- Parameters:
listImagePipelinesRequest- AConsumerthat will call methods onListImagePipelinesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageRecipes
default ListImageRecipesResponse listImageRecipes(ListImageRecipesRequest listImageRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image recipes.
- Parameters:
listImageRecipesRequest-- Returns:
- Result of the ListImageRecipes operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageRecipes
default ListImageRecipesResponse listImageRecipes(Consumer<ListImageRecipesRequest.Builder> listImageRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image recipes.
This is a convenience which creates an instance of the
ListImageRecipesRequest.Builderavoiding the need to create one manually viaListImageRecipesRequest.builder()- Parameters:
listImageRecipesRequest- AConsumerthat will call methods onListImageRecipesRequest.Builderto create a request.- Returns:
- Result of the ListImageRecipes operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageRecipesPaginator
default ListImageRecipesIterable listImageRecipesPaginator(ListImageRecipesRequest listImageRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client.listImageRecipesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client .listImageRecipesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client.listImageRecipesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageRecipesPaginator
default ListImageRecipesIterable listImageRecipesPaginator(Consumer<ListImageRecipesRequest.Builder> listImageRecipesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageRecipes(software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client.listImageRecipesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client .listImageRecipesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageRecipesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageRecipesIterable responses = client.listImageRecipesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImageRecipesRequest.builder()- Parameters:
listImageRecipesRequest- AConsumerthat will call methods onListImageRecipesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindingAggregations
default ListImageScanFindingAggregationsResponse listImageScanFindingAggregations(ListImageScanFindingAggregationsRequest listImageScanFindingAggregationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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
imagePipelineArnfilter. 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:
-
accountId -
imageBuildVersionArn -
imagePipelineArn -
vulnerabilityId
- Parameters:
listImageScanFindingAggregationsRequest-- Returns:
- Result of the ListImageScanFindingAggregations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listImageScanFindingAggregations
default ListImageScanFindingAggregationsResponse listImageScanFindingAggregations(Consumer<ListImageScanFindingAggregationsRequest.Builder> listImageScanFindingAggregationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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
imagePipelineArnfilter. 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:
-
accountId -
imageBuildVersionArn -
imagePipelineArn -
vulnerabilityId
This is a convenience which creates an instance of the
ListImageScanFindingAggregationsRequest.Builderavoiding the need to create one manually viaListImageScanFindingAggregationsRequest.builder()- Parameters:
listImageScanFindingAggregationsRequest- AConsumerthat will call methods onListImageScanFindingAggregationsRequest.Builderto create a request.- Returns:
- Result of the ListImageScanFindingAggregations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
listImageScanFindingAggregationsPaginator
default ListImageScanFindingAggregationsIterable listImageScanFindingAggregationsPaginator(ListImageScanFindingAggregationsRequest listImageScanFindingAggregationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client.listImageScanFindingAggregationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client .listImageScanFindingAggregationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client.listImageScanFindingAggregationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindingAggregationsPaginator
default ListImageScanFindingAggregationsIterable listImageScanFindingAggregationsPaginator(Consumer<ListImageScanFindingAggregationsRequest.Builder> listImageScanFindingAggregationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageScanFindingAggregations(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client.listImageScanFindingAggregationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client .listImageScanFindingAggregationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingAggregationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingAggregationsIterable responses = client.listImageScanFindingAggregationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImageScanFindingAggregationsRequest.builder()- Parameters:
listImageScanFindingAggregationsRequest- AConsumerthat will call methods onListImageScanFindingAggregationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindings
default ListImageScanFindingsResponse listImageScanFindings(ListImageScanFindingsRequest listImageScanFindingsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image scan findings for your account.
- Parameters:
listImageScanFindingsRequest-- Returns:
- Result of the ListImageScanFindings operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindings
default ListImageScanFindingsResponse listImageScanFindings(Consumer<ListImageScanFindingsRequest.Builder> listImageScanFindingsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of image scan findings for your account.
This is a convenience which creates an instance of the
ListImageScanFindingsRequest.Builderavoiding the need to create one manually viaListImageScanFindingsRequest.builder()- Parameters:
listImageScanFindingsRequest- AConsumerthat will call methods onListImageScanFindingsRequest.Builderto create a request.- Returns:
- Result of the ListImageScanFindings operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindingsPaginator
default ListImageScanFindingsIterable listImageScanFindingsPaginator(ListImageScanFindingsRequest listImageScanFindingsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client.listImageScanFindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client .listImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client.listImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImageScanFindingsPaginator
default ListImageScanFindingsIterable listImageScanFindingsPaginator(Consumer<ListImageScanFindingsRequest.Builder> listImageScanFindingsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImageScanFindings(software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client.listImageScanFindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client .listImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImageScanFindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImageScanFindingsIterable responses = client.listImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImageScanFindingsRequest.builder()- Parameters:
listImageScanFindingsRequest- AConsumerthat will call methods onListImageScanFindingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.
- Parameters:
listImagesRequest-- Returns:
- Result of the ListImages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.
This is a convenience which creates an instance of the
ListImagesRequest.Builderavoiding the need to create one manually viaListImagesRequest.builder()- Parameters:
listImagesRequest- AConsumerthat will call methods onListImagesRequest.Builderto create a request.- Returns:
- Result of the ListImages operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listImages(software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListImagesRequest.builder()- Parameters:
listImagesRequest- AConsumerthat will call methods onListImagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listInfrastructureConfigurations
default ListInfrastructureConfigurationsResponse listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of infrastructure configurations.
- Parameters:
listInfrastructureConfigurationsRequest-- Returns:
- Result of the ListInfrastructureConfigurations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listInfrastructureConfigurations
default ListInfrastructureConfigurationsResponse listInfrastructureConfigurations(Consumer<ListInfrastructureConfigurationsRequest.Builder> listInfrastructureConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of infrastructure configurations.
This is a convenience which creates an instance of the
ListInfrastructureConfigurationsRequest.Builderavoiding the need to create one manually viaListInfrastructureConfigurationsRequest.builder()- Parameters:
listInfrastructureConfigurationsRequest- AConsumerthat will call methods onListInfrastructureConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListInfrastructureConfigurations operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listInfrastructureConfigurationsPaginator
default ListInfrastructureConfigurationsIterable listInfrastructureConfigurationsPaginator(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client.listInfrastructureConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client .listInfrastructureConfigurationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client.listInfrastructureConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listInfrastructureConfigurationsPaginator
default ListInfrastructureConfigurationsIterable listInfrastructureConfigurationsPaginator(Consumer<ListInfrastructureConfigurationsRequest.Builder> listInfrastructureConfigurationsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listInfrastructureConfigurations(software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client.listInfrastructureConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client .listInfrastructureConfigurationsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListInfrastructureConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListInfrastructureConfigurationsIterable responses = client.listInfrastructureConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListInfrastructureConfigurationsRequest.builder()- Parameters:
listInfrastructureConfigurationsRequest- AConsumerthat will call methods onListInfrastructureConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionResources
default ListLifecycleExecutionResourcesResponse listLifecycleExecutionResources(ListLifecycleExecutionResourcesRequest listLifecycleExecutionResourcesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
- Parameters:
listLifecycleExecutionResourcesRequest-- Returns:
- Result of the ListLifecycleExecutionResources operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionResources
default ListLifecycleExecutionResourcesResponse listLifecycleExecutionResources(Consumer<ListLifecycleExecutionResourcesRequest.Builder> listLifecycleExecutionResourcesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
This is a convenience which creates an instance of the
ListLifecycleExecutionResourcesRequest.Builderavoiding the need to create one manually viaListLifecycleExecutionResourcesRequest.builder()- Parameters:
listLifecycleExecutionResourcesRequest- AConsumerthat will call methods onListLifecycleExecutionResourcesRequest.Builderto create a request.- Returns:
- Result of the ListLifecycleExecutionResources operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionResourcesPaginator
default ListLifecycleExecutionResourcesIterable listLifecycleExecutionResourcesPaginator(ListLifecycleExecutionResourcesRequest listLifecycleExecutionResourcesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client.listLifecycleExecutionResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client .listLifecycleExecutionResourcesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client.listLifecycleExecutionResourcesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionResourcesPaginator
default ListLifecycleExecutionResourcesIterable listLifecycleExecutionResourcesPaginator(Consumer<ListLifecycleExecutionResourcesRequest.Builder> listLifecycleExecutionResourcesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecycleExecutionResources(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client.listLifecycleExecutionResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client .listLifecycleExecutionResourcesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionResourcesIterable responses = client.listLifecycleExecutionResourcesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListLifecycleExecutionResourcesRequest.builder()- Parameters:
listLifecycleExecutionResourcesRequest- AConsumerthat will call methods onListLifecycleExecutionResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutions
default ListLifecycleExecutionsResponse listLifecycleExecutions(ListLifecycleExecutionsRequest listLifecycleExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the lifecycle runtime history for the specified resource.
- Parameters:
listLifecycleExecutionsRequest-- Returns:
- Result of the ListLifecycleExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutions
default ListLifecycleExecutionsResponse listLifecycleExecutions(Consumer<ListLifecycleExecutionsRequest.Builder> listLifecycleExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get the lifecycle runtime history for the specified resource.
This is a convenience which creates an instance of the
ListLifecycleExecutionsRequest.Builderavoiding the need to create one manually viaListLifecycleExecutionsRequest.builder()- Parameters:
listLifecycleExecutionsRequest- AConsumerthat will call methods onListLifecycleExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListLifecycleExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionsPaginator
default ListLifecycleExecutionsIterable listLifecycleExecutionsPaginator(ListLifecycleExecutionsRequest listLifecycleExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client.listLifecycleExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client .listLifecycleExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client.listLifecycleExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecycleExecutionsPaginator
default ListLifecycleExecutionsIterable listLifecycleExecutionsPaginator(Consumer<ListLifecycleExecutionsRequest.Builder> listLifecycleExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecycleExecutions(software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client.listLifecycleExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client .listLifecycleExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecycleExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecycleExecutionsIterable responses = client.listLifecycleExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListLifecycleExecutionsRequest.builder()- Parameters:
listLifecycleExecutionsRequest- AConsumerthat will call methods onListLifecycleExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecyclePolicies
default ListLifecyclePoliciesResponse listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a list of lifecycle policies in your Amazon Web Services account.
- Parameters:
listLifecyclePoliciesRequest-- Returns:
- Result of the ListLifecyclePolicies operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecyclePolicies
default ListLifecyclePoliciesResponse listLifecyclePolicies(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a list of lifecycle policies in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListLifecyclePoliciesRequest.Builderavoiding the need to create one manually viaListLifecyclePoliciesRequest.builder()- Parameters:
listLifecyclePoliciesRequest- AConsumerthat will call methods onListLifecyclePoliciesRequest.Builderto create a request.- Returns:
- Result of the ListLifecyclePolicies operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecyclePoliciesPaginator
default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client .listLifecyclePoliciesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLifecyclePoliciesPaginator
default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listLifecyclePolicies(software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client .listLifecyclePoliciesPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListLifecyclePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListLifecyclePoliciesRequest.builder()- Parameters:
listLifecyclePoliciesRequest- AConsumerthat will call methods onListLifecyclePoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of tags for the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Returns the list of tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
listWaitingWorkflowSteps
default ListWaitingWorkflowStepsResponse listWaitingWorkflowSteps(ListWaitingWorkflowStepsRequest listWaitingWorkflowStepsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
- Parameters:
listWaitingWorkflowStepsRequest-- Returns:
- Result of the ListWaitingWorkflowSteps operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWaitingWorkflowSteps
default ListWaitingWorkflowStepsResponse listWaitingWorkflowSteps(Consumer<ListWaitingWorkflowStepsRequest.Builder> listWaitingWorkflowStepsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListWaitingWorkflowStepsRequest.Builderavoiding the need to create one manually viaListWaitingWorkflowStepsRequest.builder()- Parameters:
listWaitingWorkflowStepsRequest- AConsumerthat will call methods onListWaitingWorkflowStepsRequest.Builderto create a request.- Returns:
- Result of the ListWaitingWorkflowSteps operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWaitingWorkflowStepsPaginator
default ListWaitingWorkflowStepsIterable listWaitingWorkflowStepsPaginator(ListWaitingWorkflowStepsRequest listWaitingWorkflowStepsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client.listWaitingWorkflowStepsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client .listWaitingWorkflowStepsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client.listWaitingWorkflowStepsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWaitingWorkflowStepsPaginator
default ListWaitingWorkflowStepsIterable listWaitingWorkflowStepsPaginator(Consumer<ListWaitingWorkflowStepsRequest.Builder> listWaitingWorkflowStepsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWaitingWorkflowSteps(software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client.listWaitingWorkflowStepsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client .listWaitingWorkflowStepsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWaitingWorkflowStepsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWaitingWorkflowStepsIterable responses = client.listWaitingWorkflowStepsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWaitingWorkflowStepsRequest.builder()- Parameters:
listWaitingWorkflowStepsRequest- AConsumerthat will call methods onListWaitingWorkflowStepsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowBuildVersions
default ListWorkflowBuildVersionsResponse listWorkflowBuildVersions(ListWorkflowBuildVersionsRequest listWorkflowBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of build versions for a specific workflow resource.
- Parameters:
listWorkflowBuildVersionsRequest-- Returns:
- Result of the ListWorkflowBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowBuildVersions
default ListWorkflowBuildVersionsResponse listWorkflowBuildVersions(Consumer<ListWorkflowBuildVersionsRequest.Builder> listWorkflowBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of build versions for a specific workflow resource.
This is a convenience which creates an instance of the
ListWorkflowBuildVersionsRequest.Builderavoiding the need to create one manually viaListWorkflowBuildVersionsRequest.builder()- Parameters:
listWorkflowBuildVersionsRequest- AConsumerthat will call methods onListWorkflowBuildVersionsRequest.Builderto create a request.- Returns:
- Result of the ListWorkflowBuildVersions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowBuildVersionsPaginator
default ListWorkflowBuildVersionsIterable listWorkflowBuildVersionsPaginator(ListWorkflowBuildVersionsRequest listWorkflowBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client.listWorkflowBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client .listWorkflowBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client.listWorkflowBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowBuildVersionsPaginator
default ListWorkflowBuildVersionsIterable listWorkflowBuildVersionsPaginator(Consumer<ListWorkflowBuildVersionsRequest.Builder> listWorkflowBuildVersionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowBuildVersions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client.listWorkflowBuildVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client .listWorkflowBuildVersionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowBuildVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowBuildVersionsIterable responses = client.listWorkflowBuildVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWorkflowBuildVersionsRequest.builder()- Parameters:
listWorkflowBuildVersionsRequest- AConsumerthat will call methods onListWorkflowBuildVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowExecutions
default ListWorkflowExecutionsResponse listWorkflowExecutions(ListWorkflowExecutionsRequest listWorkflowExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns a list of workflow runtime instance metadata objects for a specific image build version.
- Parameters:
listWorkflowExecutionsRequest-- Returns:
- Result of the ListWorkflowExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowExecutions
default ListWorkflowExecutionsResponse listWorkflowExecutions(Consumer<ListWorkflowExecutionsRequest.Builder> listWorkflowExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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.Builderavoiding the need to create one manually viaListWorkflowExecutionsRequest.builder()- Parameters:
listWorkflowExecutionsRequest- AConsumerthat will call methods onListWorkflowExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListWorkflowExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowExecutionsPaginator
default ListWorkflowExecutionsIterable listWorkflowExecutionsPaginator(ListWorkflowExecutionsRequest listWorkflowExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client.listWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client .listWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client.listWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowExecutionsPaginator
default ListWorkflowExecutionsIterable listWorkflowExecutionsPaginator(Consumer<ListWorkflowExecutionsRequest.Builder> listWorkflowExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client.listWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client .listWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowExecutionsIterable responses = client.listWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWorkflowExecutionsRequest.builder()- Parameters:
listWorkflowExecutionsRequest- AConsumerthat will call methods onListWorkflowExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowStepExecutions
default ListWorkflowStepExecutionsResponse listWorkflowStepExecutions(ListWorkflowStepExecutionsRequest listWorkflowStepExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
- Parameters:
listWorkflowStepExecutionsRequest-- Returns:
- Result of the ListWorkflowStepExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowStepExecutions
default ListWorkflowStepExecutionsResponse listWorkflowStepExecutions(Consumer<ListWorkflowStepExecutionsRequest.Builder> listWorkflowStepExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
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.Builderavoiding the need to create one manually viaListWorkflowStepExecutionsRequest.builder()- Parameters:
listWorkflowStepExecutionsRequest- AConsumerthat will call methods onListWorkflowStepExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListWorkflowStepExecutions operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowStepExecutionsPaginator
default ListWorkflowStepExecutionsIterable listWorkflowStepExecutionsPaginator(ListWorkflowStepExecutionsRequest listWorkflowStepExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client.listWorkflowStepExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client .listWorkflowStepExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client.listWorkflowStepExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowStepExecutionsPaginator
default ListWorkflowStepExecutionsIterable listWorkflowStepExecutionsPaginator(Consumer<ListWorkflowStepExecutionsRequest.Builder> listWorkflowStepExecutionsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflowStepExecutions(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client.listWorkflowStepExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client .listWorkflowStepExecutionsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowStepExecutionsIterable responses = client.listWorkflowStepExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWorkflowStepExecutionsRequest.builder()- Parameters:
listWorkflowStepExecutionsRequest- AConsumerthat will call methods onListWorkflowStepExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflows
default ListWorkflowsResponse listWorkflows(ListWorkflowsRequest listWorkflowsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Lists workflow build versions based on filtering parameters.
- Parameters:
listWorkflowsRequest-- Returns:
- Result of the ListWorkflows operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflows
default ListWorkflowsResponse listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Lists workflow build versions based on filtering parameters.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builderavoiding the need to create one manually viaListWorkflowsRequest.builder()- Parameters:
listWorkflowsRequest- AConsumerthat will call methods onListWorkflowsRequest.Builderto create a request.- Returns:
- Result of the ListWorkflows operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowsPaginator
default ListWorkflowsIterable listWorkflowsPaginator(ListWorkflowsRequest listWorkflowsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client .listWorkflowsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkflowsPaginator
default ListWorkflowsIterable listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidPaginationTokenException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
This is a variant of
listWorkflows(software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client .listWorkflowsPaginator(request); for (software.amazon.awssdk.services.imagebuilder.model.ListWorkflowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.imagebuilder.paginators.ListWorkflowsIterable responses = client.listWorkflowsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWorkflowsRequest.builder()- Parameters:
listWorkflowsRequest- AConsumerthat will call methods onListWorkflowsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putComponentPolicy
default PutComponentPolicyResponse putComponentPolicy(PutComponentPolicyRequest putComponentPolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.- Parameters:
putComponentPolicyRequest-- Returns:
- Result of the PutComponentPolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putComponentPolicy
default PutComponentPolicyResponse putComponentPolicy(Consumer<PutComponentPolicyRequest.Builder> putComponentPolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
This is a convenience which creates an instance of the
PutComponentPolicyRequest.Builderavoiding the need to create one manually viaPutComponentPolicyRequest.builder()- Parameters:
putComponentPolicyRequest- AConsumerthat will call methods onPutComponentPolicyRequest.Builderto create a request.- Returns:
- Result of the PutComponentPolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putContainerRecipePolicy
default PutContainerRecipePolicyResponse putContainerRecipePolicy(PutContainerRecipePolicyRequest putContainerRecipePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API
PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.- Parameters:
putContainerRecipePolicyRequest-- Returns:
- Result of the PutContainerRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putContainerRecipePolicy
default PutContainerRecipePolicyResponse putContainerRecipePolicy(Consumer<PutContainerRecipePolicyRequest.Builder> putContainerRecipePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API
PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.
This is a convenience which creates an instance of the
PutContainerRecipePolicyRequest.Builderavoiding the need to create one manually viaPutContainerRecipePolicyRequest.builder()- Parameters:
putContainerRecipePolicyRequest- AConsumerthat will call methods onPutContainerRecipePolicyRequest.Builderto create a request.- Returns:
- Result of the PutContainerRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putImagePolicy
default PutImagePolicyResponse putImagePolicy(PutImagePolicyRequest putImagePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.- Parameters:
putImagePolicyRequest-- Returns:
- Result of the PutImagePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putImagePolicy
default PutImagePolicyResponse putImagePolicy(Consumer<PutImagePolicyRequest.Builder> putImagePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
This is a convenience which creates an instance of the
PutImagePolicyRequest.Builderavoiding the need to create one manually viaPutImagePolicyRequest.builder()- Parameters:
putImagePolicyRequest- AConsumerthat will call methods onPutImagePolicyRequest.Builderto create a request.- Returns:
- Result of the PutImagePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putImageRecipePolicy
default PutImageRecipePolicyResponse putImageRecipePolicy(PutImageRecipePolicyRequest putImageRecipePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.- Parameters:
putImageRecipePolicyRequest-- Returns:
- Result of the PutImageRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
putImageRecipePolicy
default PutImageRecipePolicyResponse putImageRecipePolicy(Consumer<PutImageRecipePolicyRequest.Builder> putImageRecipePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, InvalidParameterValueException, ResourceNotFoundException, ForbiddenException, CallRateLimitExceededException, AwsServiceException, SdkClientException, ImagebuilderException
Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API
PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.
This is a convenience which creates an instance of the
PutImageRecipePolicyRequest.Builderavoiding the need to create one manually viaPutImageRecipePolicyRequest.builder()- Parameters:
putImageRecipePolicyRequest- AConsumerthat will call methods onPutImageRecipePolicyRequest.Builderto create a request.- Returns:
- Result of the PutImageRecipePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
sendWorkflowStepAction
default SendWorkflowStepActionResponse sendWorkflowStepAction(SendWorkflowStepActionRequest sendWorkflowStepActionRequest) throws ServiceException, ClientException, ResourceNotFoundException, InvalidRequestException, InvalidParameterValueException, ServiceUnavailableException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Pauses or resumes image creation when the associated workflow runs a
WaitForActionstep.- Parameters:
sendWorkflowStepActionRequest-- Returns:
- Result of the SendWorkflowStepAction operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ResourceNotFoundException- At least one of the resources referenced by your request does not exist.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
sendWorkflowStepAction
default SendWorkflowStepActionResponse sendWorkflowStepAction(Consumer<SendWorkflowStepActionRequest.Builder> sendWorkflowStepActionRequest) throws ServiceException, ClientException, ResourceNotFoundException, InvalidRequestException, InvalidParameterValueException, ServiceUnavailableException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Pauses or resumes image creation when the associated workflow runs a
WaitForActionstep.
This is a convenience which creates an instance of the
SendWorkflowStepActionRequest.Builderavoiding the need to create one manually viaSendWorkflowStepActionRequest.builder()- Parameters:
sendWorkflowStepActionRequest- AConsumerthat will call methods onSendWorkflowStepActionRequest.Builderto create a request.- Returns:
- Result of the SendWorkflowStepAction operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ResourceNotFoundException- At least one of the resources referenced by your request does not exist.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
startImagePipelineExecution
default StartImagePipelineExecutionResponse startImagePipelineExecution(StartImagePipelineExecutionRequest startImagePipelineExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Manually triggers a pipeline to create an image.
- Parameters:
startImagePipelineExecutionRequest-- Returns:
- Result of the StartImagePipelineExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
startImagePipelineExecution
default StartImagePipelineExecutionResponse startImagePipelineExecution(Consumer<StartImagePipelineExecutionRequest.Builder> startImagePipelineExecutionRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Manually triggers a pipeline to create an image.
This is a convenience which creates an instance of the
StartImagePipelineExecutionRequest.Builderavoiding the need to create one manually viaStartImagePipelineExecutionRequest.builder()- Parameters:
startImagePipelineExecutionRequest- AConsumerthat will call methods onStartImagePipelineExecutionRequest.Builderto create a request.- Returns:
- Result of the StartImagePipelineExecution operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
startResourceStateUpdate
default StartResourceStateUpdateResponse startResourceStateUpdate(StartResourceStateUpdateRequest startResourceStateUpdateRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
- Parameters:
startResourceStateUpdateRequest-- Returns:
- Result of the StartResourceStateUpdate operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
startResourceStateUpdate
default StartResourceStateUpdateResponse startResourceStateUpdate(Consumer<StartResourceStateUpdateRequest.Builder> startResourceStateUpdateRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, ResourceNotFoundException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
This is a convenience which creates an instance of the
StartResourceStateUpdateRequest.Builderavoiding the need to create one manually viaStartResourceStateUpdateRequest.builder()- Parameters:
startResourceStateUpdateRequest- AConsumerthat will call methods onStartResourceStateUpdateRequest.Builderto create a request.- Returns:
- Result of the StartResourceStateUpdate operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Adds a tag to a resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Adds a tag to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Removes a tag from a resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, ImagebuilderException
Removes a tag from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDistributionConfiguration
default UpdateDistributionConfigurationResponse updateDistributionConfiguration(UpdateDistributionConfigurationRequest updateDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
- Parameters:
updateDistributionConfigurationRequest-- Returns:
- Result of the UpdateDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDistributionConfiguration
default UpdateDistributionConfigurationResponse updateDistributionConfiguration(Consumer<UpdateDistributionConfigurationRequest.Builder> updateDistributionConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
This is a convenience which creates an instance of the
UpdateDistributionConfigurationRequest.Builderavoiding the need to create one manually viaUpdateDistributionConfigurationRequest.builder()- Parameters:
updateDistributionConfigurationRequest- AConsumerthat will call methods onUpdateDistributionConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateDistributionConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateImagePipeline
default UpdateImagePipelineResponse updateImagePipeline(UpdateImagePipelineRequest updateImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a
containerRecipeArnor animageRecipeArn.UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.
- Parameters:
updateImagePipelineRequest-- Returns:
- Result of the UpdateImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateImagePipeline
default UpdateImagePipelineResponse updateImagePipeline(Consumer<UpdateImagePipelineRequest.Builder> updateImagePipelineRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a
containerRecipeArnor animageRecipeArn.UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.
This is a convenience which creates an instance of the
UpdateImagePipelineRequest.Builderavoiding the need to create one manually viaUpdateImagePipelineRequest.builder()- Parameters:
updateImagePipelineRequest- AConsumerthat will call methods onUpdateImagePipelineRequest.Builderto create a request.- Returns:
- Result of the UpdateImagePipeline operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateInfrastructureConfiguration
default UpdateInfrastructureConfigurationResponse updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest updateInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
- Parameters:
updateInfrastructureConfigurationRequest-- Returns:
- Result of the UpdateInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateInfrastructureConfiguration
default UpdateInfrastructureConfigurationResponse updateInfrastructureConfiguration(Consumer<UpdateInfrastructureConfigurationRequest.Builder> updateInfrastructureConfigurationRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, ImagebuilderException
Updates 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
UpdateInfrastructureConfigurationRequest.Builderavoiding the need to create one manually viaUpdateInfrastructureConfigurationRequest.builder()- Parameters:
updateInfrastructureConfigurationRequest- AConsumerthat will call methods onUpdateInfrastructureConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateInfrastructureConfiguration operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLifecyclePolicy
default UpdateLifecyclePolicyResponse updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Update the specified lifecycle policy.
- Parameters:
updateLifecyclePolicyRequest-- Returns:
- Result of the UpdateLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLifecyclePolicy
default UpdateLifecyclePolicyResponse updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest) throws ServiceException, ClientException, ServiceUnavailableException, InvalidRequestException, IdempotentParameterMismatchException, ForbiddenException, CallRateLimitExceededException, ResourceInUseException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ImagebuilderException
Update the specified lifecycle policy.
This is a convenience which creates an instance of the
UpdateLifecyclePolicyRequest.Builderavoiding the need to create one manually viaUpdateLifecyclePolicyRequest.builder()- Parameters:
updateLifecyclePolicyRequest- AConsumerthat will call methods onUpdateLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateLifecyclePolicy operation returned by the service.
- Throws:
ServiceException- This exception is thrown when the service encounters an unrecoverable exception.ClientException- These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.ServiceUnavailableException- The service is unable to process your request at this time.InvalidRequestException- You have requested an action that that the service doesn't support.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 specific operation.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 two or more mutually exclusive parameters. 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ImagebuilderClient create()
Create aImagebuilderClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ImagebuilderClientBuilder builder()
Create a builder that can be used to configure and create aImagebuilderClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ImagebuilderServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-