AppRunnerClient
Auto-generated documentation for AppRunner type annotations stubs module types-aiobotocore-apprunner.
AppRunnerClient
Type annotations and code completion for session.client("apprunner")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_apprunner.client import AppRunnerClient
session = Session()
async with session.client("apprunner") as client:
client: AppRunnerClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("apprunner").exceptions
structure.
async with session.client("apprunner") as client:
try:
do_something(client)
except (
client.ClientError,
client.InternalServiceErrorException,
client.InvalidRequestException,
client.InvalidStateException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
) as e:
print(e)
from types_aiobotocore_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 session.client("apprunner").associate_custom_domain
method.
boto3 documentation
await def associate_custom_domain(
self,
*,
ServiceArn: str,
DomainName: str,
EnableWWWSubdomain: bool = ...,
) -> AssociateCustomDomainResponseTypeDef: # (1)
...
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 session.client("apprunner").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("apprunner").close
method.
boto3 documentation
create_auto_scaling_configuration
Create an App Runner automatic scaling configuration resource.
Type annotations and code completion for session.client("apprunner").create_auto_scaling_configuration
method.
boto3 documentation
await def create_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationName: str,
MaxConcurrency: int = ...,
MinSize: int = ...,
MaxSize: int = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAutoScalingConfigurationResponseTypeDef: # (2)
...
kwargs: CreateAutoScalingConfigurationRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationName": ...,
}
parent.create_auto_scaling_configuration(**kwargs)
create_connection
Create an App Runner connection resource.
Type annotations and code completion for session.client("apprunner").create_connection
method.
boto3 documentation
await def create_connection(
self,
*,
ConnectionName: str,
ProviderType: ProviderTypeType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateConnectionResponseTypeDef: # (3)
...
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 session.client("apprunner").create_observability_configuration
method.
boto3 documentation
await def create_observability_configuration(
self,
*,
ObservabilityConfigurationName: str,
TraceConfiguration: TraceConfigurationTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateObservabilityConfigurationResponseTypeDef: # (3)
...
kwargs: CreateObservabilityConfigurationRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationName": ...,
}
parent.create_observability_configuration(**kwargs)
create_service
Create an App Runner service.
Type annotations and code completion for session.client("apprunner").create_service
method.
boto3 documentation
await 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
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 session.client("apprunner").create_vpc_connector
method.
boto3 documentation
await def create_vpc_connector(
self,
*,
VpcConnectorName: str,
Subnets: Sequence[str],
SecurityGroups: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVpcConnectorResponseTypeDef: # (2)
...
kwargs: CreateVpcConnectorRequestRequestTypeDef = { # (1)
"VpcConnectorName": ...,
"Subnets": ...,
}
parent.create_vpc_connector(**kwargs)
delete_auto_scaling_configuration
Delete an App Runner automatic scaling configuration resource.
Type annotations and code completion for session.client("apprunner").delete_auto_scaling_configuration
method.
boto3 documentation
await def delete_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationArn: str,
) -> DeleteAutoScalingConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteAutoScalingConfigurationRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationArn": ...,
}
parent.delete_auto_scaling_configuration(**kwargs)
delete_connection
Delete an App Runner connection.
Type annotations and code completion for session.client("apprunner").delete_connection
method.
boto3 documentation
await def delete_connection(
self,
*,
ConnectionArn: str,
) -> DeleteConnectionResponseTypeDef: # (1)
...
kwargs: DeleteConnectionRequestRequestTypeDef = { # (1)
"ConnectionArn": ...,
}
parent.delete_connection(**kwargs)
delete_observability_configuration
Delete an App Runner observability configuration resource.
Type annotations and code completion for session.client("apprunner").delete_observability_configuration
method.
boto3 documentation
await def delete_observability_configuration(
self,
*,
ObservabilityConfigurationArn: str,
) -> DeleteObservabilityConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteObservabilityConfigurationRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationArn": ...,
}
parent.delete_observability_configuration(**kwargs)
delete_service
Delete an App Runner service.
Type annotations and code completion for session.client("apprunner").delete_service
method.
boto3 documentation
await def delete_service(
self,
*,
ServiceArn: str,
) -> DeleteServiceResponseTypeDef: # (1)
...
kwargs: DeleteServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.delete_service(**kwargs)
delete_vpc_connector
Delete an App Runner VPC connector resource.
Type annotations and code completion for session.client("apprunner").delete_vpc_connector
method.
boto3 documentation
await def delete_vpc_connector(
self,
*,
VpcConnectorArn: str,
) -> DeleteVpcConnectorResponseTypeDef: # (1)
...
kwargs: DeleteVpcConnectorRequestRequestTypeDef = { # (1)
"VpcConnectorArn": ...,
}
parent.delete_vpc_connector(**kwargs)
describe_auto_scaling_configuration
Return a full description of an App Runner automatic scaling configuration resource.
Type annotations and code completion for session.client("apprunner").describe_auto_scaling_configuration
method.
boto3 documentation
await def describe_auto_scaling_configuration(
self,
*,
AutoScalingConfigurationArn: str,
) -> DescribeAutoScalingConfigurationResponseTypeDef: # (1)
...
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 session.client("apprunner").describe_custom_domains
method.
boto3 documentation
await def describe_custom_domains(
self,
*,
ServiceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeCustomDomainsResponseTypeDef: # (1)
...
kwargs: DescribeCustomDomainsRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.describe_custom_domains(**kwargs)
describe_observability_configuration
Return a full description of an App Runner observability configuration resource.
Type annotations and code completion for session.client("apprunner").describe_observability_configuration
method.
boto3 documentation
await def describe_observability_configuration(
self,
*,
ObservabilityConfigurationArn: str,
) -> DescribeObservabilityConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeObservabilityConfigurationRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationArn": ...,
}
parent.describe_observability_configuration(**kwargs)
describe_service
Return a full description of an App Runner service.
Type annotations and code completion for session.client("apprunner").describe_service
method.
boto3 documentation
await def describe_service(
self,
*,
ServiceArn: str,
) -> DescribeServiceResponseTypeDef: # (1)
...
kwargs: DescribeServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.describe_service(**kwargs)
describe_vpc_connector
Return a description of an App Runner VPC connector resource.
Type annotations and code completion for session.client("apprunner").describe_vpc_connector
method.
boto3 documentation
await def describe_vpc_connector(
self,
*,
VpcConnectorArn: str,
) -> DescribeVpcConnectorResponseTypeDef: # (1)
...
kwargs: DescribeVpcConnectorRequestRequestTypeDef = { # (1)
"VpcConnectorArn": ...,
}
parent.describe_vpc_connector(**kwargs)
disassociate_custom_domain
Disassociate a custom domain name from an App Runner service.
Type annotations and code completion for session.client("apprunner").disassociate_custom_domain
method.
boto3 documentation
await def disassociate_custom_domain(
self,
*,
ServiceArn: str,
DomainName: str,
) -> DisassociateCustomDomainResponseTypeDef: # (1)
...
kwargs: DisassociateCustomDomainRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
"DomainName": ...,
}
parent.disassociate_custom_domain(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("apprunner").generate_presigned_url
method.
boto3 documentation
await 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 session.client("apprunner").list_auto_scaling_configurations
method.
boto3 documentation
await def list_auto_scaling_configurations(
self,
*,
AutoScalingConfigurationName: str = ...,
LatestOnly: bool = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAutoScalingConfigurationsResponseTypeDef: # (1)
...
kwargs: ListAutoScalingConfigurationsRequestRequestTypeDef = { # (1)
"AutoScalingConfigurationName": ...,
}
parent.list_auto_scaling_configurations(**kwargs)
list_connections
Returns a list of App Runner connections that are associated with your Amazon Web Services account.
Type annotations and code completion for session.client("apprunner").list_connections
method.
boto3 documentation
await def list_connections(
self,
*,
ConnectionName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConnectionsResponseTypeDef: # (1)
...
kwargs: ListConnectionsRequestRequestTypeDef = { # (1)
"ConnectionName": ...,
}
parent.list_connections(**kwargs)
list_observability_configurations
Returns a list of active App Runner observability configurations in your Amazon Web Services account.
Type annotations and code completion for session.client("apprunner").list_observability_configurations
method.
boto3 documentation
await def list_observability_configurations(
self,
*,
ObservabilityConfigurationName: str = ...,
LatestOnly: bool = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListObservabilityConfigurationsResponseTypeDef: # (1)
...
kwargs: ListObservabilityConfigurationsRequestRequestTypeDef = { # (1)
"ObservabilityConfigurationName": ...,
}
parent.list_observability_configurations(**kwargs)
list_operations
Return a list of operations that occurred on an App Runner service.
Type annotations and code completion for session.client("apprunner").list_operations
method.
boto3 documentation
await def list_operations(
self,
*,
ServiceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListOperationsResponseTypeDef: # (1)
...
kwargs: ListOperationsRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.list_operations(**kwargs)
list_services
Returns a list of running App Runner services in your Amazon Web Services account.
Type annotations and code completion for session.client("apprunner").list_services
method.
boto3 documentation
await def list_services(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListServicesResponseTypeDef: # (1)
...
kwargs: ListServicesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_services(**kwargs)
list_tags_for_resource
List tags that are associated with for an App Runner resource.
Type annotations and code completion for session.client("apprunner").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_vpc_connectors
Returns a list of App Runner VPC connectors in your Amazon Web Services account.
Type annotations and code completion for session.client("apprunner").list_vpc_connectors
method.
boto3 documentation
await def list_vpc_connectors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListVpcConnectorsResponseTypeDef: # (1)
...
kwargs: ListVpcConnectorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_vpc_connectors(**kwargs)
pause_service
Pause an active App Runner service.
Type annotations and code completion for session.client("apprunner").pause_service
method.
boto3 documentation
await def pause_service(
self,
*,
ServiceArn: str,
) -> PauseServiceResponseTypeDef: # (1)
...
kwargs: PauseServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.pause_service(**kwargs)
resume_service
Resume an active App Runner service.
Type annotations and code completion for session.client("apprunner").resume_service
method.
boto3 documentation
await def resume_service(
self,
*,
ServiceArn: str,
) -> ResumeServiceResponseTypeDef: # (1)
...
kwargs: ResumeServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.resume_service(**kwargs)
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 session.client("apprunner").start_deployment
method.
boto3 documentation
await def start_deployment(
self,
*,
ServiceArn: str,
) -> StartDeploymentResponseTypeDef: # (1)
...
kwargs: StartDeploymentRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.start_deployment(**kwargs)
tag_resource
Add tags to, or update the tag values of, an App Runner resource.
Type annotations and code completion for session.client("apprunner").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Remove tags from an App Runner resource.
Type annotations and code completion for session.client("apprunner").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_service
Update an App Runner service.
Type annotations and code completion for session.client("apprunner").update_service
method.
boto3 documentation
await 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)
...
- See SourceConfigurationTypeDef
- See InstanceConfigurationTypeDef
- See HealthCheckConfigurationTypeDef
- See NetworkConfigurationTypeDef
- See ServiceObservabilityConfigurationTypeDef
- See UpdateServiceResponseTypeDef
kwargs: UpdateServiceRequestRequestTypeDef = { # (1)
"ServiceArn": ...,
}
parent.update_service(**kwargs)
__aenter__
Type annotations and code completion for session.client("apprunner").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("apprunner").__aexit__
method.
boto3 documentation