AppFabric / Client / list_app_authorizations

list_app_authorizations#

AppFabric.Client.list_app_authorizations(**kwargs)#

Returns a list of all app authorizations configured for an app bundle.

Request Syntax

response = client.list_app_authorizations(
    appBundleIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

appBundleIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
maxResults (integer) –
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Return type:

dict

Returns:

Response Syntax

{
    'appAuthorizationSummaryList': [
        {
            'appAuthorizationArn': 'string',
            'appBundleArn': 'string',
            'app': 'string',
            'tenant': {
                'tenantIdentifier': 'string',
                'tenantDisplayName': 'string'
            },
            'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- appAuthorizationSummaryList (list) –
  
  Contains a list of app authorization summaries.
  - (dict) –
    
    Contains a summary of an app authorization.
    - appAuthorizationArn (string) –
      
      The Amazon Resource Name (ARN) of the app authorization.
    - appBundleArn (string) –
      
      The Amazon Resource Name (ARN) of the app bundle for the app authorization.
    - app (string) –
      
      The name of the application.
    - tenant (dict) –
      
      Contains information about an application tenant, such as the application display name and identifier.
      - tenantIdentifier (string) –
        
        The ID of the application tenant.
      - tenantDisplayName (string) –
        
        The display name of the tenant.
    - status (string) –
      
      The state of the app authorization.
      
      The following states are possible:
      - PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
      - Connected: The app authorization is connected to the application, and is ready to be used.
      - ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
      - TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
    - updatedAt (datetime) –
      
      Timestamp for when the app authorization was last updated.
- nextToken (string) –
  
  If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

AppFabric.Client.exceptions.InternalServerException
AppFabric.Client.exceptions.ThrottlingException
AppFabric.Client.exceptions.ValidationException
AppFabric.Client.exceptions.ResourceNotFoundException
AppFabric.Client.exceptions.AccessDeniedException