AWS API Changes

2020/09/11 - Amazon WorkSpaces - 7 new api methods

Changes Update workspaces client to latest version

CreateConnectionAlias (new)

Link ¶

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.create_connection_alias(
    ConnectionString='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ConnectionString:

string

param ConnectionString:

[REQUIRED]

A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

type Tags:

list

param Tags:

The tags to associate with the connection alias.

(dict) --

Describes a tag.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) --
  
  The value of the tag.

rtype:

dict

returns:

Response Syntax

{
    'AliasId': 'string'
}

Response Structure

(dict) --
- AliasId (string) --
  
  The identifier of the connection alias.

DescribeConnectionAliases (new)

Link ¶

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.describe_connection_aliases(
    AliasIds=[
        'string',
    ],
    ResourceId='string',
    Limit=123,
    NextToken='string'
)

type AliasIds:

list

param AliasIds:

The identifiers of the connection aliases to describe.

(string) --

type ResourceId:

string

param ResourceId:

The identifier of the directory associated with the connection alias.

type Limit:

integer

param Limit:

The maximum number of connection aliases to return.

type NextToken:

string

param NextToken:

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionAliases': [
        {
            'ConnectionString': 'string',
            'AliasId': 'string',
            'State': 'CREATING'|'CREATED'|'DELETING',
            'OwnerAccountId': 'string',
            'Associations': [
                {
                    'AssociationStatus': 'NOT_ASSOCIATED'|'ASSOCIATED_WITH_OWNER_ACCOUNT'|'ASSOCIATED_WITH_SHARED_ACCOUNT'|'PENDING_ASSOCIATION'|'PENDING_DISASSOCIATION',
                    'AssociatedAccountId': 'string',
                    'ResourceId': 'string',
                    'ConnectionIdentifier': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConnectionAliases (list) --
  
  Information about the specified connection aliases.
  - (dict) --
    
    Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
    - ConnectionString (string) --
      
      The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    - AliasId (string) --
      
      The identifier of the connection alias.
    - State (string) --
      
      The current state of the connection alias.
    - OwnerAccountId (string) --
      
      The identifier of the AWS account that owns the connection alias.
    - Associations (list) --
      
      The association status of the connection alias.
      - (dict) --
        
        Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
        
        AssociationStatus (string) --
        
        The association status of the connection alias.
        
        AssociatedAccountId (string) --
        
        The identifier of the AWS account that associated the connection alias with a directory.
        
        ResourceId (string) --
        
        The identifier of the directory associated with a connection alias.
        
        ConnectionIdentifier (string) --
        
        The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
- NextToken (string) --
  
  The token to use to retrieve the next set of results, or null if no more results are available.

DisassociateConnectionAlias (new)

Link ¶

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.disassociate_connection_alias(
    AliasId='string'
)

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the connection alias to disassociate.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

AssociateConnectionAlias (new)

Link ¶

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.associate_connection_alias(
    AliasId='string',
    ResourceId='string'
)

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the connection alias.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The identifier of the directory to associate the connection alias with.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionIdentifier': 'string'
}

Response Structure

(dict) --
- ConnectionIdentifier (string) --
  
  The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

UpdateConnectionAliasPermission (new)

Link ¶

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.update_connection_alias_permission(
    AliasId='string',
    ConnectionAliasPermission={
        'SharedAccountId': 'string',
        'AllowAssociation': True|False
    }
)

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the connection alias that you want to update permissions for.

type ConnectionAliasPermission:

dict

param ConnectionAliasPermission:

[REQUIRED]

Indicates whether to share or unshare the connection alias with the specified AWS account.

SharedAccountId (string) -- [REQUIRED]

The identifier of the AWS account that the connection alias is shared with.
AllowAssociation (boolean) -- [REQUIRED]

Indicates whether the specified AWS account is allowed to associate the connection alias with a directory.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteConnectionAlias (new)

Link ¶

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.delete_connection_alias(
    AliasId='string'
)

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the connection alias to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DescribeConnectionAliasPermissions (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the connection alias.

type NextToken:

string

param NextToken:

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

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 AWS account that the connection alias is shared with.
    - AllowAssociation (boolean) --
      
      Indicates whether the specified AWS account is allowed to associate the connection alias with a directory.
- NextToken (string) --
  
  The token to use to retrieve the next set of results, or null if no more results are available.