Skip to content

describe_attached_files_configuration async

describe_attached_files_configuration(
    instance_id: InstanceId,
    attachment_scope: AttachmentScope,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> DescribeAttachedFilesConfigurationResponse

Describes the attached files configuration for the specified Connect Customer instance and attachment scope.

If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.

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.

  • attachment_scope (AttachmentScope) –

    The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def describe_attached_files_configuration(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    attachment_scope: "capo_connect.types.attachment_scope.AttachmentScope",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.describe_attached_files_configuration_response.DescribeAttachedFilesConfigurationResponse":
    """<p>Describes the attached files configuration for the specified Connect Customer instance and attachment scope.</p> <p>If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.</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>
        attachment_scope: <p>The scope of the attachment. Valid values are <code>EMAIL</code>, <code>CHAT</code>, <code>CASE</code>, and <code>TASK</code>.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</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.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.describe_attached_files_configuration_request.DescribeAttachedFilesConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_attached_files_configuration_response.DescribeAttachedFilesConfigurationResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_attached_files_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAttachedFilesConfiguration")
    )
    input_: capo_connect.types.describe_attached_files_configuration_request.DescribeAttachedFilesConfigurationRequest = {
        "instance_id": instance_id,
        "attachment_scope": attachment_scope,
    }

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