WorkSpaces / Client / describe_connection_alias_permissions

describe_connection_alias_permissions#

WorkSpaces.Client.describe_connection_alias_permissions(**kwargs)#

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Request Syntax

response = client.describe_connection_alias_permissions(
    AliasId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

AliasId (string) –
[REQUIRED]

The identifier of the connection alias.
NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'AliasId': 'string',
    'ConnectionAliasPermissions': [
        {
            'SharedAccountId': 'string',
            'AllowAssociation': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- AliasId (string) –
  
  The identifier of the connection alias.
- ConnectionAliasPermissions (list) –
  
  The permissions associated with a connection alias.
  - (dict) –
    
    Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
    - SharedAccountId (string) –
      
      The identifier of the Amazon Web Services account that the connection alias is shared with.
    - AllowAssociation (boolean) –
      
      Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.OperationNotSupportedException