AppRunner / Client / list_connections

list_connections#

AppRunner.Client.list_connections(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • ConnectionName (string) – If specified, only this connection is returned. If not specified, the result isn’t filtered by name.

  • MaxResults (integer) –

    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.

  • NextToken (string) –

    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.

Return type:

dict

Returns:

Response Syntax

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

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException

  • AppRunner.Client.exceptions.InternalServiceErrorException