Skip to content

associate_security_profiles async

associate_security_profiles(
    instance_id: InstanceId,
    security_profiles: SecurityProfiles,
    entity_type: EntityType,
    entity_arn: EntityArn,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> None

Associate security profiles with an 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.

  • security_profiles (SecurityProfiles) –

    List of Security Profile Object.

  • entity_type (EntityType) –

    Only supported type is AI_AGENT.

  • entity_arn (EntityArn) –

    Arn of a Q in Connect AI Agent.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def associate_security_profiles(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    security_profiles: "capo_connect.types.security_profiles.SecurityProfiles",
    entity_type: "capo_connect.types.entity_type.EntityType",
    entity_arn: "capo_connect.types.entity_arn.EntityArn",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> None:
    """<p> Associate security profiles with an 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>
        security_profiles: <p> List of Security Profile Object. </p>
        entity_type: <p> Only supported type is AI_AGENT. </p>
        entity_arn: <p> Arn of a Q in Connect AI Agent. </p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.conditional_operation_failed_exception.ConditionalOperationFailedException: <p>Request processing failed because dependent condition failed.</p>
        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_conflict_exception.ResourceConflictException: <p>A resource already has that name.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.associate_security_profiles_request.AssociateSecurityProfilesRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.associate_security_profiles

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateSecurityProfiles")
    )
    input_: capo_connect.types.associate_security_profiles_request.AssociateSecurityProfilesRequest = {
        "instance_id": instance_id,
        "security_profiles": security_profiles,
        "entity_type": entity_type,
        "entity_arn": entity_arn,
    }

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