describe_entitlements `async` ¶

describe_entitlements(
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    name: Optional[Name] = None,
    stack_name: Optional[Name] = None,
    next_token: Optional[String] = None,
    max_results: Optional[Integer] = None,
) -> DescribeEntitlementsResult

Retrieves a list that describes one of more entitlements.

Parameters:

name (Optional[Name], default: None ) –

The name of the entitlement.
stack_name (Optional[Name], default: None ) –

The name of the stack with which the entitlement is associated.
next_token (Optional[String], default: None ) –

The pagination token used to retrieve the next page of results for this operation.
max_results (Optional[Integer], default: None ) –

The maximum size of each page of results.

Raises:

EntitlementNotFoundException –

The entitlement can't be found.
OperationNotPermittedException –

The attempted operation is not permitted.
ResourceNotFoundException –

The specified resource was not found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_appstream/_services/async_app_stream.py

async def describe_entitlements(
    self,
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.name.Name"] = None,
    stack_name: Optional["capo_appstream.types.name.Name"] = None,
    next_token: Optional["capo_appstream.types.string.String"] = None,
    max_results: Optional["capo_appstream.types.integer.Integer"] = None,
) -> "capo_appstream.types.describe_entitlements_result.DescribeEntitlementsResult":
    """<p>Retrieves a list that describes one of more entitlements.</p>

    Args:
        name: <p>The name of the entitlement.</p>
        stack_name: <p>The name of the stack with which the entitlement is associated.</p>
        next_token: <p>The pagination token used to retrieve the next page of results for this operation.</p>
        max_results: <p>The maximum size of each page of results.</p>

    Raises:
        capo_appstream.errors.entitlement_not_found_exception.EntitlementNotFoundException: <p>The entitlement can't be found.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appstream.types.describe_entitlements_request.DescribeEntitlementsRequest]",
    ) -> AsyncOperationResponse[
        "capo_appstream.types.describe_entitlements_result.DescribeEntitlementsResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.describe_entitlements

        (
            output,
            http_response,
        ) = await capo_appstream._operations.photon_admin_proxy_service.describe_entitlements.async_describe_entitlements(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEntitlements")
    )
    input_: capo_appstream.types.describe_entitlements_request.DescribeEntitlementsRequest = {}
    if name is not None:
        input_["name"] = name
    if stack_name is not None:
        input_["stack_name"] = stack_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_entitlements async ¶

describe_entitlements `async` ¶