AppStream / Client / list_entitled_applications

list_entitled_applications#

AppStream.Client.list_entitled_applications(**kwargs)#

Retrieves a list of entitled applications.

See also: AWS API Documentation

Request Syntax

response = client.list_entitled_applications(
    StackName='string',
    EntitlementName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • StackName (string) –

    [REQUIRED]

    The name of the stack with which the entitlement is associated.

  • EntitlementName (string) –

    [REQUIRED]

    The name of the entitlement.

  • NextToken (string) – The pagination token used to retrieve the next page of results for this operation.

  • MaxResults (integer) – The maximum size of each page of results.

Return type:

dict

Returns:

Response Syntax

{
    'EntitledApplications': [
        {
            'ApplicationIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • EntitledApplications (list) –

      The entitled applications.

      • (dict) –

        The application associated to an entitlement. Access is controlled based on user attributes.

        • ApplicationIdentifier (string) –

          The identifier of the application.

    • NextToken (string) –

      The pagination token used to retrieve the next page of results for this operation.

Exceptions

  • AppStream.Client.exceptions.OperationNotPermittedException

  • AppStream.Client.exceptions.ResourceNotFoundException

  • AppStream.Client.exceptions.EntitlementNotFoundException