import_api_keys ¶

import_api_keys(
    body: Blob,
    format: ApiKeysFormat,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    fail_on_warnings: Optional[Boolean] = None,
) -> ApiKeyIds

Import API keys from an external source, such as a CSV-formatted file.

Parameters:

body (Blob) –

The payload of the POST request to import API keys. For the payload format, see API Key File Format.
format (ApiKeysFormat) –

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
fail_on_warnings (Optional[Boolean], default: None ) –

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

The request configuration has conflicts. For details, see the accompanying error message.
LimitExceededException –

The request exceeded the rate limit. Retry after the specified time period.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

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

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def import_api_keys(
    self,
    body: "capo_api_gateway.types.blob.Blob",
    format: "capo_api_gateway.types.api_keys_format.ApiKeysFormat",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    fail_on_warnings: Optional["capo_api_gateway.types.boolean.Boolean"] = None,
) -> "capo_api_gateway.types.api_key_ids.ApiKeyIds":
    """<p>Import API keys from an external source, such as a CSV-formatted file.</p>

    Args:
        body: <p>The payload of the POST request to import API keys. For the payload format, see API Key File Format.</p>
        format: <p>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</p>
        fail_on_warnings: <p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.import_api_keys_request.ImportApiKeysRequest]",
    ) -> OperationResponse["capo_api_gateway.types.api_key_ids.ApiKeyIds"]:
        import capo_api_gateway._operations.backplane_control_service.import_api_keys

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.import_api_keys.import_api_keys(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportApiKeys")
    )
    input_: capo_api_gateway.types.import_api_keys_request.ImportApiKeysRequest = {
        "body": body,
        "format": format,
    }
    if fail_on_warnings is not None:
        input_["fail_on_warnings"] = fail_on_warnings

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