Interface AppRunnerAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.
App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.
For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.
Endpoints
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateCustomDomain
(Consumer<AssociateCustomDomainRequest.Builder> associateCustomDomainRequest) Associate your own domain name with the App Runner subdomain URL of your App Runner service.associateCustomDomain
(AssociateCustomDomainRequest associateCustomDomainRequest) Associate your own domain name with the App Runner subdomain URL of your App Runner service.static AppRunnerAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAppRunnerAsyncClient
.static AppRunnerAsyncClient
create()
Create aAppRunnerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAutoScalingConfiguration
(Consumer<CreateAutoScalingConfigurationRequest.Builder> createAutoScalingConfigurationRequest) Create an App Runner automatic scaling configuration resource.createAutoScalingConfiguration
(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest) Create an App Runner automatic scaling configuration resource.createConnection
(Consumer<CreateConnectionRequest.Builder> createConnectionRequest) Create an App Runner connection resource.createConnection
(CreateConnectionRequest createConnectionRequest) Create an App Runner connection resource.createObservabilityConfiguration
(Consumer<CreateObservabilityConfigurationRequest.Builder> createObservabilityConfigurationRequest) Create an App Runner observability configuration resource.createObservabilityConfiguration
(CreateObservabilityConfigurationRequest createObservabilityConfigurationRequest) Create an App Runner observability configuration resource.default CompletableFuture
<CreateServiceResponse> createService
(Consumer<CreateServiceRequest.Builder> createServiceRequest) Create an App Runner service.default CompletableFuture
<CreateServiceResponse> createService
(CreateServiceRequest createServiceRequest) Create an App Runner service.createVpcConnector
(Consumer<CreateVpcConnectorRequest.Builder> createVpcConnectorRequest) Create an App Runner VPC connector resource.createVpcConnector
(CreateVpcConnectorRequest createVpcConnectorRequest) Create an App Runner VPC connector resource.createVpcIngressConnection
(Consumer<CreateVpcIngressConnectionRequest.Builder> createVpcIngressConnectionRequest) Create an App Runner VPC Ingress Connection resource.createVpcIngressConnection
(CreateVpcIngressConnectionRequest createVpcIngressConnectionRequest) Create an App Runner VPC Ingress Connection resource.deleteAutoScalingConfiguration
(Consumer<DeleteAutoScalingConfigurationRequest.Builder> deleteAutoScalingConfigurationRequest) Delete an App Runner automatic scaling configuration resource.deleteAutoScalingConfiguration
(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest) Delete an App Runner automatic scaling configuration resource.deleteConnection
(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) Delete an App Runner connection.deleteConnection
(DeleteConnectionRequest deleteConnectionRequest) Delete an App Runner connection.deleteObservabilityConfiguration
(Consumer<DeleteObservabilityConfigurationRequest.Builder> deleteObservabilityConfigurationRequest) Delete an App Runner observability configuration resource.deleteObservabilityConfiguration
(DeleteObservabilityConfigurationRequest deleteObservabilityConfigurationRequest) Delete an App Runner observability configuration resource.default CompletableFuture
<DeleteServiceResponse> deleteService
(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Delete an App Runner service.default CompletableFuture
<DeleteServiceResponse> deleteService
(DeleteServiceRequest deleteServiceRequest) Delete an App Runner service.deleteVpcConnector
(Consumer<DeleteVpcConnectorRequest.Builder> deleteVpcConnectorRequest) Delete an App Runner VPC connector resource.deleteVpcConnector
(DeleteVpcConnectorRequest deleteVpcConnectorRequest) Delete an App Runner VPC connector resource.deleteVpcIngressConnection
(Consumer<DeleteVpcIngressConnectionRequest.Builder> deleteVpcIngressConnectionRequest) Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service.deleteVpcIngressConnection
(DeleteVpcIngressConnectionRequest deleteVpcIngressConnectionRequest) Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service.describeAutoScalingConfiguration
(Consumer<DescribeAutoScalingConfigurationRequest.Builder> describeAutoScalingConfigurationRequest) Return a full description of an App Runner automatic scaling configuration resource.describeAutoScalingConfiguration
(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest) Return a full description of an App Runner automatic scaling configuration resource.describeCustomDomains
(Consumer<DescribeCustomDomainsRequest.Builder> describeCustomDomainsRequest) Return a description of custom domain names that are associated with an App Runner service.describeCustomDomains
(DescribeCustomDomainsRequest describeCustomDomainsRequest) Return a description of custom domain names that are associated with an App Runner service.default DescribeCustomDomainsPublisher
describeCustomDomainsPaginator
(Consumer<DescribeCustomDomainsRequest.Builder> describeCustomDomainsRequest) This is a variant ofdescribeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation.default DescribeCustomDomainsPublisher
describeCustomDomainsPaginator
(DescribeCustomDomainsRequest describeCustomDomainsRequest) This is a variant ofdescribeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation.describeObservabilityConfiguration
(Consumer<DescribeObservabilityConfigurationRequest.Builder> describeObservabilityConfigurationRequest) Return a full description of an App Runner observability configuration resource.describeObservabilityConfiguration
(DescribeObservabilityConfigurationRequest describeObservabilityConfigurationRequest) Return a full description of an App Runner observability configuration resource.default CompletableFuture
<DescribeServiceResponse> describeService
(Consumer<DescribeServiceRequest.Builder> describeServiceRequest) Return a full description of an App Runner service.default CompletableFuture
<DescribeServiceResponse> describeService
(DescribeServiceRequest describeServiceRequest) Return a full description of an App Runner service.describeVpcConnector
(Consumer<DescribeVpcConnectorRequest.Builder> describeVpcConnectorRequest) Return a description of an App Runner VPC connector resource.describeVpcConnector
(DescribeVpcConnectorRequest describeVpcConnectorRequest) Return a description of an App Runner VPC connector resource.describeVpcIngressConnection
(Consumer<DescribeVpcIngressConnectionRequest.Builder> describeVpcIngressConnectionRequest) Return a full description of an App Runner VPC Ingress Connection resource.describeVpcIngressConnection
(DescribeVpcIngressConnectionRequest describeVpcIngressConnectionRequest) Return a full description of an App Runner VPC Ingress Connection resource.disassociateCustomDomain
(Consumer<DisassociateCustomDomainRequest.Builder> disassociateCustomDomainRequest) Disassociate a custom domain name from an App Runner service.disassociateCustomDomain
(DisassociateCustomDomainRequest disassociateCustomDomainRequest) Disassociate a custom domain name from an App Runner service.listAutoScalingConfigurations
(Consumer<ListAutoScalingConfigurationsRequest.Builder> listAutoScalingConfigurationsRequest) Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account.listAutoScalingConfigurations
(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest) Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account.listAutoScalingConfigurationsPaginator
(Consumer<ListAutoScalingConfigurationsRequest.Builder> listAutoScalingConfigurationsRequest) This is a variant oflistAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation.listAutoScalingConfigurationsPaginator
(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest) This is a variant oflistAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation.default CompletableFuture
<ListConnectionsResponse> listConnections
(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) Returns a list of App Runner connections that are associated with your Amazon Web Services account.default CompletableFuture
<ListConnectionsResponse> listConnections
(ListConnectionsRequest listConnectionsRequest) Returns a list of App Runner connections that are associated with your Amazon Web Services account.default ListConnectionsPublisher
listConnectionsPaginator
(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) This is a variant oflistConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation.default ListConnectionsPublisher
listConnectionsPaginator
(ListConnectionsRequest listConnectionsRequest) This is a variant oflistConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation.listObservabilityConfigurations
(Consumer<ListObservabilityConfigurationsRequest.Builder> listObservabilityConfigurationsRequest) Returns a list of active App Runner observability configurations in your Amazon Web Services account.listObservabilityConfigurations
(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest) Returns a list of active App Runner observability configurations in your Amazon Web Services account.listObservabilityConfigurationsPaginator
(Consumer<ListObservabilityConfigurationsRequest.Builder> listObservabilityConfigurationsRequest) This is a variant oflistObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation.listObservabilityConfigurationsPaginator
(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest) This is a variant oflistObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation.default CompletableFuture
<ListOperationsResponse> listOperations
(Consumer<ListOperationsRequest.Builder> listOperationsRequest) Return a list of operations that occurred on an App Runner service.default CompletableFuture
<ListOperationsResponse> listOperations
(ListOperationsRequest listOperationsRequest) Return a list of operations that occurred on an App Runner service.default ListOperationsPublisher
listOperationsPaginator
(Consumer<ListOperationsRequest.Builder> listOperationsRequest) This is a variant oflistOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation.default ListOperationsPublisher
listOperationsPaginator
(ListOperationsRequest listOperationsRequest) This is a variant oflistOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation.default CompletableFuture
<ListServicesResponse> listServices
(Consumer<ListServicesRequest.Builder> listServicesRequest) Returns a list of running App Runner services in your Amazon Web Services account.default CompletableFuture
<ListServicesResponse> listServices
(ListServicesRequest listServicesRequest) Returns a list of running App Runner services in your Amazon Web Services account.listServicesForAutoScalingConfiguration
(Consumer<ListServicesForAutoScalingConfigurationRequest.Builder> listServicesForAutoScalingConfigurationRequest) Returns a list of the associated App Runner services using an auto scaling configuration.listServicesForAutoScalingConfiguration
(ListServicesForAutoScalingConfigurationRequest listServicesForAutoScalingConfigurationRequest) Returns a list of the associated App Runner services using an auto scaling configuration.listServicesForAutoScalingConfigurationPaginator
(Consumer<ListServicesForAutoScalingConfigurationRequest.Builder> listServicesForAutoScalingConfigurationRequest) listServicesForAutoScalingConfigurationPaginator
(ListServicesForAutoScalingConfigurationRequest listServicesForAutoScalingConfigurationRequest) default ListServicesPublisher
listServicesPaginator
(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation.default ListServicesPublisher
listServicesPaginator
(ListServicesRequest listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags that are associated with for an App Runner resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List tags that are associated with for an App Runner resource.listVpcConnectors
(Consumer<ListVpcConnectorsRequest.Builder> listVpcConnectorsRequest) Returns a list of App Runner VPC connectors in your Amazon Web Services account.listVpcConnectors
(ListVpcConnectorsRequest listVpcConnectorsRequest) Returns a list of App Runner VPC connectors in your Amazon Web Services account.default ListVpcConnectorsPublisher
listVpcConnectorsPaginator
(Consumer<ListVpcConnectorsRequest.Builder> listVpcConnectorsRequest) This is a variant oflistVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation.default ListVpcConnectorsPublisher
listVpcConnectorsPaginator
(ListVpcConnectorsRequest listVpcConnectorsRequest) This is a variant oflistVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation.listVpcIngressConnections
(Consumer<ListVpcIngressConnectionsRequest.Builder> listVpcIngressConnectionsRequest) Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.listVpcIngressConnections
(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest) Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.listVpcIngressConnectionsPaginator
(Consumer<ListVpcIngressConnectionsRequest.Builder> listVpcIngressConnectionsRequest) This is a variant oflistVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation.listVpcIngressConnectionsPaginator
(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest) This is a variant oflistVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation.default CompletableFuture
<PauseServiceResponse> pauseService
(Consumer<PauseServiceRequest.Builder> pauseServiceRequest) Pause an active App Runner service.default CompletableFuture
<PauseServiceResponse> pauseService
(PauseServiceRequest pauseServiceRequest) Pause an active App Runner service.default CompletableFuture
<ResumeServiceResponse> resumeService
(Consumer<ResumeServiceRequest.Builder> resumeServiceRequest) Resume an active App Runner service.default CompletableFuture
<ResumeServiceResponse> resumeService
(ResumeServiceRequest resumeServiceRequest) Resume an active App Runner service.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartDeploymentResponse> startDeployment
(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.default CompletableFuture
<StartDeploymentResponse> startDeployment
(StartDeploymentRequest startDeploymentRequest) Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to, or update the tag values of, an App Runner resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Add tags to, or update the tag values of, an App Runner resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from an App Runner resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from an App Runner resource.updateDefaultAutoScalingConfiguration
(Consumer<UpdateDefaultAutoScalingConfigurationRequest.Builder> updateDefaultAutoScalingConfigurationRequest) Update an auto scaling configuration to be the default.updateDefaultAutoScalingConfiguration
(UpdateDefaultAutoScalingConfigurationRequest updateDefaultAutoScalingConfigurationRequest) Update an auto scaling configuration to be the default.default CompletableFuture
<UpdateServiceResponse> updateService
(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) Update an App Runner service.default CompletableFuture
<UpdateServiceResponse> updateService
(UpdateServiceRequest updateServiceRequest) Update an App Runner service.updateVpcIngressConnection
(Consumer<UpdateVpcIngressConnectionRequest.Builder> updateVpcIngressConnectionRequest) Update an existing App Runner VPC Ingress Connection resource.updateVpcIngressConnection
(UpdateVpcIngressConnectionRequest updateVpcIngressConnectionRequest) Update an existing App Runner VPC Ingress Connection resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateCustomDomain
default CompletableFuture<AssociateCustomDomainResponse> associateCustomDomain(AssociateCustomDomainRequest associateCustomDomainRequest) Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call
AssociateCustomDomain
and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).- Parameters:
associateCustomDomainRequest
-- Returns:
- A Java Future containing the result of the AssociateCustomDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateCustomDomain
default CompletableFuture<AssociateCustomDomainResponse> associateCustomDomain(Consumer<AssociateCustomDomainRequest.Builder> associateCustomDomainRequest) Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call
AssociateCustomDomain
and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).
This is a convenience which creates an instance of the
AssociateCustomDomainRequest.Builder
avoiding the need to create one manually viaAssociateCustomDomainRequest.builder()
- Parameters:
associateCustomDomainRequest
- AConsumer
that will call methods onAssociateCustomDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateCustomDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAutoScalingConfiguration
default CompletableFuture<CreateAutoScalingConfigurationResponse> createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest) Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same
AutoScalingConfigurationName
. The call returns incrementalAutoScalingConfigurationRevision
values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.Configure a higher
MinSize
to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.Configure a lower
MaxSize
to control your cost. The tradeoff is lower responsiveness during peak demand.- Parameters:
createAutoScalingConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAutoScalingConfiguration
default CompletableFuture<CreateAutoScalingConfigurationResponse> createAutoScalingConfiguration(Consumer<CreateAutoScalingConfigurationRequest.Builder> createAutoScalingConfigurationRequest) Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same
AutoScalingConfigurationName
. The call returns incrementalAutoScalingConfigurationRevision
values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.Configure a higher
MinSize
to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.Configure a lower
MaxSize
to control your cost. The tradeoff is lower responsiveness during peak demand.
This is a convenience which creates an instance of the
CreateAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaCreateAutoScalingConfigurationRequest.builder()
- Parameters:
createAutoScalingConfigurationRequest
- AConsumer
that will call methods onCreateAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConnection
default CompletableFuture<CreateConnectionResponse> createConnection(CreateConnectionRequest createConnectionRequest) Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.
A connection resource is needed to access GitHub and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.
- Parameters:
createConnectionRequest
-- Returns:
- A Java Future containing the result of the CreateConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConnection
default CompletableFuture<CreateConnectionResponse> createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest) Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.
A connection resource is needed to access GitHub and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.
This is a convenience which creates an instance of the
CreateConnectionRequest.Builder
avoiding the need to create one manually viaCreateConnectionRequest.builder()
- Parameters:
createConnectionRequest
- AConsumer
that will call methods onCreateConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createObservabilityConfiguration
default CompletableFuture<CreateObservabilityConfigurationResponse> createObservabilityConfiguration(CreateObservabilityConfigurationRequest createObservabilityConfigurationRequest) Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same
ObservabilityConfigurationName
. The call returns incrementalObservabilityConfigurationRevision
values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision.The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter,
TraceConfiguration
). If you don't specify a feature parameter, App Runner doesn't enable the feature.- Parameters:
createObservabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createObservabilityConfiguration
default CompletableFuture<CreateObservabilityConfigurationResponse> createObservabilityConfiguration(Consumer<CreateObservabilityConfigurationRequest.Builder> createObservabilityConfigurationRequest) Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same
ObservabilityConfigurationName
. The call returns incrementalObservabilityConfigurationRevision
values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision.The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter,
TraceConfiguration
). If you don't specify a feature parameter, App Runner doesn't enable the feature.
This is a convenience which creates an instance of the
CreateObservabilityConfigurationRequest.Builder
avoiding the need to create one manually viaCreateObservabilityConfigurationRequest.builder()
- Parameters:
createObservabilityConfigurationRequest
- AConsumer
that will call methods onCreateObservabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createService
default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest) Create an App Runner service. After the service is created, the action also automatically starts a deployment.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.- Parameters:
createServiceRequest
-- Returns:
- A Java Future containing the result of the CreateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createService
default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) Create an App Runner service. After the service is created, the action also automatically starts a deployment.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.
This is a convenience which creates an instance of the
CreateServiceRequest.Builder
avoiding the need to create one manually viaCreateServiceRequest.builder()
- Parameters:
createServiceRequest
- AConsumer
that will call methods onCreateServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcConnector
default CompletableFuture<CreateVpcConnectorResponse> createVpcConnector(CreateVpcConnectorRequest createVpcConnectorRequest) Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).
- Parameters:
createVpcConnectorRequest
-- Returns:
- A Java Future containing the result of the CreateVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcConnector
default CompletableFuture<CreateVpcConnectorResponse> createVpcConnector(Consumer<CreateVpcConnectorRequest.Builder> createVpcConnectorRequest) Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).
This is a convenience which creates an instance of the
CreateVpcConnectorRequest.Builder
avoiding the need to create one manually viaCreateVpcConnectorRequest.builder()
- Parameters:
createVpcConnectorRequest
- AConsumer
that will call methods onCreateVpcConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcIngressConnection
default CompletableFuture<CreateVpcIngressConnectionResponse> createVpcIngressConnection(CreateVpcIngressConnectionRequest createVpcIngressConnectionRequest) Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.
- Parameters:
createVpcIngressConnectionRequest
-- Returns:
- A Java Future containing the result of the CreateVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcIngressConnection
default CompletableFuture<CreateVpcIngressConnectionResponse> createVpcIngressConnection(Consumer<CreateVpcIngressConnectionRequest.Builder> createVpcIngressConnectionRequest) Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.
This is a convenience which creates an instance of the
CreateVpcIngressConnectionRequest.Builder
avoiding the need to create one manually viaCreateVpcIngressConnectionRequest.builder()
- Parameters:
createVpcIngressConnectionRequest
- AConsumer
that will call methods onCreateVpcIngressConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- ServiceQuotaExceededException App Runner can't create this resource. You've reached your account
quota for this resource type.
For App Runner per-resource quotas, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAutoScalingConfiguration
default CompletableFuture<DeleteAutoScalingConfigurationResponse> deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest) Delete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or a configuration that's used by one or more App Runner services.
- Parameters:
deleteAutoScalingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAutoScalingConfiguration
default CompletableFuture<DeleteAutoScalingConfigurationResponse> deleteAutoScalingConfiguration(Consumer<DeleteAutoScalingConfigurationRequest.Builder> deleteAutoScalingConfigurationRequest) Delete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or a configuration that's used by one or more App Runner services.
This is a convenience which creates an instance of the
DeleteAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAutoScalingConfigurationRequest.builder()
- Parameters:
deleteAutoScalingConfigurationRequest
- AConsumer
that will call methods onDeleteAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnection
default CompletableFuture<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest deleteConnectionRequest) Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the
DeleteConnection
action fails.- Parameters:
deleteConnectionRequest
-- Returns:
- A Java Future containing the result of the DeleteConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnection
default CompletableFuture<DeleteConnectionResponse> deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the
DeleteConnection
action fails.
This is a convenience which creates an instance of the
DeleteConnectionRequest.Builder
avoiding the need to create one manually viaDeleteConnectionRequest.builder()
- Parameters:
deleteConnectionRequest
- AConsumer
that will call methods onDeleteConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteObservabilityConfiguration
default CompletableFuture<DeleteObservabilityConfigurationResponse> deleteObservabilityConfiguration(DeleteObservabilityConfigurationRequest deleteObservabilityConfigurationRequest) Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.
- Parameters:
deleteObservabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteObservabilityConfiguration
default CompletableFuture<DeleteObservabilityConfigurationResponse> deleteObservabilityConfiguration(Consumer<DeleteObservabilityConfigurationRequest.Builder> deleteObservabilityConfigurationRequest) Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.
This is a convenience which creates an instance of the
DeleteObservabilityConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteObservabilityConfigurationRequest.builder()
- Parameters:
deleteObservabilityConfigurationRequest
- AConsumer
that will call methods onDeleteObservabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteService
default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest) Delete an App Runner service.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.
- Parameters:
deleteServiceRequest
-- Returns:
- A Java Future containing the result of the DeleteService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteService
default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Delete an App Runner service.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.
This is a convenience which creates an instance of the
DeleteServiceRequest.Builder
avoiding the need to create one manually viaDeleteServiceRequest.builder()
- Parameters:
deleteServiceRequest
- AConsumer
that will call methods onDeleteServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcConnector
default CompletableFuture<DeleteVpcConnectorResponse> deleteVpcConnector(DeleteVpcConnectorRequest deleteVpcConnectorRequest) Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.
- Parameters:
deleteVpcConnectorRequest
-- Returns:
- A Java Future containing the result of the DeleteVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcConnector
default CompletableFuture<DeleteVpcConnectorResponse> deleteVpcConnector(Consumer<DeleteVpcConnectorRequest.Builder> deleteVpcConnectorRequest) Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.
This is a convenience which creates an instance of the
DeleteVpcConnectorRequest.Builder
avoiding the need to create one manually viaDeleteVpcConnectorRequest.builder()
- Parameters:
deleteVpcConnectorRequest
- AConsumer
that will call methods onDeleteVpcConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcIngressConnection
default CompletableFuture<DeleteVpcIngressConnectionResponse> deleteVpcIngressConnection(DeleteVpcIngressConnectionRequest deleteVpcIngressConnectionRequest) Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:
-
AVAILABLE
-
FAILED_CREATION
-
FAILED_UPDATE
-
FAILED_DELETION
- Parameters:
deleteVpcIngressConnectionRequest
-- Returns:
- A Java Future containing the result of the DeleteVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteVpcIngressConnection
default CompletableFuture<DeleteVpcIngressConnectionResponse> deleteVpcIngressConnection(Consumer<DeleteVpcIngressConnectionRequest.Builder> deleteVpcIngressConnectionRequest) Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:
-
AVAILABLE
-
FAILED_CREATION
-
FAILED_UPDATE
-
FAILED_DELETION
This is a convenience which creates an instance of the
DeleteVpcIngressConnectionRequest.Builder
avoiding the need to create one manually viaDeleteVpcIngressConnectionRequest.builder()
- Parameters:
deleteVpcIngressConnectionRequest
- AConsumer
that will call methods onDeleteVpcIngressConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeAutoScalingConfiguration
default CompletableFuture<DescribeAutoScalingConfigurationResponse> describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest) Return a full description of an App Runner automatic scaling configuration resource.
- Parameters:
describeAutoScalingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAutoScalingConfiguration
default CompletableFuture<DescribeAutoScalingConfigurationResponse> describeAutoScalingConfiguration(Consumer<DescribeAutoScalingConfigurationRequest.Builder> describeAutoScalingConfigurationRequest) Return a full description of an App Runner automatic scaling configuration resource.
This is a convenience which creates an instance of the
DescribeAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeAutoScalingConfigurationRequest.builder()
- Parameters:
describeAutoScalingConfigurationRequest
- AConsumer
that will call methods onDescribeAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAutoScalingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomains
default CompletableFuture<DescribeCustomDomainsResponse> describeCustomDomains(DescribeCustomDomainsRequest describeCustomDomainsRequest) Return a description of custom domain names that are associated with an App Runner service.
- Parameters:
describeCustomDomainsRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomains
default CompletableFuture<DescribeCustomDomainsResponse> describeCustomDomains(Consumer<DescribeCustomDomainsRequest.Builder> describeCustomDomainsRequest) Return a description of custom domain names that are associated with an App Runner service.
This is a convenience which creates an instance of the
DescribeCustomDomainsRequest.Builder
avoiding the need to create one manually viaDescribeCustomDomainsRequest.builder()
- Parameters:
describeCustomDomainsRequest
- AConsumer
that will call methods onDescribeCustomDomainsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomainsPaginator
default DescribeCustomDomainsPublisher describeCustomDomainsPaginator(DescribeCustomDomainsRequest describeCustomDomainsRequest) This is a variant of
describeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.DescribeCustomDomainsPublisher publisher = client.describeCustomDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.DescribeCustomDomainsPublisher publisher = client.describeCustomDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsResponse response) { //... }; });
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
describeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation.- Parameters:
describeCustomDomainsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomDomainsPaginator
default DescribeCustomDomainsPublisher describeCustomDomainsPaginator(Consumer<DescribeCustomDomainsRequest.Builder> describeCustomDomainsRequest) This is a variant of
describeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.DescribeCustomDomainsPublisher publisher = client.describeCustomDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.DescribeCustomDomainsPublisher publisher = client.describeCustomDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsResponse response) { //... }; });
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
describeCustomDomains(software.amazon.awssdk.services.apprunner.model.DescribeCustomDomainsRequest)
operation.
This is a convenience which creates an instance of the
DescribeCustomDomainsRequest.Builder
avoiding the need to create one manually viaDescribeCustomDomainsRequest.builder()
- Parameters:
describeCustomDomainsRequest
- AConsumer
that will call methods onDescribeCustomDomainsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeObservabilityConfiguration
default CompletableFuture<DescribeObservabilityConfigurationResponse> describeObservabilityConfiguration(DescribeObservabilityConfigurationRequest describeObservabilityConfigurationRequest) Return a full description of an App Runner observability configuration resource.
- Parameters:
describeObservabilityConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeObservabilityConfiguration
default CompletableFuture<DescribeObservabilityConfigurationResponse> describeObservabilityConfiguration(Consumer<DescribeObservabilityConfigurationRequest.Builder> describeObservabilityConfigurationRequest) Return a full description of an App Runner observability configuration resource.
This is a convenience which creates an instance of the
DescribeObservabilityConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeObservabilityConfigurationRequest.builder()
- Parameters:
describeObservabilityConfigurationRequest
- AConsumer
that will call methods onDescribeObservabilityConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeObservabilityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeService
default CompletableFuture<DescribeServiceResponse> describeService(DescribeServiceRequest describeServiceRequest) Return a full description of an App Runner service.
- Parameters:
describeServiceRequest
-- Returns:
- A Java Future containing the result of the DescribeService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeService
default CompletableFuture<DescribeServiceResponse> describeService(Consumer<DescribeServiceRequest.Builder> describeServiceRequest) Return a full description of an App Runner service.
This is a convenience which creates an instance of the
DescribeServiceRequest.Builder
avoiding the need to create one manually viaDescribeServiceRequest.builder()
- Parameters:
describeServiceRequest
- AConsumer
that will call methods onDescribeServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcConnector
default CompletableFuture<DescribeVpcConnectorResponse> describeVpcConnector(DescribeVpcConnectorRequest describeVpcConnectorRequest) Return a description of an App Runner VPC connector resource.
- Parameters:
describeVpcConnectorRequest
-- Returns:
- A Java Future containing the result of the DescribeVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcConnector
default CompletableFuture<DescribeVpcConnectorResponse> describeVpcConnector(Consumer<DescribeVpcConnectorRequest.Builder> describeVpcConnectorRequest) Return a description of an App Runner VPC connector resource.
This is a convenience which creates an instance of the
DescribeVpcConnectorRequest.Builder
avoiding the need to create one manually viaDescribeVpcConnectorRequest.builder()
- Parameters:
describeVpcConnectorRequest
- AConsumer
that will call methods onDescribeVpcConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVpcConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcIngressConnection
default CompletableFuture<DescribeVpcIngressConnectionResponse> describeVpcIngressConnection(DescribeVpcIngressConnectionRequest describeVpcIngressConnectionRequest) Return a full description of an App Runner VPC Ingress Connection resource.
- Parameters:
describeVpcIngressConnectionRequest
-- Returns:
- A Java Future containing the result of the DescribeVpcIngressConnection operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcIngressConnection
default CompletableFuture<DescribeVpcIngressConnectionResponse> describeVpcIngressConnection(Consumer<DescribeVpcIngressConnectionRequest.Builder> describeVpcIngressConnectionRequest) Return a full description of an App Runner VPC Ingress Connection resource.
This is a convenience which creates an instance of the
DescribeVpcIngressConnectionRequest.Builder
avoiding the need to create one manually viaDescribeVpcIngressConnectionRequest.builder()
- Parameters:
describeVpcIngressConnectionRequest
- AConsumer
that will call methods onDescribeVpcIngressConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVpcIngressConnection operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateCustomDomain
default CompletableFuture<DisassociateCustomDomainResponse> disassociateCustomDomain(DisassociateCustomDomainRequest disassociateCustomDomainRequest) Disassociate a custom domain name from an App Runner service.
Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.
- Parameters:
disassociateCustomDomainRequest
-- Returns:
- A Java Future containing the result of the DisassociateCustomDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateCustomDomain
default CompletableFuture<DisassociateCustomDomainResponse> disassociateCustomDomain(Consumer<DisassociateCustomDomainRequest.Builder> disassociateCustomDomainRequest) Disassociate a custom domain name from an App Runner service.
Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.
This is a convenience which creates an instance of the
DisassociateCustomDomainRequest.Builder
avoiding the need to create one manually viaDisassociateCustomDomainRequest.builder()
- Parameters:
disassociateCustomDomainRequest
- AConsumer
that will call methods onDisassociateCustomDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateCustomDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutoScalingConfigurations
default CompletableFuture<ListAutoScalingConfigurationsResponse> listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest) Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by
ListAutoScalingConfigurations
.- Parameters:
listAutoScalingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListAutoScalingConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutoScalingConfigurations
default CompletableFuture<ListAutoScalingConfigurationsResponse> listAutoScalingConfigurations(Consumer<ListAutoScalingConfigurationsRequest.Builder> listAutoScalingConfigurationsRequest) Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by
ListAutoScalingConfigurations
.
This is a convenience which creates an instance of the
ListAutoScalingConfigurationsRequest.Builder
avoiding the need to create one manually viaListAutoScalingConfigurationsRequest.builder()
- Parameters:
listAutoScalingConfigurationsRequest
- AConsumer
that will call methods onListAutoScalingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAutoScalingConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutoScalingConfigurationsPaginator
default ListAutoScalingConfigurationsPublisher listAutoScalingConfigurationsPaginator(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest) This is a variant of
listAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListAutoScalingConfigurationsPublisher publisher = client.listAutoScalingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListAutoScalingConfigurationsPublisher publisher = client.listAutoScalingConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsResponse response) { //... }; });
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
listAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation.- Parameters:
listAutoScalingConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAutoScalingConfigurationsPaginator
default ListAutoScalingConfigurationsPublisher listAutoScalingConfigurationsPaginator(Consumer<ListAutoScalingConfigurationsRequest.Builder> listAutoScalingConfigurationsRequest) This is a variant of
listAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListAutoScalingConfigurationsPublisher publisher = client.listAutoScalingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListAutoScalingConfigurationsPublisher publisher = client.listAutoScalingConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsResponse response) { //... }; });
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
listAutoScalingConfigurations(software.amazon.awssdk.services.apprunner.model.ListAutoScalingConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListAutoScalingConfigurationsRequest.Builder
avoiding the need to create one manually viaListAutoScalingConfigurationsRequest.builder()
- Parameters:
listAutoScalingConfigurationsRequest
- AConsumer
that will call methods onListAutoScalingConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnections
default CompletableFuture<ListConnectionsResponse> listConnections(ListConnectionsRequest listConnectionsRequest) Returns a list of App Runner connections that are associated with your Amazon Web Services account.
- Parameters:
listConnectionsRequest
-- Returns:
- A Java Future containing the result of the ListConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnections
default CompletableFuture<ListConnectionsResponse> listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) Returns a list of App Runner connections that are associated with your Amazon Web Services account.
This is a convenience which creates an instance of the
ListConnectionsRequest.Builder
avoiding the need to create one manually viaListConnectionsRequest.builder()
- Parameters:
listConnectionsRequest
- AConsumer
that will call methods onListConnectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectionsPaginator
default ListConnectionsPublisher listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest) This is a variant of
listConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListConnectionsResponse response) { //... }; });
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
listConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation.- Parameters:
listConnectionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConnectionsPaginator
default ListConnectionsPublisher listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) This is a variant of
listConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListConnectionsResponse response) { //... }; });
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
listConnections(software.amazon.awssdk.services.apprunner.model.ListConnectionsRequest)
operation.
This is a convenience which creates an instance of the
ListConnectionsRequest.Builder
avoiding the need to create one manually viaListConnectionsRequest.builder()
- Parameters:
listConnectionsRequest
- AConsumer
that will call methods onListConnectionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listObservabilityConfigurations
default CompletableFuture<ListObservabilityConfigurationsResponse> listObservabilityConfigurations(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest) Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by
ListObservabilityConfigurations
.- Parameters:
listObservabilityConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListObservabilityConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listObservabilityConfigurations
default CompletableFuture<ListObservabilityConfigurationsResponse> listObservabilityConfigurations(Consumer<ListObservabilityConfigurationsRequest.Builder> listObservabilityConfigurationsRequest) Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by
ListObservabilityConfigurations
.
This is a convenience which creates an instance of the
ListObservabilityConfigurationsRequest.Builder
avoiding the need to create one manually viaListObservabilityConfigurationsRequest.builder()
- Parameters:
listObservabilityConfigurationsRequest
- AConsumer
that will call methods onListObservabilityConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListObservabilityConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listObservabilityConfigurationsPaginator
default ListObservabilityConfigurationsPublisher listObservabilityConfigurationsPaginator(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest) This is a variant of
listObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListObservabilityConfigurationsPublisher publisher = client.listObservabilityConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListObservabilityConfigurationsPublisher publisher = client.listObservabilityConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsResponse response) { //... }; });
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
listObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation.- Parameters:
listObservabilityConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listObservabilityConfigurationsPaginator
default ListObservabilityConfigurationsPublisher listObservabilityConfigurationsPaginator(Consumer<ListObservabilityConfigurationsRequest.Builder> listObservabilityConfigurationsRequest) This is a variant of
listObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListObservabilityConfigurationsPublisher publisher = client.listObservabilityConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListObservabilityConfigurationsPublisher publisher = client.listObservabilityConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsResponse response) { //... }; });
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
listObservabilityConfigurations(software.amazon.awssdk.services.apprunner.model.ListObservabilityConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListObservabilityConfigurationsRequest.Builder
avoiding the need to create one manually viaListObservabilityConfigurationsRequest.builder()
- Parameters:
listObservabilityConfigurationsRequest
- AConsumer
that will call methods onListObservabilityConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperations
default CompletableFuture<ListOperationsResponse> listOperations(ListOperationsRequest listOperationsRequest) Return a list of operations that occurred on an App Runner service.
The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
- Parameters:
listOperationsRequest
-- Returns:
- A Java Future containing the result of the ListOperations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperations
default CompletableFuture<ListOperationsResponse> listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest) Return a list of operations that occurred on an App Runner service.
The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
This is a convenience which creates an instance of the
ListOperationsRequest.Builder
avoiding the need to create one manually viaListOperationsRequest.builder()
- Parameters:
listOperationsRequest
- AConsumer
that will call methods onListOperationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOperations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationsPaginator
default ListOperationsPublisher listOperationsPaginator(ListOperationsRequest listOperationsRequest) This is a variant of
listOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListOperationsResponse response) { //... }; });
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
listOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation.- Parameters:
listOperationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationsPaginator
default ListOperationsPublisher listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) This is a variant of
listOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListOperationsResponse response) { //... }; });
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
listOperations(software.amazon.awssdk.services.apprunner.model.ListOperationsRequest)
operation.
This is a convenience which creates an instance of the
ListOperationsRequest.Builder
avoiding the need to create one manually viaListOperationsRequest.builder()
- Parameters:
listOperationsRequest
- AConsumer
that will call methods onListOperationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServices
default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest) Returns a list of running App Runner services in your Amazon Web Services account.
- Parameters:
listServicesRequest
-- Returns:
- A Java Future containing the result of the ListServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServices
default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) Returns a list of running App Runner services in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesForAutoScalingConfiguration
default CompletableFuture<ListServicesForAutoScalingConfigurationResponse> listServicesForAutoScalingConfiguration(ListServicesForAutoScalingConfigurationRequest listServicesForAutoScalingConfigurationRequest) Returns a list of the associated App Runner services using an auto scaling configuration.
- Parameters:
listServicesForAutoScalingConfigurationRequest
-- Returns:
- A Java Future containing the result of the ListServicesForAutoScalingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesForAutoScalingConfiguration
default CompletableFuture<ListServicesForAutoScalingConfigurationResponse> listServicesForAutoScalingConfiguration(Consumer<ListServicesForAutoScalingConfigurationRequest.Builder> listServicesForAutoScalingConfigurationRequest) Returns a list of the associated App Runner services using an auto scaling configuration.
This is a convenience which creates an instance of the
ListServicesForAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaListServicesForAutoScalingConfigurationRequest.builder()
- Parameters:
listServicesForAutoScalingConfigurationRequest
- AConsumer
that will call methods onListServicesForAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListServicesForAutoScalingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesForAutoScalingConfigurationPaginator
default ListServicesForAutoScalingConfigurationPublisher listServicesForAutoScalingConfigurationPaginator(ListServicesForAutoScalingConfigurationRequest listServicesForAutoScalingConfigurationRequest) This is a variant of
listServicesForAutoScalingConfiguration(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListServicesForAutoScalingConfigurationPublisher publisher = client.listServicesForAutoScalingConfigurationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListServicesForAutoScalingConfigurationPublisher publisher = client.listServicesForAutoScalingConfigurationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationResponse response) { //... }; });
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
listServicesForAutoScalingConfiguration(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationRequest)
operation.- Parameters:
listServicesForAutoScalingConfigurationRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesForAutoScalingConfigurationPaginator
default ListServicesForAutoScalingConfigurationPublisher listServicesForAutoScalingConfigurationPaginator(Consumer<ListServicesForAutoScalingConfigurationRequest.Builder> listServicesForAutoScalingConfigurationRequest) This is a variant of
listServicesForAutoScalingConfiguration(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListServicesForAutoScalingConfigurationPublisher publisher = client.listServicesForAutoScalingConfigurationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListServicesForAutoScalingConfigurationPublisher publisher = client.listServicesForAutoScalingConfigurationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationResponse response) { //... }; });
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
listServicesForAutoScalingConfiguration(software.amazon.awssdk.services.apprunner.model.ListServicesForAutoScalingConfigurationRequest)
operation.
This is a convenience which creates an instance of the
ListServicesForAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaListServicesForAutoScalingConfigurationRequest.builder()
- Parameters:
listServicesForAutoScalingConfigurationRequest
- AConsumer
that will call methods onListServicesForAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesPaginator
This is a variant of
listServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListServicesResponse response) { //... }; });
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
listServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation.- Parameters:
listServicesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServicesPaginator
default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant of
listServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListServicesResponse response) { //... }; });
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
listServices(software.amazon.awssdk.services.apprunner.model.ListServicesRequest)
operation.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcConnectors
default CompletableFuture<ListVpcConnectorsResponse> listVpcConnectors(ListVpcConnectorsRequest listVpcConnectorsRequest) Returns a list of App Runner VPC connectors in your Amazon Web Services account.
- Parameters:
listVpcConnectorsRequest
-- Returns:
- A Java Future containing the result of the ListVpcConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcConnectors
default CompletableFuture<ListVpcConnectorsResponse> listVpcConnectors(Consumer<ListVpcConnectorsRequest.Builder> listVpcConnectorsRequest) Returns a list of App Runner VPC connectors in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListVpcConnectorsRequest.Builder
avoiding the need to create one manually viaListVpcConnectorsRequest.builder()
- Parameters:
listVpcConnectorsRequest
- AConsumer
that will call methods onListVpcConnectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVpcConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcConnectorsPaginator
default ListVpcConnectorsPublisher listVpcConnectorsPaginator(ListVpcConnectorsRequest listVpcConnectorsRequest) This is a variant of
listVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListVpcConnectorsPublisher publisher = client.listVpcConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListVpcConnectorsPublisher publisher = client.listVpcConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsResponse response) { //... }; });
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
listVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation.- Parameters:
listVpcConnectorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcConnectorsPaginator
default ListVpcConnectorsPublisher listVpcConnectorsPaginator(Consumer<ListVpcConnectorsRequest.Builder> listVpcConnectorsRequest) This is a variant of
listVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListVpcConnectorsPublisher publisher = client.listVpcConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListVpcConnectorsPublisher publisher = client.listVpcConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsResponse response) { //... }; });
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
listVpcConnectors(software.amazon.awssdk.services.apprunner.model.ListVpcConnectorsRequest)
operation.
This is a convenience which creates an instance of the
ListVpcConnectorsRequest.Builder
avoiding the need to create one manually viaListVpcConnectorsRequest.builder()
- Parameters:
listVpcConnectorsRequest
- AConsumer
that will call methods onListVpcConnectorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcIngressConnections
default CompletableFuture<ListVpcIngressConnectionsResponse> listVpcIngressConnections(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest) Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
- Parameters:
listVpcIngressConnectionsRequest
-- Returns:
- A Java Future containing the result of the ListVpcIngressConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcIngressConnections
default CompletableFuture<ListVpcIngressConnectionsResponse> listVpcIngressConnections(Consumer<ListVpcIngressConnectionsRequest.Builder> listVpcIngressConnectionsRequest) Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListVpcIngressConnectionsRequest.Builder
avoiding the need to create one manually viaListVpcIngressConnectionsRequest.builder()
- Parameters:
listVpcIngressConnectionsRequest
- AConsumer
that will call methods onListVpcIngressConnectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVpcIngressConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcIngressConnectionsPaginator
default ListVpcIngressConnectionsPublisher listVpcIngressConnectionsPaginator(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest) This is a variant of
listVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListVpcIngressConnectionsPublisher publisher = client.listVpcIngressConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListVpcIngressConnectionsPublisher publisher = client.listVpcIngressConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsResponse response) { //... }; });
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
listVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation.- Parameters:
listVpcIngressConnectionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVpcIngressConnectionsPaginator
default ListVpcIngressConnectionsPublisher listVpcIngressConnectionsPaginator(Consumer<ListVpcIngressConnectionsRequest.Builder> listVpcIngressConnectionsRequest) This is a variant of
listVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.apprunner.paginators.ListVpcIngressConnectionsPublisher publisher = client.listVpcIngressConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.apprunner.paginators.ListVpcIngressConnectionsPublisher publisher = client.listVpcIngressConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsResponse response) { //... }; });
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
listVpcIngressConnections(software.amazon.awssdk.services.apprunner.model.ListVpcIngressConnectionsRequest)
operation.
This is a convenience which creates an instance of the
ListVpcIngressConnectionsRequest.Builder
avoiding the need to create one manually viaListVpcIngressConnectionsRequest.builder()
- Parameters:
listVpcIngressConnectionsRequest
- AConsumer
that will call methods onListVpcIngressConnectionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pauseService
default CompletableFuture<PauseServiceResponse> pauseService(PauseServiceRequest pauseServiceRequest) Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.- Parameters:
pauseServiceRequest
-- Returns:
- A Java Future containing the result of the PauseService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pauseService
default CompletableFuture<PauseServiceResponse> pauseService(Consumer<PauseServiceRequest.Builder> pauseServiceRequest) Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.
This is a convenience which creates an instance of the
PauseServiceRequest.Builder
avoiding the need to create one manually viaPauseServiceRequest.builder()
- Parameters:
pauseServiceRequest
- AConsumer
that will call methods onPauseServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PauseService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeService
default CompletableFuture<ResumeServiceResponse> resumeService(ResumeServiceRequest resumeServiceRequest) Resume an active App Runner service. App Runner provisions compute capacity for the service.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.- Parameters:
resumeServiceRequest
-- Returns:
- A Java Future containing the result of the ResumeService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeService
default CompletableFuture<ResumeServiceResponse> resumeService(Consumer<ResumeServiceRequest.Builder> resumeServiceRequest) Resume an active App Runner service. App Runner provisions compute capacity for the service.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.
This is a convenience which creates an instance of the
ResumeServiceRequest.Builder
avoiding the need to create one manually viaResumeServiceRequest.builder()
- Parameters:
resumeServiceRequest
- AConsumer
that will call methods onResumeServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResumeService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
default CompletableFuture<StartDeploymentResponse> startDeployment(StartDeploymentRequest startDeploymentRequest) Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.
For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.- Parameters:
startDeploymentRequest
-- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
default CompletableFuture<StartDeploymentResponse> startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.
For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builder
avoiding the need to create one manually viaStartDeploymentRequest.builder()
- Parameters:
startDeploymentRequest
- AConsumer
that will call methods onStartDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove tags from an App Runner resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from an App Runner resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InternalServiceErrorException An unexpected service exception occurred.
- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InvalidStateException You can't perform this action when the resource is in its current state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDefaultAutoScalingConfiguration
default CompletableFuture<UpdateDefaultAutoScalingConfigurationResponse> updateDefaultAutoScalingConfiguration(UpdateDefaultAutoScalingConfigurationRequest updateDefaultAutoScalingConfigurationRequest) Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.
- Parameters:
updateDefaultAutoScalingConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateDefaultAutoScalingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDefaultAutoScalingConfiguration
default CompletableFuture<UpdateDefaultAutoScalingConfigurationResponse> updateDefaultAutoScalingConfiguration(Consumer<UpdateDefaultAutoScalingConfigurationRequest.Builder> updateDefaultAutoScalingConfigurationRequest) Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.
This is a convenience which creates an instance of the
UpdateDefaultAutoScalingConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateDefaultAutoScalingConfigurationRequest.builder()
- Parameters:
updateDefaultAutoScalingConfigurationRequest
- AConsumer
that will call methods onUpdateDefaultAutoScalingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDefaultAutoScalingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- InternalServiceErrorException An unexpected service exception occurred.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateService
default CompletableFuture<UpdateServiceResponse> updateService(UpdateServiceRequest updateServiceRequest) Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.
To update the tags applied to your service, use the separate actions TagResource and UntagResource.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.- Parameters:
updateServiceRequest
-- Returns:
- A Java Future containing the result of the UpdateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateService
default CompletableFuture<UpdateServiceResponse> updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.
To update the tags applied to your service, use the separate actions TagResource and UntagResource.
This is an asynchronous operation. On a successful call, you can use the returned
OperationId
and the ListOperations call to track the operation's progress.
This is a convenience which creates an instance of the
UpdateServiceRequest.Builder
avoiding the need to create one manually viaUpdateServiceRequest.builder()
- Parameters:
updateServiceRequest
- AConsumer
that will call methods onUpdateServiceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateVpcIngressConnection
default CompletableFuture<UpdateVpcIngressConnectionResponse> updateVpcIngressConnection(UpdateVpcIngressConnectionRequest updateVpcIngressConnectionRequest) Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:
-
AVAILABLE
-
FAILED_CREATION
-
FAILED_UPDATE
- Parameters:
updateVpcIngressConnectionRequest
-- Returns:
- A Java Future containing the result of the UpdateVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateVpcIngressConnection
default CompletableFuture<UpdateVpcIngressConnectionResponse> updateVpcIngressConnection(Consumer<UpdateVpcIngressConnectionRequest.Builder> updateVpcIngressConnectionRequest) Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:
-
AVAILABLE
-
FAILED_CREATION
-
FAILED_UPDATE
This is a convenience which creates an instance of the
UpdateVpcIngressConnectionRequest.Builder
avoiding the need to create one manually viaUpdateVpcIngressConnectionRequest.builder()
- Parameters:
updateVpcIngressConnectionRequest
- AConsumer
that will call methods onUpdateVpcIngressConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateVpcIngressConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
- ResourceNotFoundException A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
- InvalidStateException You can't perform this action when the resource is in its current state.
- InternalServiceErrorException An unexpected service exception occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppRunnerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAppRunnerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAppRunnerAsyncClient
.
-