com.amazonaws.services.apprunner.AWSAppRunner Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.apprunner;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.apprunner.model.*;
/**
* Interface for accessing AWS App Runner.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.apprunner.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppRunner {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "apprunner";
/**
*
* 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).
*
*
* @param associateCustomDomainRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.AssociateCustomDomain
* @see AWS API Documentation
*/
AssociateCustomDomainResult associateCustomDomain(AssociateCustomDomainRequest associateCustomDomainRequest);
/**
*
* 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.
*
*
* @param createAutoScalingConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateAutoScalingConfiguration
* @see AWS API Documentation
*/
CreateAutoScalingConfigurationResult createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest createAutoScalingConfigurationRequest);
/**
*
* 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.
*
*
* @param createConnectionRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateConnection
* @see AWS API
* Documentation
*/
CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest);
/**
*
* 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.
*
*
* @param createObservabilityConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateObservabilityConfiguration
* @see AWS API Documentation
*/
CreateObservabilityConfigurationResult createObservabilityConfiguration(CreateObservabilityConfigurationRequest createObservabilityConfigurationRequest);
/**
*
* 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.
*
*
* @param createServiceRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateService
* @see AWS API
* Documentation
*/
CreateServiceResult createService(CreateServiceRequest createServiceRequest);
/**
*
* 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).
*
*
* @param createVpcConnectorRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateVpcConnector
* @see AWS
* API Documentation
*/
CreateVpcConnectorResult createVpcConnector(CreateVpcConnectorRequest createVpcConnectorRequest);
/**
*
* 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.
*
*
* @param createVpcIngressConnectionRequest
* @return 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.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws 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.
* @sample AWSAppRunner.CreateVpcIngressConnection
* @see AWS API Documentation
*/
CreateVpcIngressConnectionResult createVpcIngressConnection(CreateVpcIngressConnectionRequest createVpcIngressConnectionRequest);
/**
*
* 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.
*
*
* @param deleteAutoScalingConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DeleteAutoScalingConfiguration
* @see AWS API Documentation
*/
DeleteAutoScalingConfigurationResult deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest deleteAutoScalingConfigurationRequest);
/**
*
* 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.
*
*
* @param deleteConnectionRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.DeleteConnection
* @see AWS API
* Documentation
*/
DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest);
/**
*
* 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.
*
*
* @param deleteObservabilityConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DeleteObservabilityConfiguration
* @see AWS API Documentation
*/
DeleteObservabilityConfigurationResult deleteObservabilityConfiguration(DeleteObservabilityConfigurationRequest deleteObservabilityConfigurationRequest);
/**
*
* 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.
*
*
*
* @param deleteServiceRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.DeleteService
* @see AWS API
* Documentation
*/
DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest);
/**
*
* Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner
* services.
*
*
* @param deleteVpcConnectorRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DeleteVpcConnector
* @see AWS
* API Documentation
*/
DeleteVpcConnectorResult deleteVpcConnector(DeleteVpcConnectorRequest deleteVpcConnectorRequest);
/**
*
* 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
*
*
*
*
* @param deleteVpcIngressConnectionRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.DeleteVpcIngressConnection
* @see AWS API Documentation
*/
DeleteVpcIngressConnectionResult deleteVpcIngressConnection(DeleteVpcIngressConnectionRequest deleteVpcIngressConnectionRequest);
/**
*
* Return a full description of an App Runner automatic scaling configuration resource.
*
*
* @param describeAutoScalingConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DescribeAutoScalingConfiguration
* @see AWS API Documentation
*/
DescribeAutoScalingConfigurationResult describeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest describeAutoScalingConfigurationRequest);
/**
*
* Return a description of custom domain names that are associated with an App Runner service.
*
*
* @param describeCustomDomainsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DescribeCustomDomains
* @see AWS API Documentation
*/
DescribeCustomDomainsResult describeCustomDomains(DescribeCustomDomainsRequest describeCustomDomainsRequest);
/**
*
* Return a full description of an App Runner observability configuration resource.
*
*
* @param describeObservabilityConfigurationRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DescribeObservabilityConfiguration
* @see AWS API Documentation
*/
DescribeObservabilityConfigurationResult describeObservabilityConfiguration(
DescribeObservabilityConfigurationRequest describeObservabilityConfigurationRequest);
/**
*
* Return a full description of an App Runner service.
*
*
* @param describeServiceRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.DescribeService
* @see AWS API
* Documentation
*/
DescribeServiceResult describeService(DescribeServiceRequest describeServiceRequest);
/**
*
* Return a description of an App Runner VPC connector resource.
*
*
* @param describeVpcConnectorRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DescribeVpcConnector
* @see AWS
* API Documentation
*/
DescribeVpcConnectorResult describeVpcConnector(DescribeVpcConnectorRequest describeVpcConnectorRequest);
/**
*
* Return a full description of an App Runner VPC Ingress Connection resource.
*
*
* @param describeVpcIngressConnectionRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.DescribeVpcIngressConnection
* @see AWS API Documentation
*/
DescribeVpcIngressConnectionResult describeVpcIngressConnection(DescribeVpcIngressConnectionRequest describeVpcIngressConnectionRequest);
/**
*
* 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.
*
*
* @param disassociateCustomDomainRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.DisassociateCustomDomain
* @see AWS API Documentation
*/
DisassociateCustomDomainResult disassociateCustomDomain(DisassociateCustomDomainRequest disassociateCustomDomainRequest);
/**
*
* 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.
*
*
* @param listAutoScalingConfigurationsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListAutoScalingConfigurations
* @see AWS API Documentation
*/
ListAutoScalingConfigurationsResult listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest listAutoScalingConfigurationsRequest);
/**
*
* Returns a list of App Runner connections that are associated with your Amazon Web Services account.
*
*
* @param listConnectionsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListConnections
* @see AWS API
* Documentation
*/
ListConnectionsResult listConnections(ListConnectionsRequest listConnectionsRequest);
/**
*
* 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.
*
*
* @param listObservabilityConfigurationsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListObservabilityConfigurations
* @see AWS API Documentation
*/
ListObservabilityConfigurationsResult listObservabilityConfigurations(ListObservabilityConfigurationsRequest listObservabilityConfigurationsRequest);
/**
*
* 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.
*
*
* @param listOperationsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @sample AWSAppRunner.ListOperations
* @see AWS API
* Documentation
*/
ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest);
/**
*
* Returns a list of running App Runner services in your Amazon Web Services account.
*
*
* @param listServicesRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListServices
* @see AWS API
* Documentation
*/
ListServicesResult listServices(ListServicesRequest listServicesRequest);
/**
*
* List tags that are associated with for an App Runner resource. The response contains a list of tag key-value
* pairs.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @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.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of App Runner VPC connectors in your Amazon Web Services account.
*
*
* @param listVpcConnectorsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListVpcConnectors
* @see AWS
* API Documentation
*/
ListVpcConnectorsResult listVpcConnectors(ListVpcConnectorsRequest listVpcConnectorsRequest);
/**
*
* Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
*
*
* @param listVpcIngressConnectionsRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.ListVpcIngressConnections
* @see AWS API Documentation
*/
ListVpcIngressConnectionsResult listVpcIngressConnections(ListVpcIngressConnectionsRequest listVpcIngressConnectionsRequest);
/**
*
* 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.
*
*
* @param pauseServiceRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.PauseService
* @see AWS API
* Documentation
*/
PauseServiceResult pauseService(PauseServiceRequest pauseServiceRequest);
/**
*
* 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.
*
*
* @param resumeServiceRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.ResumeService
* @see AWS API
* Documentation
*/
ResumeServiceResult resumeService(ResumeServiceRequest resumeServiceRequest);
/**
*
* 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.
*
*
* @param startDeploymentRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.StartDeployment
* @see AWS API
* Documentation
*/
StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest);
/**
*
* Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.
*
*
* @param tagResourceRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @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.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Remove tags from an App Runner resource.
*
*
* @param untagResourceRequest
* @return 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.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @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.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @sample AWSAppRunner.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateServiceRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.UpdateService
* @see AWS API
* Documentation
*/
UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest);
/**
*
* 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
*
*
*
*
* @param updateVpcIngressConnectionRequest
* @return 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.
* @throws ResourceNotFoundException
* A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services
* account.
* @throws InvalidStateException
* You can't perform this action when the resource is in its current state.
* @throws InternalServiceErrorException
* An unexpected service exception occurred.
* @sample AWSAppRunner.UpdateVpcIngressConnection
* @see AWS API Documentation
*/
UpdateVpcIngressConnectionResult updateVpcIngressConnection(UpdateVpcIngressConnectionRequest updateVpcIngressConnectionRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}