com.amazonaws.services.apprunner

Interface AWSAppRunner

All Known Subinterfaces:

AWSAppRunnerAsync

All Known Implementing Classes:

AbstractAWSAppRunner, AbstractAWSAppRunnerAsync, AWSAppRunnerAsyncClient, AWSAppRunnerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppRunner

Interface for accessing AWS App Runner.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAppRunner instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateCustomDomainResult	associateCustomDomain(AssociateCustomDomainRequest associateCustomDomainRequest) Associate your own domain name with the App Runner subdomain URL of your App Runner service.
CreateAutoScalingConfigurationResult	createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest) Create an App Runner automatic scaling configuration resource.
CreateConnectionResult	createConnection(CreateConnectionRequest createConnectionRequest) Create an App Runner connection resource.
CreateObservabilityConfigurationResult	createObservabilityConfiguration(CreateObservabilityConfigurationRequest createObservabilityConfigurationRequest) Create an App Runner observability configuration resource.
CreateServiceResult	createService(CreateServiceRequest createServiceRequest) Create an App Runner service.
CreateVpcConnectorResult	createVpcConnector(CreateVpcConnectorRequest createVpcConnectorRequest) Create an App Runner VPC connector resource.
CreateVpcIngressConnectionResult	createVpcIngressConnection(CreateVpcIngressConnectionRequest createVpcIngressConnectionRequest) Create an App Runner VPC Ingress Connection resource.
DeleteAutoScalingConfigurationResult	deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest) Delete an App Runner automatic scaling configuration resource.
DeleteConnectionResult	deleteConnection(DeleteConnectionRequest deleteConnectionRequest) Delete an App Runner connection.
DeleteObservabilityConfigurationResult	deleteObservabilityConfiguration(DeleteObservabilityConfigurationRequest deleteObservabilityConfigurationRequest) Delete an App Runner observability configuration resource.
DeleteServiceResult	deleteService(DeleteServiceRequest deleteServiceRequest) Delete an App Runner service.
DeleteVpcConnectorResult	deleteVpcConnector(DeleteVpcConnectorRequest deleteVpcConnectorRequest) Delete an App Runner VPC connector resource.
DeleteVpcIngressConnectionResult	deleteVpcIngressConnection(DeleteVpcIngressConnectionRequest deleteVpcIngressConnectionRequest) Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service.
DescribeAutoScalingConfigurationResult	describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest) Return a full description of an App Runner automatic scaling configuration resource.
DescribeCustomDomainsResult	describeCustomDomains(DescribeCustomDomainsRequest describeCustomDomainsRequest) Return a description of custom domain names that are associated with an App Runner service.
DescribeObservabilityConfigurationResult	describeObservabilityConfiguration(DescribeObservabilityConfigurationRequest describeObservabilityConfigurationRequest) Return a full description of an App Runner observability configuration resource.
DescribeServiceResult	describeService(DescribeServiceRequest describeServiceRequest) Return a full description of an App Runner service.
DescribeVpcConnectorResult	describeVpcConnector(DescribeVpcConnectorRequest describeVpcConnectorRequest) Return a description of an App Runner VPC connector resource.
DescribeVpcIngressConnectionResult	describeVpcIngressConnection(DescribeVpcIngressConnectionRequest describeVpcIngressConnectionRequest) Return a full description of an App Runner VPC Ingress Connection resource.
DisassociateCustomDomainResult	disassociateCustomDomain(DisassociateCustomDomainRequest disassociateCustomDomainRequest) 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 listAutoScalingConfigurationsRequest) Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account.
ListConnectionsResult	listConnections(ListConnectionsRequest listConnectionsRequest) Returns a list of App Runner connections that are associated with your Amazon Web Services account.
ListObservabilityConfigurationsResult	listObservabilityConfigurations(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest) Returns a list of active App Runner observability configurations in your Amazon Web Services account.
ListOperationsResult	listOperations(ListOperationsRequest listOperationsRequest) Return a list of operations that occurred on an App Runner service.
ListServicesResult	listServices(ListServicesRequest listServicesRequest) Returns a list of running App Runner services in your Amazon Web Services account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags that are associated with for an App Runner resource.
ListVpcConnectorsResult	listVpcConnectors(ListVpcConnectorsRequest listVpcConnectorsRequest) Returns a list of App Runner VPC connectors in your Amazon Web Services account.
ListVpcIngressConnectionsResult	listVpcIngressConnections(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest) Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
PauseServiceResult	pauseService(PauseServiceRequest pauseServiceRequest) Pause an active App Runner service.
ResumeServiceResult	resumeService(ResumeServiceRequest resumeServiceRequest) Resume an active App Runner service.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDeploymentResult	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.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add tags to, or update the tag values of, an App Runner resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove tags from an App Runner resource.
UpdateServiceResult	updateService(UpdateServiceRequest updateServiceRequest) Update an App Runner service.
UpdateVpcIngressConnectionResult	updateVpcIngressConnection(UpdateVpcIngressConnectionRequest updateVpcIngressConnectionRequest) Update an existing App Runner VPC Ingress Connection resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateCustomDomain

AssociateCustomDomainResult 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:

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

CreateAutoScalingConfigurationResult 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 incremental AutoScalingConfigurationRevision 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:

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

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

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

createObservabilityConfiguration

CreateObservabilityConfigurationResult 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 incremental ObservabilityConfigurationRevision 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:

Result of the CreateObservabilityConfiguration 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

CreateServiceResult 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:

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

createVpcConnector

CreateVpcConnectorResult 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:

Result of the CreateVpcConnector 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

createVpcIngressConnection

CreateVpcIngressConnectionResult 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:

Result of the CreateVpcIngressConnection 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.

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.

See Also:

AWS API Documentation

deleteAutoScalingConfiguration

DeleteAutoScalingConfigurationResult deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest)

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.

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

DeleteConnectionResult 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:

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

deleteObservabilityConfiguration

DeleteObservabilityConfigurationResult 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:

Result of the DeleteObservabilityConfiguration 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

deleteService

DeleteServiceResult 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:

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

deleteVpcConnector

DeleteVpcConnectorResult 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:

Result of the DeleteVpcConnector 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

deleteVpcIngressConnection

DeleteVpcIngressConnectionResult 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:

Result of the DeleteVpcIngressConnection 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

describeAutoScalingConfiguration

DescribeAutoScalingConfigurationResult describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest)

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

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

DescribeCustomDomainsResult describeCustomDomains(DescribeCustomDomainsRequest describeCustomDomainsRequest)

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

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

describeObservabilityConfiguration

DescribeObservabilityConfigurationResult describeObservabilityConfiguration(DescribeObservabilityConfigurationRequest describeObservabilityConfigurationRequest)

Return a full description of an App Runner observability configuration resource.

Parameters:

describeObservabilityConfigurationRequest -

Returns:

Result of the DescribeObservabilityConfiguration 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

DescribeServiceResult describeService(DescribeServiceRequest describeServiceRequest)

Return a full description of an App Runner service.

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

describeVpcConnector

DescribeVpcConnectorResult describeVpcConnector(DescribeVpcConnectorRequest describeVpcConnectorRequest)

Return a description of an App Runner VPC connector resource.

Parameters:

describeVpcConnectorRequest -

Returns:

Result of the DescribeVpcConnector 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

describeVpcIngressConnection

DescribeVpcIngressConnectionResult describeVpcIngressConnection(DescribeVpcIngressConnectionRequest describeVpcIngressConnectionRequest)

Return a full description of an App Runner VPC Ingress Connection resource.

Parameters:

describeVpcIngressConnectionRequest -

Returns:

Result of the DescribeVpcIngressConnection 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

disassociateCustomDomain

DisassociateCustomDomainResult 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:

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

ListAutoScalingConfigurationsResult 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:

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

ListConnectionsResult listConnections(ListConnectionsRequest listConnectionsRequest)

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

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

listObservabilityConfigurations

ListObservabilityConfigurationsResult 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:

Result of the ListObservabilityConfigurations 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

ListOperationsResult 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:

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

ListServicesResult listServices(ListServicesRequest listServicesRequest)

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

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

ListTagsForResourceResult 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:

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

listVpcConnectors

ListVpcConnectorsResult listVpcConnectors(ListVpcConnectorsRequest listVpcConnectorsRequest)

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

Parameters:

listVpcConnectorsRequest -

Returns:

Result of the ListVpcConnectors 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

listVpcIngressConnections

ListVpcIngressConnectionsResult listVpcIngressConnections(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest)

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

Parameters:

listVpcIngressConnectionsRequest -

Returns:

Result of the ListVpcIngressConnections 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

pauseService

PauseServiceResult 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:

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

ResumeServiceResult 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:

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

StartDeploymentResult 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:

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove tags from an App Runner resource.

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

UpdateServiceResult 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:

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

updateVpcIngressConnection

UpdateVpcIngressConnectionResult 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:

Result of the UpdateVpcIngressConnection 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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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