Skip to content

put_metadata_flag async

put_metadata_flag(
    app_id: str,
    environment_name: str,
    feature_name: str,
    body: PutMetadataFlagBody,
    *,
    config_overrides: Optional[AsyncAmplifyUIBuilderClientConfig] = None,
) -> None

Stores the metadata information about a feature on a form.

Parameters:

  • app_id (str) –

    The unique ID for the Amplify app.

  • environment_name (str) –

    The name of the backend environment that is part of the Amplify app.

  • feature_name (str) –

    The name of the feature associated with the metadata.

  • body (PutMetadataFlagBody) –

    The metadata information to store.

Raises:

Source code in docs_src/capo_amplifyuibuilder/_services/async_amplify_ui_builder.py
async def put_metadata_flag(
    self,
    app_id: str,
    environment_name: str,
    feature_name: str,
    body: "capo_amplifyuibuilder.types.put_metadata_flag_body.PutMetadataFlagBody",
    *,
    config_overrides: Optional[AsyncAmplifyUIBuilderClientConfig] = None,
) -> None:
    """<p>Stores the metadata information about a feature on a form.</p>

    Args:
        app_id: <p>The unique ID for the Amplify app.</p>
        environment_name: <p>The name of the backend environment that is part of the Amplify app.</p>
        feature_name: <p>The name of the feature associated with the metadata.</p>
        body: <p>The metadata information to store.</p>

    Raises:
        capo_amplifyuibuilder.errors.invalid_parameter_exception.InvalidParameterException: <p>An invalid or out-of-range value was supplied for the input parameter.</p>
        capo_amplifyuibuilder.errors.unauthorized_exception.UnauthorizedException: <p>You don't have permission to perform this operation.</p>
        capo_amplifyuibuilder.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplifyuibuilder.types.put_metadata_flag_request.PutMetadataFlagRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_amplifyuibuilder._operations.amplify_ui_builder.put_metadata_flag

        (
            output,
            http_response,
        ) = await capo_amplifyuibuilder._operations.amplify_ui_builder.put_metadata_flag.async_put_metadata_flag(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutMetadataFlag")
    )
    input_: capo_amplifyuibuilder.types.put_metadata_flag_request.PutMetadataFlagRequest = {
        "app_id": app_id,
        "environment_name": environment_name,
        "feature_name": feature_name,
        "body": body,
    }

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