AppRunner / Client / delete_connection

delete_connection#

AppRunner.Client.delete_connection(**kwargs)#

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.

Request Syntax

response = client.delete_connection(
    ConnectionArn='string'
)

Parameters:

ConnectionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

Return type:

dict

Returns:

Response Syntax

{
    'Connection': {
        'ConnectionName': 'string',
        'ConnectionArn': 'string',
        'ProviderType': 'GITHUB',
        'Status': 'PENDING_HANDSHAKE'|'AVAILABLE'|'ERROR'|'DELETED',
        'CreatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- Connection (dict) –
  
  A description of the App Runner connection that this request just deleted.
  - ConnectionName (string) –
    
    The customer-provided connection name.
  - ConnectionArn (string) –
    
    The Amazon Resource Name (ARN) of this connection.
  - ProviderType (string) –
    
    The source repository provider.
  - Status (string) –
    
    The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.
  - CreatedAt (datetime) –
    
    The App Runner connection creation time, expressed as a Unix time stamp.

Exceptions

AppRunner.Client.exceptions.InvalidRequestException
AppRunner.Client.exceptions.ResourceNotFoundException
AppRunner.Client.exceptions.InternalServiceErrorException