create_configuration ¶

create_configuration(
    name: ConfigurationName,
    run_configurations: RunConfigurations,
    request_id: ConfigurationRequestId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    description: Optional[ConfigurationDescription] = None,
    tags: Optional[TagMap] = None,
) -> CreateConfigurationResponse

Create a new configuration.

Parameters:

name (ConfigurationName) –

User-friendly name for the configuration.
description (Optional[ConfigurationDescription], default: None ) –

Optional description for the configuration.
run_configurations (RunConfigurations) –

Required run-specific configurations.
tags (Optional[TagMap], default: None ) –

Optional tags for the configuration.
request_id (ConfigurationRequestId) –

Optional request idempotency token. If not specified, a universally unique identifier (UUID) will be automatically generated for the request.

Raises:

AccessDeniedException –

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

The request cannot be applied to the target resource in its current state.
InternalServerException –

An unexpected error occurred. Try the request again.
RequestTimeoutException –

The request timed out.
ResourceNotFoundException –

The target resource was not found in the current Region.
ServiceQuotaExceededException –

The request exceeds a service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_omics/_services/omics.py

def create_configuration(
    self,
    name: "capo_omics.types.configuration_name.ConfigurationName",
    run_configurations: "capo_omics.types.run_configurations.RunConfigurations",
    request_id: "capo_omics.types.configuration_request_id.ConfigurationRequestId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    description: Optional[
        "capo_omics.types.configuration_description.ConfigurationDescription"
    ] = None,
    tags: Optional["capo_omics.types.tag_map.TagMap"] = None,
) -> "capo_omics.types.create_configuration_response.CreateConfigurationResponse":
    """<p>Create a new configuration.</p>

    Args:
        name: <p>User-friendly name for the configuration.</p>
        description: <p>Optional description for the configuration.</p>
        run_configurations: <p>Required run-specific configurations.</p>
        tags: <p>Optional tags for the configuration.</p>
        request_id: <p>Optional request idempotency token. If not specified, a universally unique identifier (UUID) will be automatically generated for the request.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.create_configuration_request.CreateConfigurationRequest]",
    ) -> OperationResponse[
        "capo_omics.types.create_configuration_response.CreateConfigurationResponse"
    ]:
        import capo_omics._operations.omics.create_configuration

        output, http_response = (
            capo_omics._operations.omics.create_configuration.create_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateConfiguration")
    )
    input_: capo_omics.types.create_configuration_request.CreateConfigurationRequest = {
        "name": name,
        "run_configurations": run_configurations,
        "request_id": request_id,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

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