batch_get_field `async` ¶

batch_get_field(
    domain_id: DomainId,
    fields: BatchGetFieldIdentifierList,
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
) -> BatchGetFieldResponse

Returns the description for the list of fields in the request parameters.

Parameters:

domain_id (DomainId) –

The unique identifier of the Cases domain.
fields (BatchGetFieldIdentifierList) –

A list of unique field identifiers.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

We couldn't process your request because of an issue with the server. Try again later.
ResourceNotFoundException –

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
ThrottlingException –

The rate has been exceeded for this API. Please try again after a few minutes.
ValidationException –

The request isn't valid. Check the syntax and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connectcases/_services/async_connect_cases.py

async def batch_get_field(
    self,
    domain_id: "capo_connectcases.types.domain_id.DomainId",
    fields: "capo_connectcases.types.batch_get_field_identifier_list.BatchGetFieldIdentifierList",
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
) -> "capo_connectcases.types.batch_get_field_response.BatchGetFieldResponse":
    """<p>Returns the description for the list of fields in the request parameters. </p>

    Args:
        domain_id: <p>The unique identifier of the Cases domain. </p>
        fields: <p>A list of unique field identifiers. </p>

    Raises:
        capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
        capo_connectcases.errors.resource_not_found_exception.ResourceNotFoundException: <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
        capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
        capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
        capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connectcases.types.batch_get_field_request.BatchGetFieldRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcases.types.batch_get_field_response.BatchGetFieldResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.batch_get_field

        (
            output,
            http_response,
        ) = await capo_connectcases._operations.amazon_connect_cases.batch_get_field.async_batch_get_field(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetField")
    )
    input_: capo_connectcases.types.batch_get_field_request.BatchGetFieldRequest = {
        "domain_id": domain_id,
        "fields": fields,
    }

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

batch_get_field async ¶

batch_get_field `async` ¶