Lists the user-based subscription products available from an identity provider.
Parameters:
-
product
(Optional[str], default:
None
)
–
The name of the user-based subscription product.
Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | OFFICE_STANDARD | REMOTE_DESKTOP_SERVICES
-
identity_provider
(IdentityProvider)
–
An object that specifies details for the identity provider.
-
max_results
(Optional[BoxInteger], default:
None
)
–
The maximum number of results to return from a single request.
-
filters
(Optional[FilterList], default:
None
)
–
You can use the following filters to streamline results:
-
next_token
(Optional[str], default:
None
)
–
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
Raises:
Source code in docs_src/capo_license_manager_user_subscriptions/_services/async_license_manager_user_subscriptions.py
| async def list_product_subscriptions(
self,
identity_provider: "capo_license_manager_user_subscriptions.types.identity_provider.IdentityProvider",
*,
config_overrides: Optional[
AsyncLicenseManagerUserSubscriptionsClientConfig
] = None,
product: Optional[str] = None,
max_results: Optional[
"capo_license_manager_user_subscriptions.types.box_integer.BoxInteger"
] = None,
filters: Optional[
"capo_license_manager_user_subscriptions.types.filter_list.FilterList"
] = None,
next_token: Optional[str] = None,
) -> "capo_license_manager_user_subscriptions.types.list_product_subscriptions_response.ListProductSubscriptionsResponse":
"""<p>Lists the user-based subscription products available from an identity provider.</p>
Args:
product: <p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>OFFICE_STANDARD</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>
identity_provider: <p>An object that specifies details for the identity provider.</p>
max_results: <p>The maximum number of results to return from a single request.</p>
filters: <p>You can use the following filters to streamline results:</p> <ul> <li> <p>Status</p> </li> <li> <p>Username</p> </li> <li> <p>Domain</p> </li> </ul>
next_token: <p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p>
Raises:
capo_license_manager_user_subscriptions.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
capo_license_manager_user_subscriptions.errors.conflict_exception.ConflictException: <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
capo_license_manager_user_subscriptions.errors.internal_server_exception.InternalServerException: <p>An exception occurred with the service.</p>
capo_license_manager_user_subscriptions.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found.</p>
capo_license_manager_user_subscriptions.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request failed because a service quota is exceeded.</p>
capo_license_manager_user_subscriptions.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Retry the request.</p>
capo_license_manager_user_subscriptions.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
capo_license_manager_user_subscriptions.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_license_manager_user_subscriptions.types.list_product_subscriptions_request.ListProductSubscriptionsRequest]",
) -> AsyncOperationResponse[
"capo_license_manager_user_subscriptions.types.list_product_subscriptions_response.ListProductSubscriptionsResponse"
]:
import capo_license_manager_user_subscriptions._operations.license_manager_user_subscriptions.list_product_subscriptions
(
output,
http_response,
) = await capo_license_manager_user_subscriptions._operations.license_manager_user_subscriptions.list_product_subscriptions.async_list_product_subscriptions(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListProductSubscriptions")
)
input_: capo_license_manager_user_subscriptions.types.list_product_subscriptions_request.ListProductSubscriptionsRequest = {
"identity_provider": identity_provider
}
if product is not None:
input_["product"] = product
if max_results is not None:
input_["max_results"] = max_results
if filters is not None:
input_["filters"] = filters
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|