validate_configuration `async` ¶

validate_configuration(
    application_id: Name,
    configuration_profile_id: LongName,
    configuration_version: Version,
    *,
    config_overrides: Optional[AsyncAppConfigClientConfig] = None,
) -> None

Uses the validators in a configuration profile to validate a configuration.

Parameters:

application_id (Name) –

The application ID.
configuration_profile_id (LongName) –

The configuration profile ID.
configuration_version (Version) –

The version of the configuration to validate.

Raises:

BadRequestException –

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

There was an internal failure in the AppConfig service.
ResourceNotFoundException –

The requested resource could not be found.
UnknownServiceError –

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

Examples:

To validate a configuration The following validate-configuration example uses the validators in a configuration profile to validate a configuration.

>>> await client.validate_configuration(application_id='abc1234', configuration_profile_id='ur8hx2f', configuration_version='1')

Source code in docs_src/capo_appconfig/_services/async_app_config.py

async def validate_configuration(
    self,
    application_id: "capo_appconfig.types.name.Name",
    configuration_profile_id: "capo_appconfig.types.long_name.LongName",
    configuration_version: "capo_appconfig.types.version.Version",
    *,
    config_overrides: Optional[AsyncAppConfigClientConfig] = None,
) -> None:
    """<p>Uses the validators in a configuration profile to validate a configuration.</p>

    Args:
        application_id: <p>The application ID.</p>
        configuration_profile_id: <p>The configuration profile ID.</p>
        configuration_version: <p>The version of the configuration to validate.</p>

    Raises:
        capo_appconfig.errors.bad_request_exception.BadRequestException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_appconfig.errors.internal_server_exception.InternalServerException: <p>There was an internal failure in the AppConfig service.</p>
        capo_appconfig.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_appconfig.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To validate a configuration
        The following validate-configuration example uses the validators in a configuration profile to validate a configuration.

        >>> await client.validate_configuration(application_id='abc1234', configuration_profile_id='ur8hx2f', configuration_version='1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appconfig.types.validate_configuration_request.ValidateConfigurationRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_appconfig._operations.amazon_app_config.validate_configuration

        (
            output,
            http_response,
        ) = await capo_appconfig._operations.amazon_app_config.validate_configuration.async_validate_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ValidateConfiguration")
    )
    input_: capo_appconfig.types.validate_configuration_request.ValidateConfigurationRequest = {
        "application_id": application_id,
        "configuration_profile_id": configuration_profile_id,
        "configuration_version": configuration_version,
    }

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

validate_configuration async ¶

validate_configuration `async` ¶