Amazon AppStream

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

See also: AWS API Documentation

Request Syntax

client.create_entitlement(
    Name='string',
    StackName='string',
    Description='string',
    AppVisibility='ALL'|'ASSOCIATED',
    Attributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

The name of the entitlement.

type StackName:

string

param StackName:

[REQUIRED]

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

type Description:

string

param Description:

The description of the entitlement.

type AppVisibility:

string

param AppVisibility:

[REQUIRED]

Specifies whether all or selected apps are entitled.

type Attributes:

list

param Attributes:

[REQUIRED]

The attributes of the entitlement.

• (dict) --

  An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.

  • Name (string) -- [REQUIRED]

    A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

    The following are valid values:

    • roles

    • department

    • organization

    • groups

    • title

    • costCenter

    • userType

  • Value (string) -- [REQUIRED]

    A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

rtype:

dict

returns:

Response Syntax

{
    'Entitlement': {
        'Name': 'string',
        'StackName': 'string',
        'Description': 'string',
        'AppVisibility': 'ALL'|'ASSOCIATED',
        'Attributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • Entitlement (dict) --

    The entitlement.

    • Name (string) --

      The name of the entitlement.

    • StackName (string) --

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

    • Description (string) --

      The description of the entitlement.

    • AppVisibility (string) --

      Specifies whether all or selected apps are entitled.

    • Attributes (list) --

      The attributes of the entitlement.

      • (dict) --

        An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.

        • Name (string) --

          A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

          The following are valid values:

          • roles

          • department

          • organization

          • groups

          • title

          • costCenter

          • userType

        • Value (string) --

          A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

    • CreatedTime (datetime) --

      The time when the entitlement was created.

    • LastModifiedTime (datetime) --

      The time when the entitlement was last modified.

Retrieves a list that describes one of more entitlements.

See also: AWS API Documentation

Request Syntax

client.describe_entitlements(
    Name='string',
    StackName='string',
    NextToken='string',
    MaxResults=123
)

type Name:

string

param Name:

The name of the entitlement.

type StackName:

string

param StackName:

[REQUIRED]

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

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum size of each page of results.

rtype:

dict

returns:

Response Syntax

{
    'Entitlements': [
        {
            'Name': 'string',
            'StackName': 'string',
            'Description': 'string',
            'AppVisibility': 'ALL'|'ASSOCIATED',
            'Attributes': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Entitlements (list) --

    The entitlements.

    • (dict) --

      Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

      • Name (string) --

        The name of the entitlement.

      • StackName (string) --

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

      • Description (string) --

        The description of the entitlement.

      • AppVisibility (string) --

        Specifies whether all or selected apps are entitled.

      • Attributes (list) --

        The attributes of the entitlement.

        • (dict) --

          An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.

          • Name (string) --

            A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

            The following are valid values:

            • roles

            • department

            • organization

            • groups

            • title

            • costCenter

            • userType

          • Value (string) --

            A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

      • CreatedTime (datetime) --

        The time when the entitlement was created.

      • LastModifiedTime (datetime) --

        The time when the entitlement was last modified.

  • NextToken (string) --

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

Deletes the specified entitlement.

See also: AWS API Documentation

Request Syntax

client.delete_entitlement(
    Name='string',
    StackName='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the entitlement.

type StackName:

string

param StackName:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates the specified entitlement.

See also: AWS API Documentation

Request Syntax

client.update_entitlement(
    Name='string',
    StackName='string',
    Description='string',
    AppVisibility='ALL'|'ASSOCIATED',
    Attributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

The name of the entitlement.

type StackName:

string

param StackName:

[REQUIRED]

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

type Description:

string

param Description:

The description of the entitlement.

type AppVisibility:

string

param AppVisibility:

Specifies whether all or only selected apps are entitled.

type Attributes:

list

param Attributes:

The attributes of the entitlement.

• (dict) --

  An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.

  • Name (string) -- [REQUIRED]

    A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

    The following are valid values:

    • roles

    • department

    • organization

    • groups

    • title

    • costCenter

    • userType

  • Value (string) -- [REQUIRED]

    A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

rtype:

dict

returns:

Response Syntax

{
    'Entitlement': {
        'Name': 'string',
        'StackName': 'string',
        'Description': 'string',
        'AppVisibility': 'ALL'|'ASSOCIATED',
        'Attributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • Entitlement (dict) --

    The entitlement.

    • Name (string) --

      The name of the entitlement.

    • StackName (string) --

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

    • Description (string) --

      The description of the entitlement.

    • AppVisibility (string) --

      Specifies whether all or selected apps are entitled.

    • Attributes (list) --

      The attributes of the entitlement.

      • (dict) --

        An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.

        • Name (string) --

          A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

          The following are valid values:

          • roles

          • department

          • organization

          • groups

          • title

          • costCenter

          • userType

        • Value (string) --

          A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

    • CreatedTime (datetime) --

      The time when the entitlement was created.

    • LastModifiedTime (datetime) --

      The time when the entitlement was last modified.

Associates an application to entitle.

See also: AWS API Documentation

Request Syntax

client.associate_application_to_entitlement(
    StackName='string',
    EntitlementName='string',
    ApplicationIdentifier='string'
)

type StackName:

string

param StackName:

[REQUIRED]

The name of the stack.

type EntitlementName:

string

param EntitlementName:

[REQUIRED]

The name of the entitlement.

type ApplicationIdentifier:

string

param ApplicationIdentifier:

[REQUIRED]

The identifier of the application.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Deletes the specified application from the specified entitlement.

See also: AWS API Documentation

Request Syntax

client.disassociate_application_from_entitlement(
    StackName='string',
    EntitlementName='string',
    ApplicationIdentifier='string'
)

type StackName:

string

param StackName:

[REQUIRED]

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

type EntitlementName:

string

param EntitlementName:

[REQUIRED]

The name of the entitlement.

type ApplicationIdentifier:

string

param ApplicationIdentifier:

[REQUIRED]

The identifier of the application to remove from the entitlement.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Retrieves a list of entitled applications.

See also: AWS API Documentation

Request Syntax

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

type StackName:

string

param StackName:

[REQUIRED]

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

type EntitlementName:

string

param EntitlementName:

[REQUIRED]

The name of the entitlement.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum size of each page of results.

rtype:

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.