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.
DeregisterIdentityProvider ( array $params = [] ): Deregisters the identity provider from providing user-based subscriptions.
DisassociateUser ( array $params = [] ): Disassociates the user from an EC2 instance providing user-based subscriptions.
ListIdentityProviders ( array $params = [] ): Lists the identity providers for user-based subscriptions.
ListInstances ( array $params = [] ): Lists the EC2 instances providing user-based subscriptions.
ListProductSubscriptions ( array $params = [] ): Lists the user-based subscription products available from an identity provider.
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.
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
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' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Type: string

The domain name of the user.

IdentityProvider

Required: Yes
Type: IdentityProvider structure

The identity provider of the user.

InstanceId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name from the identity provider for the user.

Result Syntax

[
    'InstanceUserSummary' => [
        'AssociationDate' => '<string>',
        'DisassociationDate' => '<string>',
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<string>',
            ],
        ],
        'InstanceId' => '<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.

DeregisterIdentityProvider

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

Deregisters the identity provider from providing user-based subscriptions.

Parameter Syntax

$result = $client->deregisterIdentityProvider([
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
]);

Parameter Details

Members

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.

Result Syntax

[
    'IdentityProviderSummary' => [
        'FailureMessage' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<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' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Type: string

The domain name of the user.

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.

Username

Required: Yes
Type: string

The user name from the identity provider for the user.

Result Syntax

[
    'InstanceUserSummary' => [
        'AssociationDate' => '<string>',
        'DisassociationDate' => '<string>',
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<string>',
            ],
        ],
        'InstanceId' => '<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 identity providers for user-based subscriptions.

Parameter Syntax

$result = $client->listIdentityProviders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Maximum number of results to return in a single call.

NextToken

Type: string

Token for the next set of results.

Result Syntax

[
    'IdentityProviderSummaries' => [
        [
            'FailureMessage' => '<string>',
            'IdentityProvider' => [
                'ActiveDirectoryIdentityProvider' => [
                    'DirectoryId' => '<string>',
                ],
            ],
            'Product' => '<string>',
            'Settings' => [
                'SecurityGroupId' => '<string>',
                'Subnets' => ['<string>', ...],
            ],
            'Status' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

IdentityProviderSummaries

Required: Yes
Type: Array of IdentityProviderSummary structures

Metadata that describes the list identity providers operation.

NextToken

Type: string

Token for the next set of results.

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

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

MaxResults

Type: int

Maximum number of results to return in a single call.

NextToken

Type: string

Token for the next set of results.

Result Syntax

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

Result Details

Members

InstanceSummaries

Type: Array of InstanceSummary structures

Metadata that describes the list instances operation.

NextToken

Type: string

Token for the next set of results.

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.

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' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Product' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

IdentityProvider

Required: Yes
Type: IdentityProvider structure

An object that specifies details for the identity provider.

MaxResults

Type: int

Maximum number of results to return in a single call.

NextToken

Type: string

Token for the next set of results.

Product

Required: Yes
Type: string

The name of the user-based subscription product.

Result Syntax

[
    'NextToken' => '<string>',
    'ProductUserSummaries' => [
        [
            'Domain' => '<string>',
            'IdentityProvider' => [
                'ActiveDirectoryIdentityProvider' => [
                    'DirectoryId' => '<string>',
                ],
            ],
            'Product' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
            'SubscriptionEndDate' => '<string>',
            'SubscriptionStartDate' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Token for the next set of results.

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.

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' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

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

Maximum number of results to return in a single call.

NextToken

Type: string

Token for the next set of results.

Result Syntax

[
    'InstanceUserSummaries' => [
        [
            'AssociationDate' => '<string>',
            'DisassociationDate' => '<string>',
            'Domain' => '<string>',
            'IdentityProvider' => [
                'ActiveDirectoryIdentityProvider' => [
                    'DirectoryId' => '<string>',
                ],
            ],
            'InstanceId' => '<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

Token for the next set of results.

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' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'Settings' => [
        'SecurityGroupId' => '<string>', // REQUIRED
        'Subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members

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.

Settings

Type: Settings structure

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

Result Syntax

[
    'IdentityProviderSummary' => [
        'FailureMessage' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<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' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Type: string

The domain name of the user.

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.

Username

Required: Yes
Type: string

The user name from the identity provider of the user.

Result Syntax

[
    'ProductUserSummary' => [
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<string>',
            ],
        ],
        'Product' => '<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' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Type: string

The domain name of the user.

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.

Username

Required: Yes
Type: string

The user name from the identity provider for the user.

Result Syntax

[
    'ProductUserSummary' => [
        'Domain' => '<string>',
        'IdentityProvider' => [
            'ActiveDirectoryIdentityProvider' => [
                'DirectoryId' => '<string>',
            ],
        ],
        'Product' => '<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.

UpdateIdentityProviderSettings

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

Updates additional product configuration settings for the registered identity provider.

Parameter Syntax

$result = $client->updateIdentityProviderSettings([
    'IdentityProvider' => [ // REQUIRED
        'ActiveDirectoryIdentityProvider' => [
            'DirectoryId' => '<string>',
        ],
    ],
    'Product' => '<string>', // REQUIRED
    'UpdateSettings' => [ // REQUIRED
        'AddSubnets' => ['<string>', ...], // REQUIRED
        'RemoveSubnets' => ['<string>', ...], // REQUIRED
        'SecurityGroupId' => '<string>',
    ],
]);

Parameter Details

Members

IdentityProvider

Required: Yes
Type: IdentityProvider structure

Details about an identity provider.

Product

Required: Yes
Type: string

The name of the user-based subscription product.

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' => [
                'DirectoryId' => '<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

DirectoryId

Type: string

The directory ID for an Active Directory identity provider.

ConflictException

Description

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

Members

message

Type: string

Filter

Description

A filter name and value pair that is used to return more specific results from a describe operation. 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

Details about an identity provider.

Members

ActiveDirectoryIdentityProvider

Type: ActiveDirectoryIdentityProvider structure

An object that details an 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

An object that specifies details for the identity provider.

Product

Required: Yes
Type: string

The name of the user-based subscription product.

Settings

Required: Yes
Type: Settings structure

An object that details 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 an 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 user.

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.

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

ProductUserSummary

Description

The summary of the user-based subscription products for a user.

Members

Domain

Type: string

The domain name of the user.

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.

Status

Required: Yes
Type: string

The status of a product for a user.

StatusMessage

Type: string

The status message for a product for a 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 of the user.

ResourceNotFoundException

Description

The resource couldn't be found.

Members

message

Type: string

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

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

ListProductSubscriptions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListUserAssociations

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

RegisterIdentityProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartProductSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StopProductSubscription

Parameter Syntax

Parameter Details

Members