Skip to content

list_entity_security_profiles async

list_entity_security_profiles(
    instance_id: InstanceId,
    entity_type: EntityType,
    entity_arn: EntityArn,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    next_token: Optional[NextToken2500] = None,
    max_results: Optional[MaxResult100] = None,
) -> ListEntitySecurityProfilesResponse

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

Parameters:

  • instance_id (InstanceId) –

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

  • entity_type (EntityType) –

    Only supported type is AI_AGENT.

  • entity_arn (EntityArn) –

    ARN of a Q in Connect AI Agent.

  • next_token (Optional[NextToken2500], 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.

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

    The maximum number of results to return per page. The default MaxResult size is 100.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_entity_security_profiles(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    entity_type: "capo_connect.types.entity_type.EntityType",
    entity_arn: "capo_connect.types.entity_arn.EntityArn",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token2500.NextToken2500"] = None,
    max_results: Optional["capo_connect.types.max_result100.MaxResult100"] = None,
) -> "capo_connect.types.list_entity_security_profiles_response.ListEntitySecurityProfilesResponse":
    """<p> Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance. </p>

    Args:
        instance_id: <p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. </p>
        entity_type: <p> Only supported type is AI_AGENT. </p>
        entity_arn: <p> ARN of a Q in Connect AI Agent. </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>
        max_results: <p> The maximum number of results to return per page. The default MaxResult size is 100. </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_entity_security_profiles_request.ListEntitySecurityProfilesRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_entity_security_profiles_response.ListEntitySecurityProfilesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_entity_security_profiles

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEntitySecurityProfiles")
    )
    input_: capo_connect.types.list_entity_security_profiles_request.ListEntitySecurityProfilesRequest = {
        "instance_id": instance_id,
        "entity_type": entity_type,
        "entity_arn": entity_arn,
    }
    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