Skip to content

copy_option_group async

copy_option_group(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    source_option_group_identifier: Optional[String] = None,
    target_option_group_identifier: Optional[String] = None,
    target_option_group_description: Optional[String] = None,
    tags: Optional[TagList] = None,
) -> CopyOptionGroupResult

Copies the specified option group.

Parameters:

  • source_option_group_identifier (Optional[String], default: None ) –

    The identifier for the source option group.

    Constraints:

    • Must specify a valid option group.

  • target_option_group_identifier (Optional[String], default: None ) –

    The identifier for the copied option group.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

  • target_option_group_description (Optional[String], default: None ) –

    The description for the copied option group.

Raises:

Examples:

To copy an option group The following example makes a copy of an option group.

>>> await client.copy_option_group(source_option_group_identifier='myoptiongroup', target_option_group_identifier='new-option-group', target_option_group_description='My option group copy')
Source code in docs_src/capo_rds/_services/async_rds.py
async def copy_option_group(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    source_option_group_identifier: Optional["capo_rds.types.string.String"] = None,
    target_option_group_identifier: Optional["capo_rds.types.string.String"] = None,
    target_option_group_description: Optional[
        "capo_rds.types.string.String"
    ] = None,
    tags: Optional["capo_rds.types.tag_list.TagList"] = None,
) -> "capo_rds.types.copy_option_group_result.CopyOptionGroupResult":
    """<p>Copies the specified option group.</p>

    Args:
        source_option_group_identifier: <p>The identifier for the source option group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid option group.</p> </li> </ul>
        target_option_group_identifier: <p>The identifier for the copied option group.</p> <p>Constraints:</p> <ul> <li> <p>Can't be null, empty, or blank</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-option-group</code> </p>
        target_option_group_description: <p>The description for the copied option group.</p>

    Raises:
        capo_rds.errors.option_group_already_exists_fault.OptionGroupAlreadyExistsFault: <p>The option group you are trying to create already exists.</p>
        capo_rds.errors.option_group_not_found_fault.OptionGroupNotFoundFault: <p>The specified option group could not be found.</p>
        capo_rds.errors.option_group_quota_exceeded_fault.OptionGroupQuotaExceededFault: <p>The quota of 20 option groups was exceeded for this Amazon Web Services account.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To copy an option group
        The following example makes a copy of an option group.

        >>> await client.copy_option_group(source_option_group_identifier='myoptiongroup', target_option_group_identifier='new-option-group', target_option_group_description='My option group copy')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.copy_option_group_message.CopyOptionGroupMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.copy_option_group_result.CopyOptionGroupResult"
    ]:
        import capo_rds._operations.amazon_rd_sv19.copy_option_group

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.copy_option_group.async_copy_option_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_rds.types.copy_option_group_result.CopyOptionGroupResult",
    ) -> dict[str, Any]:
        import capo_rds.types.copy_option_group_result

        return capo_rds.types.copy_option_group_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CopyOptionGroup", redact_output=_redact_output),
    )
    input_: capo_rds.types.copy_option_group_message.CopyOptionGroupMessage = {}
    if source_option_group_identifier is not None:
        input_["source_option_group_identifier"] = source_option_group_identifier
    if target_option_group_identifier is not None:
        input_["target_option_group_identifier"] = target_option_group_identifier
    if target_option_group_description is not None:
        input_["target_option_group_description"] = target_option_group_description
    if tags is not None:
        input_["tags"] = tags

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