com.amazonaws.services.apprunner

Class AWSAppRunnerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.apprunner.AWSAppRunnerClient

All Implemented Interfaces:

AWSAppRunner

Direct Known Subclasses:

AWSAppRunnerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAppRunnerClient
extends AmazonWebServiceClient
implements AWSAppRunner

Client for accessing AWS App Runner. All service calls made using this client are blocking, and will not return until the service call completes.

App Runner

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.apprunner.AWSAppRunner

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateCustomDomainResult	associateCustomDomain(AssociateCustomDomainRequest request) Associate your own domain name with the App Runner subdomain URL of your App Runner service.
static AWSAppRunnerClientBuilder	builder()
CreateAutoScalingConfigurationResult	createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request) Create an App Runner automatic scaling configuration resource.
CreateConnectionResult	createConnection(CreateConnectionRequest request) Create an App Runner connection resource.
CreateServiceResult	createService(CreateServiceRequest request) Create an App Runner service.
DeleteAutoScalingConfigurationResult	deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request) Delete an App Runner automatic scaling configuration resource.
DeleteConnectionResult	deleteConnection(DeleteConnectionRequest request) Delete an App Runner connection.
DeleteServiceResult	deleteService(DeleteServiceRequest request) Delete an App Runner service.
DescribeAutoScalingConfigurationResult	describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request) Return a full description of an App Runner automatic scaling configuration resource.
DescribeCustomDomainsResult	describeCustomDomains(DescribeCustomDomainsRequest request) Return a description of custom domain names that are associated with an App Runner service.
DescribeServiceResult	describeService(DescribeServiceRequest request) Return a full description of an App Runner service.
DisassociateCustomDomainResult	disassociateCustomDomain(DisassociateCustomDomainRequest request) Disassociate a custom domain name from an App Runner service.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAutoScalingConfigurationsResult	listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request) Returns a list of App Runner automatic scaling configurations in your Amazon Web Services account.
ListConnectionsResult	listConnections(ListConnectionsRequest request) Returns a list of App Runner connections that are associated with your Amazon Web Services account.
ListOperationsResult	listOperations(ListOperationsRequest request) Return a list of operations that occurred on an App Runner service.
ListServicesResult	listServices(ListServicesRequest request) Returns a list of running App Runner services in your Amazon Web Services account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List tags that are associated with for an App Runner resource.
PauseServiceResult	pauseService(PauseServiceRequest request) Pause an active App Runner service.
ResumeServiceResult	resumeService(ResumeServiceRequest request) Resume an active App Runner service.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDeploymentResult	startDeployment(StartDeploymentRequest request) 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.
TagResourceResult	tagResource(TagResourceRequest request) Add tags to, or update the tag values of, an App Runner resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove tags from an App Runner resource.
UpdateServiceResult	updateService(UpdateServiceRequest request) Update an App Runner service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSAppRunnerClientBuilder builder()

associateCustomDomain

public AssociateCustomDomainResult associateCustomDomain(AssociateCustomDomainRequest request)

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).

Specified by:

associateCustomDomain in interface AWSAppRunner

Parameters:

associateCustomDomainRequest -

Returns:

Result of the AssociateCustomDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createAutoScalingConfiguration

public CreateAutoScalingConfigurationResult createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or 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.

Specified by:

createAutoScalingConfiguration in interface AWSAppRunner

Parameters:

createAutoScalingConfigurationRequest -

Returns:

Result of the CreateAutoScalingConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createConnection

public CreateConnectionResult createConnection(CreateConnectionRequest request)

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 repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.

Specified by:

createConnection in interface AWSAppRunner

Parameters:

createConnectionRequest -

Returns:

Result of the CreateConnection operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createService

public CreateServiceResult createService(CreateServiceRequest request)

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.

Specified by:

createService in interface AWSAppRunner

Parameters:

createServiceRequest -

Returns:

Result of the CreateService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAutoScalingConfiguration

public DeleteAutoScalingConfigurationResult deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)

Delete an App Runner automatic scaling 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.

Specified by:

deleteAutoScalingConfiguration in interface AWSAppRunner

Parameters:

deleteAutoScalingConfigurationRequest -

Returns:

Result of the DeleteAutoScalingConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConnection

public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)

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.

Specified by:

deleteConnection in interface AWSAppRunner

Parameters:

deleteConnectionRequest -

Returns:

Result of the DeleteConnection operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest request)

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.

Specified by:

deleteService in interface AWSAppRunner

Parameters:

deleteServiceRequest -

Returns:

Result of the DeleteService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeAutoScalingConfiguration

public DescribeAutoScalingConfigurationResult describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest request)

Return a full description of an App Runner automatic scaling configuration resource.

Specified by:

describeAutoScalingConfiguration in interface AWSAppRunner

Parameters:

describeAutoScalingConfigurationRequest -

Returns:

Result of the DescribeAutoScalingConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeCustomDomains

public DescribeCustomDomainsResult describeCustomDomains(DescribeCustomDomainsRequest request)

Return a description of custom domain names that are associated with an App Runner service.

Specified by:

describeCustomDomains in interface AWSAppRunner

Parameters:

describeCustomDomainsRequest -

Returns:

Result of the DescribeCustomDomains operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeService

public DescribeServiceResult describeService(DescribeServiceRequest request)

Return a full description of an App Runner service.

Specified by:

describeService in interface AWSAppRunner

Parameters:

describeServiceRequest -

Returns:

Result of the DescribeService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateCustomDomain

public DisassociateCustomDomainResult disassociateCustomDomain(DisassociateCustomDomainRequest request)

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.

Specified by:

disassociateCustomDomain in interface AWSAppRunner

Parameters:

disassociateCustomDomainRequest -

Returns:

Result of the DisassociateCustomDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAutoScalingConfigurations

public ListAutoScalingConfigurationsResult listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)

Returns a list of 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 configurations in your account. You can optionally query only the latest revision of each requested name.

Specified by:

listAutoScalingConfigurations in interface AWSAppRunner

Parameters:

listAutoScalingConfigurationsRequest -

Returns:

Result of the ListAutoScalingConfigurations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listConnections

public ListConnectionsResult listConnections(ListConnectionsRequest request)

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

Specified by:

listConnections in interface AWSAppRunner

Parameters:

listConnectionsRequest -

Returns:

Result of the ListConnections operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listOperations

public ListOperationsResult listOperations(ListOperationsRequest request)

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.

Specified by:

listOperations in interface AWSAppRunner

Parameters:

listOperationsRequest -

Returns:

Result of the ListOperations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listServices

public ListServicesResult listServices(ListServicesRequest request)

Returns a list of running App Runner services in your Amazon Web Services account.

Specified by:

listServices in interface AWSAppRunner

Parameters:

listServicesRequest -

Returns:

Result of the ListServices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

Specified by:

listTagsForResource in interface AWSAppRunner

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

pauseService

public PauseServiceResult pauseService(PauseServiceRequest request)

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.

Specified by:

pauseService in interface AWSAppRunner

Parameters:

pauseServiceRequest -

Returns:

Result of the PauseService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

resumeService

public ResumeServiceResult resumeService(ResumeServiceRequest request)

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.

Specified by:

resumeService in interface AWSAppRunner

Parameters:

resumeServiceRequest -

Returns:

Result of the ResumeService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startDeployment

public StartDeploymentResult startDeployment(StartDeploymentRequest request)

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.

Specified by:

startDeployment in interface AWSAppRunner

Parameters:

startDeploymentRequest -

Returns:

Result of the StartDeployment operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

Specified by:

tagResource in interface AWSAppRunner

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Remove tags from an App Runner resource.

Specified by:

untagResource in interface AWSAppRunner

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateService

public UpdateServiceResult updateService(UpdateServiceRequest request)

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.

Specified by:

updateService in interface AWSAppRunner

Parameters:

updateServiceRequest -

Returns:

Result of the UpdateService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSAppRunner

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSAppRunner

Overrides:

shutdown in class AmazonWebServiceClient