Skip to content

describe_authentication_profile

describe_authentication_profile(
    authentication_profile_id: AuthenticationProfileId,
    instance_id: InstanceId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> DescribeAuthenticationProfileResponse

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.

Describes the target authentication profile.

Parameters:

  • authentication_profile_id (AuthenticationProfileId) –

    A unique identifier for the authentication profile.

  • 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.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def describe_authentication_profile(
    self,
    authentication_profile_id: "capo_connect.types.authentication_profile_id.AuthenticationProfileId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.describe_authentication_profile_response.DescribeAuthenticationProfileResponse":
    """<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>Describes the target authentication profile.</p>

    Args:
        authentication_profile_id: <p>A unique identifier for the authentication profile. </p>
        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>

    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.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.describe_authentication_profile_request.DescribeAuthenticationProfileRequest]",
    ) -> OperationResponse[
        "capo_connect.types.describe_authentication_profile_response.DescribeAuthenticationProfileResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_authentication_profile

        output, http_response = (
            capo_connect._operations.amazon_connect_service.describe_authentication_profile.describe_authentication_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAuthenticationProfile")
    )
    input_: capo_connect.types.describe_authentication_profile_request.DescribeAuthenticationProfileRequest = {
        "authentication_profile_id": authentication_profile_id,
        "instance_id": instance_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output