AWS API Changes

2024/04/18 - Amazon WorkSpaces - 6 new 1 updated api methods

Changes Adds new APIs for managing and sharing WorkSpaces BYOL configuration across accounts.

ListAccountLinks (new)

Lists all account links.

Request Syntax

client.list_account_links(
    LinkStatusFilter=[
        'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
    ],
    NextToken='string',
    MaxResults=123
)

type LinkStatusFilter

list

param LinkStatusFilter

Filters the account based on their link status.

(string) --

type NextToken

string

param NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

type MaxResults

integer

param MaxResults

The maximum number of accounts to return.

rtype

dict

returns

Response Syntax

{
    'AccountLinks': [
        {
            'AccountLinkId': 'string',
            'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
            'SourceAccountId': 'string',
            'TargetAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AccountLinks (list) --
  
  Information about the account links.
  - (dict) --
    
    Information about about the account link.
    - AccountLinkId (string) --
      
      The identifier of the account link.
    - AccountLinkStatus (string) --
      
      The status of the account link.
    - SourceAccountId (string) --
      
      The identifier of the source account.
    - TargetAccountId (string) --
      
      The identifier of the target account.
- 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.

CreateAccountLinkInvitation (new)

Link ¶

Creates the account link invitation.

See also: AWS API Documentation

Request Syntax

client.create_account_link_invitation(
    TargetAccountId='string',
    ClientToken='string'
)

type TargetAccountId

string

param TargetAccountId

[REQUIRED]

The identifier of the target account.

type ClientToken

string

param ClientToken

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

rtype

dict

returns

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

(dict) --
- AccountLink (dict) --
  
  Information about the account link.
  - AccountLinkId (string) --
    
    The identifier of the account link.
  - AccountLinkStatus (string) --
    
    The status of the account link.
  - SourceAccountId (string) --
    
    The identifier of the source account.
  - TargetAccountId (string) --
    
    The identifier of the target account.

DeleteAccountLinkInvitation (new)

Link ¶

Deletes the account link invitation.

See also: AWS API Documentation

Request Syntax

client.delete_account_link_invitation(
    LinkId='string',
    ClientToken='string'
)

type LinkId

string

param LinkId

[REQUIRED]

The identifier of the account link.

type ClientToken

string

param ClientToken

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

rtype

dict

returns

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

(dict) --
- AccountLink (dict) --
  
  Information about the account link.
  - AccountLinkId (string) --
    
    The identifier of the account link.
  - AccountLinkStatus (string) --
    
    The status of the account link.
  - SourceAccountId (string) --
    
    The identifier of the source account.
  - TargetAccountId (string) --
    
    The identifier of the target account.

AcceptAccountLinkInvitation (new)

Link ¶

Accepts the account link invitation.

Warning

There's currently no unlinking capability after you accept the account linking invitation.

See also: AWS API Documentation

Request Syntax

client.accept_account_link_invitation(
    LinkId='string',
    ClientToken='string'
)

type LinkId

string

param LinkId

[REQUIRED]

The identifier of the account link.

type ClientToken

string

param ClientToken

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

rtype

dict

returns

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

(dict) --
- AccountLink (dict) --
  
  Information about the account link.
  - AccountLinkId (string) --
    
    The identifier of the account link.
  - AccountLinkStatus (string) --
    
    The status of the account link.
  - SourceAccountId (string) --
    
    The identifier of the source account.
  - TargetAccountId (string) --
    
    The identifier of the target account.

RejectAccountLinkInvitation (new)

Link ¶

Rejects the account link invitation.

See also: AWS API Documentation

Request Syntax

client.reject_account_link_invitation(
    LinkId='string',
    ClientToken='string'
)

type LinkId

string

param LinkId

[REQUIRED]

The identifier of the account link

type ClientToken

string

param ClientToken

The client token of the account link invitation to reject.

rtype

dict

returns

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

(dict) --
- AccountLink (dict) --
  
  Information about the account link.
  - AccountLinkId (string) --
    
    The identifier of the account link.
  - AccountLinkStatus (string) --
    
    The status of the account link.
  - SourceAccountId (string) --
    
    The identifier of the source account.
  - TargetAccountId (string) --
    
    The identifier of the target account.

GetAccountLink (new)

Link ¶

Retrieves account link information.

See also: AWS API Documentation

Request Syntax

client.get_account_link(
    LinkId='string',
    LinkedAccountId='string'
)

type LinkId

string

param LinkId

The identifier of the account to link.

type LinkedAccountId

string

param LinkedAccountId

The identifier of the account link

rtype

dict

returns

Response Syntax

{
    'AccountLink': {
        'AccountLinkId': 'string',
        'AccountLinkStatus': 'LINKED'|'LINKING_FAILED'|'LINK_NOT_FOUND'|'PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT'|'REJECTED',
        'SourceAccountId': 'string',
        'TargetAccountId': 'string'
    }
}

Response Structure

(dict) --
- AccountLink (dict) --
  
  The account link of the account link to retrieve.
  - AccountLinkId (string) --
    
    The identifier of the account link.
  - AccountLinkStatus (string) --
    
    The status of the account link.
  - SourceAccountId (string) --
    
    The identifier of the source account.
  - TargetAccountId (string) --
    
    The identifier of the target account.

DescribeAccount (updated)

Link ¶
Changes (response)

{'DedicatedTenancyAccountType': 'SOURCE_ACCOUNT | TARGET_ACCOUNT'}

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.describe_account()

rtype

dict

returns

Response Syntax

{
    'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
    'DedicatedTenancyManagementCidrRange': 'string',
    'DedicatedTenancyAccountType': 'SOURCE_ACCOUNT'|'TARGET_ACCOUNT'
}

Response Structure

(dict) --
- DedicatedTenancySupport (string) --
  
  The status of BYOL (whether BYOL is enabled or disabled).
- DedicatedTenancyManagementCidrRange (string) --
  
  The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
  
  The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
- DedicatedTenancyAccountType (string) --
  
  The type of linked account.