AWS SDK for PHP 3.x

Client: Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient

Service ID: license-manager-user-subscriptions

Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS License Manager User Subscriptions (2018-05-10), and shows how to use the Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateUser ( array $params = [] ): Associates the user to an EC2 instance to utilize user-based subscriptions.
CreateLicenseServerEndpoint ( array $params = [] ): Creates a network endpoint for the Remote Desktop Services (RDS) license server.
DeleteLicenseServerEndpoint ( array $params = [] ): Deletes a LicenseServerEndpoint resource.
DeregisterIdentityProvider ( array $params = [] ): Deregisters the Active Directory identity provider from License Manager user-based subscriptions.
DisassociateUser ( array $params = [] ): Disassociates the user from an EC2 instance providing user-based subscriptions.
ListIdentityProviders ( array $params = [] ): Lists the Active Directory identity providers for user-based subscriptions.
ListInstances ( array $params = [] ): Lists the EC2 instances providing user-based subscriptions.
ListLicenseServerEndpoints ( array $params = [] ): List the Remote Desktop Services (RDS) License Server endpoints
ListProductSubscriptions ( array $params = [] ): Lists the user-based subscription products available from an identity provider.
ListTagsForResource ( array $params = [] ): Returns the list of tags for the specified resource.
ListUserAssociations ( array $params = [] ): Lists user associations for an identity provider.
RegisterIdentityProvider ( array $params = [] ): Registers an identity provider for user-based subscriptions.
StartProductSubscription ( array $params = [] ): Starts a product subscription for a user with the specified identity provider.
StopProductSubscription ( array $params = [] ): Stops a product subscription for a user with the specified identity provider.
TagResource ( array $params = [] ): Adds tags to a resource.
UntagResource ( array $params = [] ): Removes tags from a resource.
UpdateIdentityProviderSettings ( array $params = [] ): Updates additional product configuration settings for the registered identity provider.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListIdentityProviders
ListInstances
ListLicenseServerEndpoints
ListProductSubscriptions
ListUserAssociations

Operations

AssociateUser

$result = $client->associateUser([/* ... */]);
$promise = $client->associateUserAsync([/* ... */]);

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Parameter Syntax

$result = $client->associateUser([
    'Domain' => '<string>',
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

: Type: string

The domain name of the Active Directory that contains information for the user to associate.

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

The identity provider for the user.

InstanceId

: Required: Yes
: Type: string

The ID of the EC2 instance that provides the user-based subscription.

Tags

: Type: Associative array of custom strings keys (String) to strings

The tags that apply for the user association.

Username

: Required: Yes
: Type: string

The user name from the identity provider.

Result Syntax

[
    'InstanceUserSummary' => [
        'AssociationDate' => '<string>',
        'DisassociationDate' => '<string>',
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'ActiveDirectorySettings' => [
                    'DomainCredentialsProvider' => [
                        'SecretsManagerCredentialsProvider' => [
                            'SecretId' => '<string>',
                        ],
                    ],
                    'DomainIpv4List' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'DomainNetworkSettings' => [
                        'Subnets' => ['<string>', ...],
                    ],
                ],
                'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                'DirectoryId' => '<string>',
            ],
        ],
        'InstanceId' => '<string>',
        'InstanceUserArn' => '<string>',
        'Status' => '<string>',
        'StatusMessage' => '<string>',
        'Username' => '<string>',
    ],
]

Result Details

Members

InstanceUserSummary

: Required: Yes
: Type: InstanceUserSummary structure

Metadata that describes the associate user operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

CreateLicenseServerEndpoint

$result = $client->createLicenseServerEndpoint([/* ... */]);
$promise = $client->createLicenseServerEndpointAsync([/* ... */]);

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

Parameter Syntax

$result = $client->createLicenseServerEndpoint([
    'IdentityProviderArn' => '<string>', // REQUIRED
    'LicenseServerSettings' => [ // REQUIRED
        'ServerSettings' => [ // REQUIRED
            'RdsSalSettings' => [
                'RdsSalCredentialsProvider' => [ // REQUIRED
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
            ],
        ],
        'ServerType' => 'RDS_SAL', // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

IdentityProviderArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that identifies the IdentityProvider resource that contains details about a registered identity provider. In the case of Active Directory, that can be a self-managed Active Directory or an Amazon Web Services Managed Active Directory that contains user identity details.

LicenseServerSettings

: Required: Yes
: Type: LicenseServerSettings structure

The LicenseServerSettings resource to create for the endpoint. The settings include the type of license server and the Secrets Manager secret that enables administrators to add or remove users associated with the license server.

Tags

: Type: Associative array of custom strings keys (String) to strings

The tags that apply for the license server endpoint.

Result Syntax

[
    'IdentityProviderArn' => '<string>',
    'LicenseServerEndpointArn' => '<string>',
]

Result Details

Members

IdentityProviderArn

: Type: string

The Amazon Resource Name (ARN) of the identity provider specified in the request.

LicenseServerEndpointArn

: Type: string

The ARN of the LicenseServerEndpoint resource.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

DeleteLicenseServerEndpoint

$result = $client->deleteLicenseServerEndpoint([/* ... */]);
$promise = $client->deleteLicenseServerEndpointAsync([/* ... */]);

Deletes a LicenseServerEndpoint resource.

Parameter Syntax

$result = $client->deleteLicenseServerEndpoint([
    'LicenseServerEndpointArn' => '<string>', // REQUIRED
    'ServerType' => 'RDS_SAL', // REQUIRED
]);

Parameter Details

Members

LicenseServerEndpointArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint resource to delete.

ServerType

: Required: Yes
: Type: string

The type of License Server that the delete request refers to.

Result Syntax

[
    'LicenseServerEndpoint' => [
        'CreationTime' => <DateTime>,
        'IdentityProviderArn' => '<string>',
        'LicenseServerEndpointArn' => '<string>',
        'LicenseServerEndpointId' => '<string>',
        'LicenseServerEndpointProvisioningStatus' => 'PROVISIONING|PROVISIONING_FAILED|PROVISIONED|DELETING|DELETION_FAILED|DELETED',
        'LicenseServers' => [
            [
                'HealthStatus' => 'HEALTHY|UNHEALTHY|NOT_APPLICABLE',
                'Ipv4Address' => '<string>',
                'ProvisioningStatus' => 'PROVISIONING|PROVISIONING_FAILED|PROVISIONED|DELETING|DELETION_FAILED|DELETED',
            ],
            // ...
        ],
        'ServerEndpoint' => [
            'Endpoint' => '<string>',
        ],
        'ServerType' => 'RDS_SAL',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

LicenseServerEndpoint

: Type: LicenseServerEndpoint structure

Shows details from the LicenseServerEndpoint resource that was deleted.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

DeregisterIdentityProvider

$result = $client->deregisterIdentityProvider([/* ... */]);
$promise = $client->deregisterIdentityProviderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deregisterIdentityProvider([
    'IdentityProvider' => [
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'IdentityProviderArn' => '<string>',
    'Product' => '<string>',
]);

Parameter Details

Members

IdentityProvider

: Type: IdentityProvider structure

An object that specifies details for the Active Directory identity provider.

IdentityProviderArn

: Type: string

The Amazon Resource Name (ARN) that identifies the identity provider to deregister.

Product

: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Result 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>',
    ],
]

Result Details

Members

IdentityProviderSummary

: Required: Yes
: Type: IdentityProviderSummary structure

Metadata that describes the results of an identity provider operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

DisassociateUser

$result = $client->disassociateUser([/* ... */]);
$promise = $client->disassociateUserAsync([/* ... */]);

Disassociates the user from an EC2 instance providing user-based subscriptions.

Parameter Syntax

$result = $client->disassociateUser([
    'Domain' => '<string>',
    'IdentityProvider' => [
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>',
    'InstanceUserArn' => '<string>',
    'Username' => '<string>',
]);

Parameter Details

Members

Domain

: Type: string

The domain name of the Active Directory that contains information for the user to disassociate.

IdentityProvider

: Type: IdentityProvider structure

An object that specifies details for the Active Directory identity provider.

InstanceId

: Type: string

The ID of the EC2 instance which provides user-based subscriptions.

InstanceUserArn

: Type: string

The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.

Username

: Type: string

The user name from the Active Directory identity provider for the user.

Result Syntax

[
    'InstanceUserSummary' => [
        'AssociationDate' => '<string>',
        'DisassociationDate' => '<string>',
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'ActiveDirectorySettings' => [
                    'DomainCredentialsProvider' => [
                        'SecretsManagerCredentialsProvider' => [
                            'SecretId' => '<string>',
                        ],
                    ],
                    'DomainIpv4List' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'DomainNetworkSettings' => [
                        'Subnets' => ['<string>', ...],
                    ],
                ],
                'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                'DirectoryId' => '<string>',
            ],
        ],
        'InstanceId' => '<string>',
        'InstanceUserArn' => '<string>',
        'Status' => '<string>',
        'StatusMessage' => '<string>',
        'Username' => '<string>',
    ],
]

Result Details

Members

InstanceUserSummary

: Required: Yes
: Type: InstanceUserSummary structure

Metadata that describes the associate user operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

ListIdentityProviders

$result = $client->listIdentityProviders([/* ... */]);
$promise = $client->listIdentityProvidersAsync([/* ... */]);

Lists the Active Directory identity providers for user-based subscriptions.

Parameter Syntax

$result = $client->listIdentityProviders([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operation' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

You can use the following filters to streamline results:

Product
DirectoryId

MaxResults

: Type: int

The maximum number of results to return from a single request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result Syntax

[
    'IdentityProviderSummaries' => [
        [
            '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>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

IdentityProviderSummaries

: Required: Yes
: Type: Array of IdentityProviderSummary structures

An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.

NextToken

: Type: string

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

Lists the EC2 instances providing user-based subscriptions.

Parameter Syntax

$result = $client->listInstances([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operation' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

You can use the following filters to streamline results:

Status
InstanceId

MaxResults

: Type: int

The maximum number of results to return from a single request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result Syntax

[
    'InstanceSummaries' => [
        [
            'InstanceId' => '<string>',
            'LastStatusCheckDate' => '<string>',
            'Products' => ['<string>', ...],
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstanceSummaries

: Type: Array of InstanceSummary structures

An array of InstanceSummary resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.

NextToken

: Type: string

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

ListLicenseServerEndpoints

$result = $client->listLicenseServerEndpoints([/* ... */]);
$promise = $client->listLicenseServerEndpointsAsync([/* ... */]);

List the Remote Desktop Services (RDS) License Server endpoints

Parameter Syntax

$result = $client->listLicenseServerEndpoints([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operation' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

You can use the following filters to streamline results:

IdentityProviderArn

MaxResults

: Type: int

The maximum number of results to return from a single request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result Syntax

[
    'LicenseServerEndpoints' => [
        [
            'CreationTime' => <DateTime>,
            'IdentityProviderArn' => '<string>',
            'LicenseServerEndpointArn' => '<string>',
            'LicenseServerEndpointId' => '<string>',
            'LicenseServerEndpointProvisioningStatus' => 'PROVISIONING|PROVISIONING_FAILED|PROVISIONED|DELETING|DELETION_FAILED|DELETED',
            'LicenseServers' => [
                [
                    'HealthStatus' => 'HEALTHY|UNHEALTHY|NOT_APPLICABLE',
                    'Ipv4Address' => '<string>',
                    'ProvisioningStatus' => 'PROVISIONING|PROVISIONING_FAILED|PROVISIONED|DELETING|DELETION_FAILED|DELETED',
                ],
                // ...
            ],
            'ServerEndpoint' => [
                'Endpoint' => '<string>',
            ],
            'ServerType' => 'RDS_SAL',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

LicenseServerEndpoints

: Type: Array of LicenseServerEndpoint structures

An array of LicenseServerEndpoint resources that contain detailed information about the RDS License Servers that meet the request criteria.

NextToken

: Type: string

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
AccessDeniedException:: You don't have sufficient access to perform this action.

ListProductSubscriptions

$result = $client->listProductSubscriptions([/* ... */]);
$promise = $client->listProductSubscriptionsAsync([/* ... */]);

Lists the user-based subscription products available from an identity provider.

Parameter Syntax

$result = $client->listProductSubscriptions([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operation' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Product' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

You can use the following filters to streamline results:

Status
Username
Domain

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

An object that specifies details for the identity provider.

MaxResults

: Type: int

The maximum number of results to return from a single request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Product

: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Result Syntax

[
    'NextToken' => '<string>',
    'ProductUserSummaries' => [
        [
            'Domain' => '<string>',
            'IdentityProvider' => [
                'ActiveDirectoryIdentityProvider' => [
                    'ActiveDirectorySettings' => [
                        'DomainCredentialsProvider' => [
                            'SecretsManagerCredentialsProvider' => [
                                'SecretId' => '<string>',
                            ],
                        ],
                        'DomainIpv4List' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'DomainNetworkSettings' => [
                            'Subnets' => ['<string>', ...],
                        ],
                    ],
                    'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                    'DirectoryId' => '<string>',
                ],
            ],
            'Product' => '<string>',
            'ProductUserArn' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
            'SubscriptionEndDate' => '<string>',
            'SubscriptionStartDate' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

ProductUserSummaries

: Type: Array of ProductUserSummary structures

Metadata that describes the list product subscriptions operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns the list of tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (String) to strings

The tags for the specified resource.

Errors

ValidationException:: A parameter is not valid.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.

ListUserAssociations

$result = $client->listUserAssociations([/* ... */]);
$promise = $client->listUserAssociationsAsync([/* ... */]);

Lists user associations for an identity provider.

Parameter Syntax

$result = $client->listUserAssociations([
    'Filters' => [
        [
            'Attribute' => '<string>',
            'Operation' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

You can use the following filters to streamline results:

Status
Username
Domain

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

An object that specifies details for the identity provider.

InstanceId

: Required: Yes
: Type: string

The ID of the EC2 instance, which provides user-based subscriptions.

MaxResults

: Type: int

The maximum number of results to return from a single request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result Syntax

[
    'InstanceUserSummaries' => [
        [
            'AssociationDate' => '<string>',
            'DisassociationDate' => '<string>',
            'Domain' => '<string>',
            'IdentityProvider' => [
                'ActiveDirectoryIdentityProvider' => [
                    'ActiveDirectorySettings' => [
                        'DomainCredentialsProvider' => [
                            'SecretsManagerCredentialsProvider' => [
                                'SecretId' => '<string>',
                            ],
                        ],
                        'DomainIpv4List' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'DomainNetworkSettings' => [
                            'Subnets' => ['<string>', ...],
                        ],
                    ],
                    'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                    'DirectoryId' => '<string>',
                ],
            ],
            'InstanceId' => '<string>',
            'InstanceUserArn' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InstanceUserSummaries

: Type: Array of InstanceUserSummary structures

Metadata that describes the list user association operation.

NextToken

: Type: string

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

RegisterIdentityProvider

$result = $client->registerIdentityProvider([/* ... */]);
$promise = $client->registerIdentityProviderAsync([/* ... */]);

Registers an identity provider for user-based subscriptions.

Parameter Syntax

$result = $client->registerIdentityProvider([
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'Settings' => [
        'SecurityGroupId' => '<string>', // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

An object that specifies details for the identity provider to register.

Product

: Required: Yes
: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Settings

: Type: Settings structure

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

Tags

: Type: Associative array of custom strings keys (String) to strings

The tags that apply to the identity provider's registration.

Result 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>',
    ],
]

Result Details

Members

IdentityProviderSummary

: Required: Yes
: Type: IdentityProviderSummary structure

Metadata that describes the results of an identity provider operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

StartProductSubscription

$result = $client->startProductSubscription([/* ... */]);
$promise = $client->startProductSubscriptionAsync([/* ... */]);

Starts a product subscription for a user with the specified identity provider.

Parameter Syntax

$result = $client->startProductSubscription([
    'Domain' => '<string>',
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

: Type: string

The domain name of the Active Directory that contains the user for whom to start the product subscription.

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

An object that specifies details for the identity provider.

Product

: Required: Yes
: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Tags

: Type: Associative array of custom strings keys (String) to strings

The tags that apply to the product subscription.

Username

: Required: Yes
: Type: string

The user name from the identity provider of the user.

Result Syntax

[
    'ProductUserSummary' => [
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'ActiveDirectorySettings' => [
                    'DomainCredentialsProvider' => [
                        'SecretsManagerCredentialsProvider' => [
                            'SecretId' => '<string>',
                        ],
                    ],
                    'DomainIpv4List' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'DomainNetworkSettings' => [
                        'Subnets' => ['<string>', ...],
                    ],
                ],
                'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                'DirectoryId' => '<string>',
            ],
        ],
        'Product' => '<string>',
        'ProductUserArn' => '<string>',
        'Status' => '<string>',
        'StatusMessage' => '<string>',
        'SubscriptionEndDate' => '<string>',
        'SubscriptionStartDate' => '<string>',
        'Username' => '<string>',
    ],
]

Result Details

Members

ProductUserSummary

: Required: Yes
: Type: ProductUserSummary structure

Metadata that describes the start product subscription operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

StopProductSubscription

$result = $client->stopProductSubscription([/* ... */]);
$promise = $client->stopProductSubscriptionAsync([/* ... */]);

Stops a product subscription for a user with the specified identity provider.

Parameter Syntax

$result = $client->stopProductSubscription([
    'Domain' => '<string>',
    'IdentityProvider' => [
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>',
    'ProductUserArn' => '<string>',
    'Username' => '<string>',
]);

Parameter Details

Members

Domain

: Type: string

The domain name of the Active Directory that contains the user for whom to stop the product subscription.

IdentityProvider

: Type: IdentityProvider structure

An object that specifies details for the identity provider.

Product

: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

ProductUserArn

: Type: string

The Amazon Resource Name (ARN) of the product user.

Username

: Type: string

The user name from the identity provider for the user.

Result Syntax

[
    'ProductUserSummary' => [
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'ActiveDirectorySettings' => [
                    'DomainCredentialsProvider' => [
                        'SecretsManagerCredentialsProvider' => [
                            'SecretId' => '<string>',
                        ],
                    ],
                    'DomainIpv4List' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'DomainNetworkSettings' => [
                        'Subnets' => ['<string>', ...],
                    ],
                ],
                'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
                'DirectoryId' => '<string>',
            ],
        ],
        'Product' => '<string>',
        'ProductUserArn' => '<string>',
        'Status' => '<string>',
        'StatusMessage' => '<string>',
        'SubscriptionEndDate' => '<string>',
        'SubscriptionStartDate' => '<string>',
        'Username' => '<string>',
    ],
]

Result Details

Members

ProductUserSummary

: Required: Yes
: Type: ProductUserSummary structure

Metadata that describes the start product subscription operation.

Errors

ServiceQuotaExceededException:: The request failed because a service quota is exceeded.
ConflictException:: The request couldn't be completed because it conflicted with the current state of the resource.
ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.
AccessDeniedException:: You don't have sufficient access to perform this action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you want to tag.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

The tags to apply to the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: A parameter is not valid.
InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

TagKeys

: Required: Yes
: Type: Array of strings

The tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: The resource couldn't be found.

UpdateIdentityProviderSettings

$result = $client->updateIdentityProviderSettings([/* ... */]);
$promise = $client->updateIdentityProviderSettingsAsync([/* ... */]);

Updates additional product configuration settings for the registered identity provider.

Parameter Syntax

$result = $client->updateIdentityProviderSettings([
    'IdentityProvider' => [
        'ActiveDirectoryIdentityProvider' => [
            'ActiveDirectorySettings' => [
                'DomainCredentialsProvider' => [
                    'SecretsManagerCredentialsProvider' => [
                        'SecretId' => '<string>',
                    ],
                ],
                'DomainIpv4List' => ['<string>', ...],
                'DomainName' => '<string>',
                'DomainNetworkSettings' => [
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'ActiveDirectoryType' => 'SELF_MANAGED|AWS_MANAGED',
            'DirectoryId' => '<string>',
        ],
    ],
    'IdentityProviderArn' => '<string>',
    'Product' => '<string>',
    'UpdateSettings' => [ // REQUIRED
        'AddSubnets' => ['<string>', ...], // REQUIRED
        'RemoveSubnets' => ['<string>', ...], // REQUIRED
        'SecurityGroupId' => '<string>',
    ],
]);

Parameter Details

Members

IdentityProvider

: Type: IdentityProvider structure

Refers to an identity provider.

IdentityProviderArn

: Type: string

The Amazon Resource Name (ARN) of the identity provider to update.

Product

: Type: string

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

UpdateSettings

: Required: Yes
: Type: UpdateSettings structure

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.

Result 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>',
    ],
]

Result Details

Members

IdentityProviderSummary

: Required: Yes
: Type: IdentityProviderSummary structure

Describes an identity provider.

Errors

ValidationException:: A parameter is not valid.
ThrottlingException:: The request was denied because of request throttling. Retry the request.
InternalServerException:: An exception occurred with the service.
AccessDeniedException:: You don't have sufficient access to perform this action.

Shapes

AccessDeniedException

Description

You don't have sufficient access to perform this action.

Members

message

: Type: string

ActiveDirectoryIdentityProvider

Description

Details about an Active Directory identity provider.

Members

ActiveDirectorySettings

: Type: ActiveDirectorySettings structure

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.

ActiveDirectoryType

: Type: string

The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.

DirectoryId

: Type: string

The directory ID for an Active Directory identity provider.

ActiveDirectorySettings

Description

Contains network access and credential details that are needed for user administration in the Active Directory.

Members

DomainCredentialsProvider

: Type: CredentialsProvider structure

Points to the CredentialsProvider resource that contains information about the credential provider for user administration.

DomainIpv4List

: Type: Array of strings

A list of domain IPv4 addresses that are used for the Active Directory.

DomainName

: Type: string

The domain name for the Active Directory.

DomainNetworkSettings

: Type: DomainNetworkSettings structure

The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.

ConflictException

Description

The request couldn't be completed because it conflicted with the current state of the resource.

Members

message

: Type: string

CredentialsProvider

Description

Contains information about the credential provider for user administration.

Members

SecretsManagerCredentialsProvider

: Type: SecretsManagerCredentialsProvider structure

Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

DomainNetworkSettings

Description

Contains network settings for the Active Directory domain.

Members

Subnets

: Required: Yes
: Type: Array of strings

Contains a list of subnets that apply for the Active Directory domain.

Filter

Description

A filter name and value pair that is used to return more specific results from a describe or list operation. You can use filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Members

Attribute

: Type: string

The name of an attribute to use as a filter.

Operation

: Type: string

The type of search (For example, eq, geq, leq)

Value

: Type: string

Value of the filter.

IdentityProvider

Description

Refers to an identity provider.

Members

ActiveDirectoryIdentityProvider

: Type: ActiveDirectoryIdentityProvider structure

The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.

IdentityProviderSummary

Description

Describes an identity provider.

Members

FailureMessage

: Type: string

The failure message associated with an identity provider.

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

The IdentityProvider resource contains information about an identity provider.

IdentityProviderArn

: Type: string

The Amazon Resource Name (ARN) of the identity provider.

Product

: Required: Yes
: Type: string

The name of the user-based subscription product.

Settings

: Required: Yes
: Type: Settings structure

The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.

Status

: Required: Yes
: Type: string

The status of the identity provider.

InstanceSummary

Description

Describes an EC2 instance providing user-based subscriptions.

Members

InstanceId

: Required: Yes
: Type: string

The ID of the EC2 instance, which provides user-based subscriptions.

LastStatusCheckDate

: Type: string

The date of the last status check.

Products

: Required: Yes
: Type: Array of strings

A list of provided user-based subscription products.

Status

: Required: Yes
: Type: string

The status of an EC2 instance resource.

StatusMessage

: Type: string

The status message for an EC2 instance.

InstanceUserSummary

Description

Describes users of an EC2 instance providing user-based subscriptions.

Members

AssociationDate

: Type: string

The date a user was associated with an EC2 instance.

DisassociationDate

: Type: string

The date a user was disassociated from an EC2 instance.

Domain

: Type: string

The domain name of the Active Directory that contains the user information for the product subscription.

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

The IdentityProvider resource specifies details about the identity provider.

InstanceId

: Required: Yes
: Type: string

The ID of the EC2 instance that provides user-based subscriptions.

InstanceUserArn

: Type: string

The Amazon Resource Name (ARN) that identifies the instance user.

Status

: Required: Yes
: Type: string

The status of a user associated with an EC2 instance.

StatusMessage

: Type: string

The status message for users of an EC2 instance.

Username

: Required: Yes
: Type: string

The user name from the identity provider for the user.

InternalServerException

Description

An exception occurred with the service.

Members

message

: Type: string

LicenseServer

Description

Information about a Remote Desktop Services (RDS) license server.

Members

HealthStatus

: Type: string

The health status of the RDS license server.

Ipv4Address

: Type: string

A list of domain IPv4 addresses that are used for the RDS license server.

ProvisioningStatus

: Type: string

The current state of the provisioning process for the RDS license server.

LicenseServerEndpoint

Description

Contains details about a network endpoint for a Remote Desktop Services (RDS) license server.

Members

CreationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when License Manager created the license server endpoint.

IdentityProviderArn

: Type: string

The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint.

LicenseServerEndpointArn

: Type: string

The ARN of the ServerEndpoint resource for the RDS license server.

LicenseServerEndpointId

: Type: string

The ID of the license server endpoint.

LicenseServerEndpointProvisioningStatus

: Type: string

The current state of the provisioning process for the RDS license server endpoint

LicenseServers

: Type: Array of LicenseServer structures

An array of LicenseServer resources that represent the license servers that are accessed through this endpoint.

ServerEndpoint

: Type: ServerEndpoint structure

The ServerEndpoint resource contains the network address of the RDS license server endpoint.

ServerType

: Type: string

The type of license server.

StatusMessage

: Type: string

The message associated with the provisioning status, if there is one.

LicenseServerSettings

Description

The settings to configure your license server.

Members

ServerSettings

: Required: Yes
: Type: ServerSettings structure

The ServerSettings resource contains the settings for your server.

ServerType

: Required: Yes
: Type: string

The type of license server.

ProductUserSummary

Description

A summary of the user-based subscription products for a specific user.

Members

Domain

: Type: string

The domain name of the Active Directory that contains the user information for the product subscription.

IdentityProvider

: Required: Yes
: Type: IdentityProvider structure

An object that specifies details for the identity provider.

Product

: Required: Yes
: Type: string

The name of the user-based subscription product.

ProductUserArn

: Type: string

The Amazon Resource Name (ARN) for this product user.

Status

: Required: Yes
: Type: string

The status of a product for this user.

StatusMessage

: Type: string

The status message for a product for this user.

SubscriptionEndDate

: Type: string

The end date of a subscription.

SubscriptionStartDate

: Type: string

The start date of a subscription.

Username

: Required: Yes
: Type: string

The user name from the identity provider for this product user.

RdsSalSettings

Description

Server settings that are specific to a Remote Desktop Services (RDS) license server.

Members

RdsSalCredentialsProvider

: Required: Yes
: Type: CredentialsProvider structure

The CredentialsProvider resource contains a reference to the credentials provider that's used for RDS license server user administration.

ResourceNotFoundException

Description

The resource couldn't be found.

Members

message

: Type: string

SecretsManagerCredentialsProvider

Description

Contains a credentials secret that's stored in Secrets Manager.

Members

SecretId

: Type: string

The ID of the Secrets Manager secret that contains credentials.

ServerEndpoint

Description

A network endpoint through which you can access one or more servers.

Members

Endpoint

: Type: string

The network address of the endpoint.

ServerSettings

Description

Contains settings for a specific server.

Members

RdsSalSettings

: Type: RdsSalSettings structure

The RdsSalSettings resource contains settings to configure a specific Remote Desktop Services (RDS) license server.

ServiceQuotaExceededException

Description

The request failed because a service quota is exceeded.

Members

message

: Type: string

Settings

Description

The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.

Members

SecurityGroupId

: Required: Yes
: Type: 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

: Required: Yes
: Type: Array of strings

The subnets defined for the registered identity provider.

ThrottlingException

Description

The request was denied because of request throttling. Retry the request.

Members

message

: Type: string

UpdateSettings

Description

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

Members

AddSubnets

: Required: Yes
: Type: Array of strings

The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.

RemoveSubnets

: Required: Yes
: Type: Array of strings

The ID of one or more subnets to remove.

SecurityGroupId

: Type: string

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

ValidationException

Description

A parameter is not valid.

Members

message

: Type: string

AWS License Manager User Subscriptions 2018-05-10

Operation Summary

Paginators

Operations

AssociateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLicenseServerEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteLicenseServerEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeregisterIdentityProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListIdentityProviders

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListInstances

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListLicenseServerEndpoints

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListProductSubscriptions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members