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
# AppRunnerClient 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.
# Exceptions.exceptions usage example
client = boto3.client("apprunner")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InternalServiceErrorException,
client.exceptions.InvalidRequestException,
client.exceptions.InvalidStateException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
) as e:
print(e)
# Exceptions.exceptions 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
# associate_custom_domain method definition
def associate_custom_domain(
self,
*,
ServiceArn: str,
DomainName: str,
EnableWWWSubdomain: bool = ...,
) -> AssociateCustomDomainResponseTypeDef: # (1)
...
# associate_custom_domain method usage example with argument unpacking
kwargs: AssociateCustomDomainRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
"DomainName": ...,
}
parent.associate_custom_domain(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("apprunner").can_paginate
method.
boto3 documentation
# can_paginate 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
# close 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
# create_auto_scaling_configuration method definition
def create_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationName: str,
MaxConcurrency: int = ...,
MinSize: int = ...,
MaxSize: int = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAutoScalingConfigurationResponseTypeDef: # (2)
...
# create_auto_scaling_configuration method usage example with argument unpacking
kwargs: CreateAutoScalingConfigurationRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationName": ...,
}
parent.create_auto_scaling_configuration(**kwargs)
create_connection#
Create an App Runner connection resource.
Type annotations and code completion for boto3.client("apprunner").create_connection
method.
boto3 documentation
# create_connection method definition
def create_connection(
self,
*,
ConnectionName: str,
ProviderType: ProviderTypeType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateConnectionResponseTypeDef: # (3)
...
# create_connection method usage example with argument unpacking
kwargs: CreateConnectionRequestRequestTypeDef = { # (1)
"ConnectionName": ...,
"ProviderType": ...,
}
parent.create_connection(**kwargs)
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
# create_observability_configuration method definition
def create_observability_configuration(
self,
*,
ObservabilityConfigurationName: str,
TraceConfiguration: TraceConfigurationTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateObservabilityConfigurationResponseTypeDef: # (3)
...
# create_observability_configuration method usage example with argument unpacking
kwargs: CreateObservabilityConfigurationRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationName": ...,
}
parent.create_observability_configuration(**kwargs)
create_service#
Create an App Runner service.
Type annotations and code completion for boto3.client("apprunner").create_service
method.
boto3 documentation
# create_service 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)
...
- See SourceConfigurationTypeDef
- See InstanceConfigurationTypeDef
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See HealthCheckConfigurationTypeDef
- See NetworkConfigurationTypeDef
- See ServiceObservabilityConfigurationTypeDef
- See CreateServiceResponseTypeDef
# create_service method usage example with argument unpacking
kwargs: CreateServiceRequestRequestTypeDef = { # (1)
"ServiceName": ...,
"SourceConfiguration": ...,
}
parent.create_service(**kwargs)
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
# create_vpc_connector method definition
def create_vpc_connector(
self,
*,
VpcConnectorName: str,
Subnets: Sequence[str],
SecurityGroups: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVpcConnectorResponseTypeDef: # (2)
...
# create_vpc_connector method usage example with argument unpacking
kwargs: CreateVpcConnectorRequestRequestTypeDef = { # (1)
"VpcConnectorName": ...,
"Subnets": ...,
}
parent.create_vpc_connector(**kwargs)
create_vpc_ingress_connection#
Create an App Runner VPC Ingress Connection resource.
Type annotations and code completion for boto3.client("apprunner").create_vpc_ingress_connection
method.
boto3 documentation
# create_vpc_ingress_connection method definition
def create_vpc_ingress_connection(
self,
*,
ServiceArn: str,
VpcIngressConnectionName: str,
IngressVpcConfiguration: IngressVpcConfigurationTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateVpcIngressConnectionResponseTypeDef: # (3)
...
# create_vpc_ingress_connection method usage example with argument unpacking
kwargs: CreateVpcIngressConnectionRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
"VpcIngressConnectionName": ...,
"IngressVpcConfiguration": ...,
}
parent.create_vpc_ingress_connection(**kwargs)
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
# delete_auto_scaling_configuration method definition
def delete_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationArn: str,
DeleteAllRevisions: bool = ...,
) -> DeleteAutoScalingConfigurationResponseTypeDef: # (1)
...
# delete_auto_scaling_configuration method usage example with argument unpacking
kwargs: DeleteAutoScalingConfigurationRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationArn": ...,
}
parent.delete_auto_scaling_configuration(**kwargs)
delete_connection#
Delete an App Runner connection.
Type annotations and code completion for boto3.client("apprunner").delete_connection
method.
boto3 documentation
# delete_connection method definition
def delete_connection(
self,
*,
ConnectionArn: str,
) -> DeleteConnectionResponseTypeDef: # (1)
...
# delete_connection method usage example with argument unpacking
kwargs: DeleteConnectionRequestRequestTypeDef = { # (1)
"ConnectionArn": ...,
}
parent.delete_connection(**kwargs)
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
# delete_observability_configuration method definition
def delete_observability_configuration(
self,
*,
ObservabilityConfigurationArn: str,
) -> DeleteObservabilityConfigurationResponseTypeDef: # (1)
...
# delete_observability_configuration method usage example with argument unpacking
kwargs: DeleteObservabilityConfigurationRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationArn": ...,
}
parent.delete_observability_configuration(**kwargs)
delete_service#
Delete an App Runner service.
Type annotations and code completion for boto3.client("apprunner").delete_service
method.
boto3 documentation
# delete_service method definition
def delete_service(
self,
*,
ServiceArn: str,
) -> DeleteServiceResponseTypeDef: # (1)
...
# delete_service method usage example with argument unpacking
kwargs: DeleteServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.delete_service(**kwargs)
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
# delete_vpc_connector method definition
def delete_vpc_connector(
self,
*,
VpcConnectorArn: str,
) -> DeleteVpcConnectorResponseTypeDef: # (1)
...
# delete_vpc_connector method usage example with argument unpacking
kwargs: DeleteVpcConnectorRequestRequestTypeDef = { # (1)
"VpcConnectorArn": ...,
}
parent.delete_vpc_connector(**kwargs)
delete_vpc_ingress_connection#
Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service.
Type annotations and code completion for boto3.client("apprunner").delete_vpc_ingress_connection
method.
boto3 documentation
# delete_vpc_ingress_connection method definition
def delete_vpc_ingress_connection(
self,
*,
VpcIngressConnectionArn: str,
) -> DeleteVpcIngressConnectionResponseTypeDef: # (1)
...
# delete_vpc_ingress_connection method usage example with argument unpacking
kwargs: DeleteVpcIngressConnectionRequestRequestTypeDef = { # (1)
"VpcIngressConnectionArn": ...,
}
parent.delete_vpc_ingress_connection(**kwargs)
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
# describe_auto_scaling_configuration method definition
def describe_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationArn: str,
) -> DescribeAutoScalingConfigurationResponseTypeDef: # (1)
...
# describe_auto_scaling_configuration method usage example with argument unpacking
kwargs: DescribeAutoScalingConfigurationRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationArn": ...,
}
parent.describe_auto_scaling_configuration(**kwargs)
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.