LicenseManagerUserSubscriptions / Client / deregister_identity_provider

deregister_identity_provider#

LicenseManagerUserSubscriptions.Client.deregister_identity_provider(**kwargs)#

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

Request Syntax

response = client.deregister_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'ActiveDirectorySettings': {
                'DomainCredentialsProvider': {
                    'SecretsManagerCredentialsProvider': {
                        'SecretId': 'string'
                    }
                },
                'DomainIpv4List': [
                    'string',
                ],
                'DomainName': 'string',
                'DomainNetworkSettings': {
                    'Subnets': [
                        'string',
                    ]
                }
            },
            'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
            'DirectoryId': 'string'
        }
    },
    IdentityProviderArn='string',
    Product='string'
)

Parameters:

IdentityProvider (dict) –
An object that specifies details for the Active Directory identity provider.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
- ActiveDirectoryIdentityProvider (dict) –
  
  The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
  - ActiveDirectorySettings (dict) –
    
    The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
    - DomainCredentialsProvider (dict) –
      
      Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
      
      Note
      This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManagerCredentialsProvider.
      - SecretsManagerCredentialsProvider (dict) –
        
        Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
        
        SecretId (string) –
        
        The ID of the Secrets Manager secret that contains credentials.
    - DomainIpv4List (list) –
      
      A list of domain IPv4 addresses that are used for the Active Directory.
      - (string) –
    - DomainName (string) –
      
      The domain name for the Active Directory.
    - DomainNetworkSettings (dict) –
      
      The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
      - Subnets (list) – [REQUIRED]
        
        Contains a list of subnets that apply for the Active Directory domain.
        
        (string) –
  - ActiveDirectoryType (string) –
    
    The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
  - DirectoryId (string) –
    
    The directory ID for an Active Directory identity provider.
IdentityProviderArn (string) – The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
Product (string) –
The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Return type:

dict

Returns:

Response Syntax

{
    'IdentityProviderSummary': {
        'FailureMessage': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'ActiveDirectorySettings': {
                    'DomainCredentialsProvider': {
                        'SecretsManagerCredentialsProvider': {
                            'SecretId': 'string'
                        }
                    },
                    'DomainIpv4List': [
                        'string',
                    ],
                    'DomainName': 'string',
                    'DomainNetworkSettings': {
                        'Subnets': [
                            'string',
                        ]
                    }
                },
                'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
                'DirectoryId': 'string'
            }
        },
        'IdentityProviderArn': '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) –
    
    The IdentityProvider resource contains information about an 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) –
      
      The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
      - ActiveDirectorySettings (dict) –
        
        The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
        
        DomainCredentialsProvider (dict) –
        
        Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManagerCredentialsProvider. 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'}
        
        SecretsManagerCredentialsProvider (dict) –
        
        Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
        
        SecretId (string) –
        
        The ID of the Secrets Manager secret that contains credentials.
        
        DomainIpv4List (list) –
        
        A list of domain IPv4 addresses that are used for the Active Directory.
        
        (string) –
        
        DomainName (string) –
        
        The domain name for the Active Directory.
        
        DomainNetworkSettings (dict) –
        
        The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
        
        Subnets (list) –
        
        Contains a list of subnets that apply for the Active Directory domain.
        
        (string) –
      - ActiveDirectoryType (string) –
        
        The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
      - DirectoryId (string) –
        
        The directory ID for an Active Directory identity provider.
  - IdentityProviderArn (string) –
    
    The Amazon Resource Name (ARN) of the identity provider.
  - Product (string) –
    
    The name of the user-based subscription product.
  - Settings (dict) –
    
    The Settings resource contains details about 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 the identity provider.

Exceptions

LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededException
LicenseManagerUserSubscriptions.Client.exceptions.ConflictException
LicenseManagerUserSubscriptions.Client.exceptions.ValidationException
LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingException
LicenseManagerUserSubscriptions.Client.exceptions.InternalServerException
LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundException
LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedException