Skip to content

AppRunnerClient

Index > AppRunner > AppRunnerClient

Auto-generated documentation for AppRunner type annotations stubs module mypy-boto3-apprunner.

AppRunnerClient

Type annotations and code completion for boto3.client("apprunner"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_apprunner.client import AppRunnerClient

def get_apprunner_client() -> AppRunnerClient:
    return Session().client("apprunner")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("apprunner").exceptions structure.

Usage example
client = boto3.client("apprunner")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalServiceErrorException,
    client.InvalidRequestException,
    client.InvalidStateException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
) as e:
    print(e)
Type checking example
from mypy_boto3_apprunner.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_custom_domain

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

Type annotations and code completion for boto3.client("apprunner").associate_custom_domain method. boto3 documentation

Method definition
def associate_custom_domain(
    self,
    *,
    ServiceArn: str,
    DomainName: str,
    EnableWWWSubdomain: bool = ...,
) -> AssociateCustomDomainResponseTypeDef:  # (1)
    ...
  1. See AssociateCustomDomainResponseTypeDef
Usage example with kwargs
kwargs: AssociateCustomDomainRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
    "DomainName": ...,
}

parent.associate_custom_domain(**kwargs)
  1. See AssociateCustomDomainRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("apprunner").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("apprunner").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_auto_scaling_configuration

Create an App Runner automatic scaling configuration resource.

Type annotations and code completion for boto3.client("apprunner").create_auto_scaling_configuration method. boto3 documentation

Method definition
def create_auto_scaling_configuration(
    self,
    *,
    AutoScalingConfigurationName: str,
    MaxConcurrency: int = ...,
    MinSize: int = ...,
    MaxSize: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAutoScalingConfigurationResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAutoScalingConfigurationResponseTypeDef
Usage example with kwargs
kwargs: CreateAutoScalingConfigurationRequestRequestTypeDef = {  # (1)
    "AutoScalingConfigurationName": ...,
}

parent.create_auto_scaling_configuration(**kwargs)
  1. See CreateAutoScalingConfigurationRequestRequestTypeDef

create_connection

Create an App Runner connection resource.

Type annotations and code completion for boto3.client("apprunner").create_connection method. boto3 documentation

Method definition
def create_connection(
    self,
    *,
    ConnectionName: str,
    ProviderType: ProviderTypeType,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateConnectionResponseTypeDef:  # (3)
    ...
  1. See ProviderTypeType
  2. See TagTypeDef
  3. See CreateConnectionResponseTypeDef
Usage example with kwargs
kwargs: CreateConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionName": ...,
    "ProviderType": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionRequestRequestTypeDef

create_observability_configuration

Create an App Runner observability configuration resource.

Type annotations and code completion for boto3.client("apprunner").create_observability_configuration method. boto3 documentation

Method definition
def create_observability_configuration(
    self,
    *,
    ObservabilityConfigurationName: str,
    TraceConfiguration: TraceConfigurationTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateObservabilityConfigurationResponseTypeDef:  # (3)
    ...
  1. See TraceConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateObservabilityConfigurationResponseTypeDef
Usage example with kwargs
kwargs: CreateObservabilityConfigurationRequestRequestTypeDef = {  # (1)
    "ObservabilityConfigurationName": ...,
}

parent.create_observability_configuration(**kwargs)
  1. See CreateObservabilityConfigurationRequestRequestTypeDef

create_service

Create an App Runner service.

Type annotations and code completion for boto3.client("apprunner").create_service method. boto3 documentation

Method definition
def create_service(
    self,
    *,
    ServiceName: str,
    SourceConfiguration: SourceConfigurationTypeDef,  # (1)
    InstanceConfiguration: InstanceConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (4)
    HealthCheckConfiguration: HealthCheckConfigurationTypeDef = ...,  # (5)
    AutoScalingConfigurationArn: str = ...,
    NetworkConfiguration: NetworkConfigurationTypeDef = ...,  # (6)
    ObservabilityConfiguration: ServiceObservabilityConfigurationTypeDef = ...,  # (7)
) -> CreateServiceResponseTypeDef:  # (8)
    ...
  1. See SourceConfigurationTypeDef
  2. See InstanceConfigurationTypeDef
  3. See TagTypeDef
  4. See EncryptionConfigurationTypeDef
  5. See HealthCheckConfigurationTypeDef
  6. See NetworkConfigurationTypeDef
  7. See ServiceObservabilityConfigurationTypeDef
  8. See CreateServiceResponseTypeDef
Usage example with kwargs
kwargs: CreateServiceRequestRequestTypeDef = {  # (1)
    "ServiceName": ...,
    "SourceConfiguration": ...,
}

parent.create_service(**kwargs)
  1. See CreateServiceRequestRequestTypeDef

create_vpc_connector

Create an App Runner VPC connector resource.

Type annotations and code completion for boto3.client("apprunner").create_vpc_connector method. boto3 documentation

Method definition
def create_vpc_connector(
    self,
    *,
    VpcConnectorName: str,
    Subnets: Sequence[str],
    SecurityGroups: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateVpcConnectorResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateVpcConnectorResponseTypeDef
Usage example with kwargs
kwargs: CreateVpcConnectorRequestRequestTypeDef = {  # (1)
    "VpcConnectorName": ...,
    "Subnets": ...,
}

parent.create_vpc_connector(**kwargs)
  1. See CreateVpcConnectorRequestRequestTypeDef

delete_auto_scaling_configuration

Delete an App Runner automatic scaling configuration resource.

Type annotations and code completion for boto3.client("apprunner").delete_auto_scaling_configuration method. boto3 documentation

Method definition
def delete_auto_scaling_configuration(
    self,
    *,
    AutoScalingConfigurationArn: str,
) -> DeleteAutoScalingConfigurationResponseTypeDef:  # (1)
    ...
  1. See DeleteAutoScalingConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DeleteAutoScalingConfigurationRequestRequestTypeDef = {  # (1)
    "AutoScalingConfigurationArn": ...,
}

parent.delete_auto_scaling_configuration(**kwargs)
  1. See DeleteAutoScalingConfigurationRequestRequestTypeDef

delete_connection

Delete an App Runner connection.

Type annotations and code completion for boto3.client("apprunner").delete_connection method. boto3 documentation

Method definition
def delete_connection(
    self,
    *,
    ConnectionArn: str,
) -> DeleteConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteConnectionResponseTypeDef
Usage example with kwargs
kwargs: DeleteConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionArn": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionRequestRequestTypeDef

delete_observability_configuration

Delete an App Runner observability configuration resource.

Type annotations and code completion for boto3.client("apprunner").delete_observability_configuration method. boto3 documentation

Method definition
def delete_observability_configuration(
    self,
    *,
    ObservabilityConfigurationArn: str,
) -> DeleteObservabilityConfigurationResponseTypeDef:  # (1)
    ...
  1. See DeleteObservabilityConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DeleteObservabilityConfigurationRequestRequestTypeDef = {  # (1)
    "ObservabilityConfigurationArn": ...,
}

parent.delete_observability_configuration(**kwargs)
  1. See DeleteObservabilityConfigurationRequestRequestTypeDef

delete_service

Delete an App Runner service.

Type annotations and code completion for boto3.client("apprunner").delete_service method. boto3 documentation

Method definition
def delete_service(
    self,
    *,
    ServiceArn: str,
) -> DeleteServiceResponseTypeDef:  # (1)
    ...
  1. See DeleteServiceResponseTypeDef
Usage example with kwargs
kwargs: DeleteServiceRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.delete_service(**kwargs)
  1. See DeleteServiceRequestRequestTypeDef

delete_vpc_connector

Delete an App Runner VPC connector resource.

Type annotations and code completion for boto3.client("apprunner").delete_vpc_connector method. boto3 documentation

Method definition
def delete_vpc_connector(
    self,
    *,
    VpcConnectorArn: str,
) -> DeleteVpcConnectorResponseTypeDef:  # (1)
    ...
  1. See DeleteVpcConnectorResponseTypeDef
Usage example with kwargs
kwargs: DeleteVpcConnectorRequestRequestTypeDef = {  # (1)
    "VpcConnectorArn": ...,
}

parent.delete_vpc_connector(**kwargs)
  1. See DeleteVpcConnectorRequestRequestTypeDef

describe_auto_scaling_configuration

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

Type annotations and code completion for boto3.client("apprunner").describe_auto_scaling_configuration method. boto3 documentation

Method definition
def describe_auto_scaling_configuration(
    self,
    *,
    AutoScalingConfigurationArn: str,
) -> DescribeAutoScalingConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeAutoScalingConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeAutoScalingConfigurationRequestRequestTypeDef = {  # (1)
    "AutoScalingConfigurationArn": ...,
}

parent.describe_auto_scaling_configuration(**kwargs)
  1. See DescribeAutoScalingConfigurationRequestRequestTypeDef

describe_custom_domains

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

Type annotations and code completion for boto3.client("apprunner").describe_custom_domains method. boto3 documentation

Method definition
def describe_custom_domains(
    self,
    *,
    ServiceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeCustomDomainsResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomDomainsResponseTypeDef
Usage example with kwargs
kwargs: DescribeCustomDomainsRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.describe_custom_domains(**kwargs)
  1. See DescribeCustomDomainsRequestRequestTypeDef

describe_observability_configuration

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

Type annotations and code completion for boto3.client("apprunner").describe_observability_configuration method. boto3 documentation

Method definition
def describe_observability_configuration(
    self,
    *,
    ObservabilityConfigurationArn: str,
) -> DescribeObservabilityConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeObservabilityConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeObservabilityConfigurationRequestRequestTypeDef = {  # (1)
    "ObservabilityConfigurationArn": ...,
}

parent.describe_observability_configuration(**kwargs)
  1. See DescribeObservabilityConfigurationRequestRequestTypeDef

describe_service

Return a full description of an App Runner service.

Type annotations and code completion for boto3.client("apprunner").describe_service method. boto3 documentation

Method definition
def describe_service(
    self,
    *,
    ServiceArn: str,
) -> DescribeServiceResponseTypeDef:  # (1)
    ...
  1. See DescribeServiceResponseTypeDef
Usage example with kwargs
kwargs: DescribeServiceRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.describe_service(**kwargs)
  1. See DescribeServiceRequestRequestTypeDef

describe_vpc_connector

Return a description of an App Runner VPC connector resource.

Type annotations and code completion for boto3.client("apprunner").describe_vpc_connector method. boto3 documentation

Method definition
def describe_vpc_connector(
    self,
    *,
    VpcConnectorArn: str,
) -> DescribeVpcConnectorResponseTypeDef:  # (1)
    ...
  1. See DescribeVpcConnectorResponseTypeDef
Usage example with kwargs
kwargs: DescribeVpcConnectorRequestRequestTypeDef = {  # (1)
    "VpcConnectorArn": ...,
}

parent.describe_vpc_connector(**kwargs)
  1. See DescribeVpcConnectorRequestRequestTypeDef

disassociate_custom_domain

Disassociate a custom domain name from an App Runner service.

Type annotations and code completion for boto3.client("apprunner").disassociate_custom_domain method. boto3 documentation

Method definition
def disassociate_custom_domain(
    self,
    *,
    ServiceArn: str,
    DomainName: str,
) -> DisassociateCustomDomainResponseTypeDef:  # (1)
    ...
  1. See DisassociateCustomDomainResponseTypeDef
Usage example with kwargs
kwargs: DisassociateCustomDomainRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
    "DomainName": ...,
}

parent.disassociate_custom_domain(**kwargs)
  1. See DisassociateCustomDomainRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("apprunner").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_auto_scaling_configurations

Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account.

Type annotations and code completion for boto3.client("apprunner").list_auto_scaling_configurations method. boto3 documentation

Method definition
def list_auto_scaling_configurations(
    self,
    *,
    AutoScalingConfigurationName: str = ...,
    LatestOnly: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAutoScalingConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListAutoScalingConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListAutoScalingConfigurationsRequestRequestTypeDef = {  # (1)
    "AutoScalingConfigurationName": ...,
}

parent.list_auto_scaling_configurations(**kwargs)
  1. See ListAutoScalingConfigurationsRequestRequestTypeDef

list_connections

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

Type annotations and code completion for boto3.client("apprunner").list_connections method. boto3 documentation

Method definition
def list_connections(
    self,
    *,
    ConnectionName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConnectionsResponseTypeDef:  # (1)
    ...
  1. See ListConnectionsResponseTypeDef
Usage example with kwargs
kwargs: ListConnectionsRequestRequestTypeDef = {  # (1)
    "ConnectionName": ...,
}

parent.list_connections(**kwargs)
  1. See ListConnectionsRequestRequestTypeDef

list_observability_configurations

Returns a list of active App Runner observability configurations in your Amazon Web Services account.

Type annotations and code completion for boto3.client("apprunner").list_observability_configurations method. boto3 documentation

Method definition
def list_observability_configurations(
    self,
    *,
    ObservabilityConfigurationName: str = ...,
    LatestOnly: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListObservabilityConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListObservabilityConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListObservabilityConfigurationsRequestRequestTypeDef = {  # (1)
    "ObservabilityConfigurationName": ...,
}

parent.list_observability_configurations(**kwargs)
  1. See ListObservabilityConfigurationsRequestRequestTypeDef

list_operations

Return a list of operations that occurred on an App Runner service.

Type annotations and code completion for boto3.client("apprunner").list_operations method. boto3 documentation

Method definition
def list_operations(
    self,
    *,
    ServiceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOperationsResponseTypeDef:  # (1)
    ...
  1. See ListOperationsResponseTypeDef
Usage example with kwargs
kwargs: ListOperationsRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.list_operations(**kwargs)
  1. See ListOperationsRequestRequestTypeDef

list_services

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

Type annotations and code completion for boto3.client("apprunner").list_services method. boto3 documentation

Method definition
def list_services(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListServicesResponseTypeDef:  # (1)
    ...
  1. See ListServicesResponseTypeDef
Usage example with kwargs
kwargs: ListServicesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_services(**kwargs)
  1. See ListServicesRequestRequestTypeDef

list_tags_for_resource

List tags that are associated with for an App Runner resource.

Type annotations and code completion for boto3.client("apprunner").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_vpc_connectors

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

Type annotations and code completion for boto3.client("apprunner").list_vpc_connectors method. boto3 documentation

Method definition
def list_vpc_connectors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListVpcConnectorsResponseTypeDef:  # (1)
    ...
  1. See ListVpcConnectorsResponseTypeDef
Usage example with kwargs
kwargs: ListVpcConnectorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_vpc_connectors(**kwargs)
  1. See ListVpcConnectorsRequestRequestTypeDef

pause_service

Pause an active App Runner service.

Type annotations and code completion for boto3.client("apprunner").pause_service method. boto3 documentation

Method definition
def pause_service(
    self,
    *,
    ServiceArn: str,
) -> PauseServiceResponseTypeDef:  # (1)
    ...
  1. See PauseServiceResponseTypeDef
Usage example with kwargs
kwargs: PauseServiceRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.pause_service(**kwargs)
  1. See PauseServiceRequestRequestTypeDef

resume_service

Resume an active App Runner service.

Type annotations and code completion for boto3.client("apprunner").resume_service method. boto3 documentation

Method definition
def resume_service(
    self,
    *,
    ServiceArn: str,
) -> ResumeServiceResponseTypeDef:  # (1)
    ...
  1. See ResumeServiceResponseTypeDef
Usage example with kwargs
kwargs: ResumeServiceRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.resume_service(**kwargs)
  1. See ResumeServiceRequestRequestTypeDef

start_deployment

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.

Type annotations and code completion for boto3.client("apprunner").start_deployment method. boto3 documentation

Method definition
def start_deployment(
    self,
    *,
    ServiceArn: str,
) -> StartDeploymentResponseTypeDef:  # (1)
    ...
  1. See StartDeploymentResponseTypeDef
Usage example with kwargs
kwargs: StartDeploymentRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.start_deployment(**kwargs)
  1. See StartDeploymentRequestRequestTypeDef

tag_resource

Add tags to, or update the tag values of, an App Runner resource.

Type annotations and code completion for boto3.client("apprunner").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Remove tags from an App Runner resource.

Type annotations and code completion for boto3.client("apprunner").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_service

Update an App Runner service.

Type annotations and code completion for boto3.client("apprunner").update_service method. boto3 documentation

Method definition
def update_service(
    self,
    *,
    ServiceArn: str,
    SourceConfiguration: SourceConfigurationTypeDef = ...,  # (1)
    InstanceConfiguration: InstanceConfigurationTypeDef = ...,  # (2)
    AutoScalingConfigurationArn: str = ...,
    HealthCheckConfiguration: HealthCheckConfigurationTypeDef = ...,  # (3)
    NetworkConfiguration: NetworkConfigurationTypeDef = ...,  # (4)
    ObservabilityConfiguration: ServiceObservabilityConfigurationTypeDef = ...,  # (5)
) -> UpdateServiceResponseTypeDef:  # (6)
    ...
  1. See SourceConfigurationTypeDef
  2. See InstanceConfigurationTypeDef
  3. See HealthCheckConfigurationTypeDef
  4. See NetworkConfigurationTypeDef
  5. See ServiceObservabilityConfigurationTypeDef
  6. See UpdateServiceResponseTypeDef
Usage example with kwargs
kwargs: UpdateServiceRequestRequestTypeDef = {  # (1)
    "ServiceArn": ...,
}

parent.update_service(**kwargs)
  1. See UpdateServiceRequestRequestTypeDef