Skip to content

list_authentication_profiles async

list_authentication_profiles(
    instance_id: InstanceId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    max_results: Optional[MaxResult1000] = None,
    next_token: Optional[NextToken] = None,
) -> ListAuthenticationProfilesResponse

This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.

Provides summary information about the authentication profiles in a specified Connect Customer instance.

Parameters:

  • instance_id (InstanceId) –

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • max_results (Optional[MaxResult1000], default: None ) –

    The maximum number of results to return per page.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_authentication_profiles(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    max_results: Optional["capo_connect.types.max_result1000.MaxResult1000"] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
) -> "capo_connect.types.list_authentication_profiles_response.ListAuthenticationProfilesResponse":
    """<p>This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>Provides summary information about the authentication profiles in a specified Connect Customer instance.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.list_authentication_profiles_request.ListAuthenticationProfilesRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_authentication_profiles_response.ListAuthenticationProfilesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_authentication_profiles

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.list_authentication_profiles.async_list_authentication_profiles(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAuthenticationProfiles")
    )
    input_: capo_connect.types.list_authentication_profiles_request.ListAuthenticationProfilesRequest = {
        "instance_id": instance_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    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