EMRServerless / Client / list_applications

list_applications#

EMRServerless.Client.list_applications(**kwargs)#

Lists applications based on a set of parameters.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    nextToken='string',
    maxResults=123,
    states=[
        'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
    ]
)
Parameters:

  • nextToken (string) – The token for the next set of application results.

  • maxResults (integer) – The maximum number of applications that can be listed.

  • states (list) –

    An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'applications': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'releaseLabel': 'string',
            'type': 'string',
            'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
            'stateDetails': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'architecture': 'ARM64'|'X86_64'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • applications (list) –

      The output lists the specified applications.

      • (dict) –

        The summary of attributes associated with an application.

        • id (string) –

          The ID of the application.

        • name (string) –

          The name of the application.

        • arn (string) –

          The ARN of the application.

        • releaseLabel (string) –

          The Amazon EMR release associated with the application.

        • type (string) –

          The type of application, such as Spark or Hive.

        • state (string) –

          The state of the application.

        • stateDetails (string) –

          The state details of the application.

        • createdAt (datetime) –

          The date and time when the application was created.

        • updatedAt (datetime) –

          The date and time when the application was last updated.

        • architecture (string) –

          The CPU architecture of an application.

    • nextToken (string) –

      The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

Exceptions