AWS API Changes

2022/11/29 - AWS License Manager User Subscriptions - 1 new3 updated api methods

Changes AWS now offers fully-compliant, Amazon-provided licenses for Microsoft Office Professional Plus 2021 Amazon Machine Images (AMIs) on Amazon EC2. These AMIs are now available on the Amazon EC2 console and on AWS Marketplace to launch instances on-demand without any long-term licensing commitments.

UpdateIdentityProviderSettings (new)

Link ¶

Updates additional product configuration settings for the registered identity provider.

See also: AWS API Documentation

Request Syntax

client.update_identity_provider_settings(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    UpdateSettings={
        'AddSubnets': [
            'string',
        ],
        'RemoveSubnets': [
            'string',
        ],
        'SecurityGroupId': 'string'
    }
)

type IdentityProvider:

dict

param IdentityProvider:

[REQUIRED]

Details about an identity provider.

ActiveDirectoryIdentityProvider (dict) --

An object that details an Active Directory identity provider.
- DirectoryId (string) --
  
  The directory ID for an Active Directory identity provider.

type Product:

string

param Product:

[REQUIRED]

The name of the user-based subscription product.

type UpdateSettings:

dict

param UpdateSettings:

[REQUIRED]

Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:

Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.

AddSubnets (list) -- [REQUIRED]

The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
- (string) --
RemoveSubnets (list) -- [REQUIRED]

The ID of one or more subnets to remove.
- (string) --
SecurityGroupId (string) --

A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.

rtype:

dict

returns:

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Settings': {
            'SecurityGroupId': 'string',
            'Subnets': [
                'string',
            ]
        },
        'Status': 'string'
    }
}

Response Structure

(dict) --
- IdentityProviderSummary (dict) --
  
  Describes an identity provider.
  - FailureMessage (string) --
    
    The failure message associated with an identity provider.
  - IdentityProvider (dict) --
    
    An object that specifies details for the identity provider.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ActiveDirectoryIdentityProvider (dict) --
      
      An object that details an Active Directory identity provider.
      - DirectoryId (string) --
        
        The directory ID for an Active Directory identity provider.
  - Product (string) --
    
    The name of the user-based subscription product.
  - Settings (dict) --
    
    An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
    - SecurityGroupId (string) --
      
      A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
    - Subnets (list) --
      
      The subnets defined for the registered identity provider.
      - (string) --
  - Status (string) --
    
    The status of an identity provider.

DeregisterIdentityProvider (updated)

Link ¶
Changes (response)

{'IdentityProviderSummary': {'Settings': {'SecurityGroupId': 'string',
                                          'Subnets': ['string']}}}

Deregisters the identity provider from providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.deregister_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string'
)

type IdentityProvider:

dict

param IdentityProvider:

[REQUIRED]

An object that specifies details for the identity provider.

ActiveDirectoryIdentityProvider (dict) --

An object that details an Active Directory identity provider.
- DirectoryId (string) --
  
  The directory ID for an Active Directory identity provider.

type Product:

string

param Product:

[REQUIRED]

The name of the user-based subscription product.

rtype:

dict

returns:

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Settings': {
            'SecurityGroupId': 'string',
            'Subnets': [
                'string',
            ]
        },
        'Status': 'string'
    }
}

Response Structure

(dict) --
- IdentityProviderSummary (dict) --
  
  Metadata that describes the results of an identity provider operation.
  - FailureMessage (string) --
    
    The failure message associated with an identity provider.
  - IdentityProvider (dict) --
    
    An object that specifies details for the identity provider.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ActiveDirectoryIdentityProvider (dict) --
      
      An object that details an Active Directory identity provider.
      - DirectoryId (string) --
        
        The directory ID for an Active Directory identity provider.
  - Product (string) --
    
    The name of the user-based subscription product.
  - Settings (dict) --
    
    An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
    - SecurityGroupId (string) --
      
      A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
    - Subnets (list) --
      
      The subnets defined for the registered identity provider.
      - (string) --
  - Status (string) --
    
    The status of an identity provider.

ListIdentityProviders (updated)

Link ¶
Changes (response)

{'IdentityProviderSummaries': {'Settings': {'SecurityGroupId': 'string',
                                            'Subnets': ['string']}}}

Lists the identity providers for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.list_identity_providers(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

Maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

Token for the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'IdentityProviderSummaries': [
        {
            'FailureMessage': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Settings': {
                'SecurityGroupId': 'string',
                'Subnets': [
                    'string',
                ]
            },
            'Status': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- IdentityProviderSummaries (list) --
  
  Metadata that describes the list identity providers operation.
  - (dict) --
    
    Describes an identity provider.
    - FailureMessage (string) --
      
      The failure message associated with an identity provider.
    - IdentityProvider (dict) --
      
      An object that specifies details for the identity provider.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - ActiveDirectoryIdentityProvider (dict) --
        
        An object that details an Active Directory identity provider.
        
        DirectoryId (string) --
        
        The directory ID for an Active Directory identity provider.
    - Product (string) --
      
      The name of the user-based subscription product.
    - Settings (dict) --
      
      An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
      - SecurityGroupId (string) --
        
        A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
      - Subnets (list) --
        
        The subnets defined for the registered identity provider.
        
        (string) --
    - Status (string) --
      
      The status of an identity provider.
- NextToken (string) --
  
  Token for the next set of results.

RegisterIdentityProvider (updated)

Link ¶
Changes (request, response)
Request

{'Settings': {'SecurityGroupId': 'string', 'Subnets': ['string']}}

Response

{'IdentityProviderSummary': {'Settings': {'SecurityGroupId': 'string',
                                          'Subnets': ['string']}}}

Registers an identity provider for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

client.register_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    Settings={
        'SecurityGroupId': 'string',
        'Subnets': [
            'string',
        ]
    }
)

type IdentityProvider:

dict

param IdentityProvider:

[REQUIRED]

An object that specifies details for the identity provider.

ActiveDirectoryIdentityProvider (dict) --

An object that details an Active Directory identity provider.
- DirectoryId (string) --
  
  The directory ID for an Active Directory identity provider.

type Product:

string

param Product:

[REQUIRED]

The name of the user-based subscription product.

type Settings:

dict

param Settings:

The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

SecurityGroupId (string) -- [REQUIRED]

A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
Subnets (list) -- [REQUIRED]

The subnets defined for the registered identity provider.
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Settings': {
            'SecurityGroupId': 'string',
            'Subnets': [
                'string',
            ]
        },
        'Status': 'string'
    }
}

Response Structure

(dict) --
- IdentityProviderSummary (dict) --
  
  Metadata that describes the results of an identity provider operation.
  - FailureMessage (string) --
    
    The failure message associated with an identity provider.
  - IdentityProvider (dict) --
    
    An object that specifies details for the identity provider.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ActiveDirectoryIdentityProvider (dict) --
      
      An object that details an Active Directory identity provider.
      - DirectoryId (string) --
        
        The directory ID for an Active Directory identity provider.
  - Product (string) --
    
    The name of the user-based subscription product.
  - Settings (dict) --
    
    An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
    - SecurityGroupId (string) --
      
      A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
    - Subnets (list) --
      
      The subnets defined for the registered identity provider.
      - (string) --
  - Status (string) --
    
    The status of an identity provider.