AWS App Runner

2023/08/30 - AWS App Runner - 3 updated api methods

Changes  App Runner adds support for Bitbucket. You can now create App Runner connection that connects to your Bitbucket repositories and deploy App Runner service with the source code stored in a Bitbucket repository.

CreateConnection (updated) Link ¶
Changes (request, response)
Request 
{'ProviderType': {'BITBUCKET'}}
Response 
{'Connection': {'ProviderType': {'BITBUCKET'}}}

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 and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    ConnectionName='string',
    ProviderType='GITHUB'|'BITBUCKET',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ConnectionName:

string

param ConnectionName:

[REQUIRED]

A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

type ProviderType:

string

param ProviderType:

[REQUIRED]

The source repository provider.

type Tags:

list

param Tags:

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

  • (dict) --

    Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

    • Key (string) --

      The key of the tag.

    • Value (string) --

      The value of the tag.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • Connection (dict) --

      A description of the App Runner connection that's created by this request.

      • 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.

DeleteConnection (updated) Link ¶
Changes (response) 
{'Connection': {'ProviderType': {'BITBUCKET'}}}

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.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    ConnectionArn='string'
)
type ConnectionArn:

string

param ConnectionArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'ConnectionName': 'string',
        'ConnectionArn': 'string',
        'ProviderType': 'GITHUB'|'BITBUCKET',
        '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.

ListConnections (updated) Link ¶
Changes (response) 
{'ConnectionSummaryList': {'ProviderType': {'BITBUCKET'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_connections(
    ConnectionName='string',
    MaxResults=123,
    NextToken='string'
)
type ConnectionName:

string

param ConnectionName:

If specified, only this connection is returned. If not specified, the result isn't filtered by name.

type MaxResults:

integer

param MaxResults:

The maximum number of results to include in each response (result page). Used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

type NextToken:

string

param NextToken:

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionSummaryList': [
        {
            'ConnectionName': 'string',
            'ConnectionArn': 'string',
            'ProviderType': 'GITHUB'|'BITBUCKET',
            'Status': 'PENDING_HANDSHAKE'|'AVAILABLE'|'ERROR'|'DELETED',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ConnectionSummaryList (list) --

      A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each call.

      • (dict) --

        Provides summary information about an App Runner connection resource.

        • 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.

    • NextToken (string) --

      The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.