Skip to content

copy_db_parameter_group

copy_db_parameter_group(
    *,
    config_overrides: Optional[NeptuneClientConfig] = None,
    source_db_parameter_group_identifier: Optional[String] = None,
    target_db_parameter_group_identifier: Optional[String] = None,
    target_db_parameter_group_description: Optional[String] = None,
    tags: Optional[TagList] = None,
) -> CopyDBParameterGroupResult

Copies the specified DB parameter group.

Parameters:

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

    The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    Constraints:

    • Must specify a valid DB parameter group.

    • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

    • The source DB parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups.

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

    The identifier for the copied DB parameter group.

    Constraints:

    • Cannot be null, empty, or blank.

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

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-db-parameter-group

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

    A description for the copied DB parameter group.

  • tags (Optional[TagList], default: None ) –

    The tags to be assigned to the copied DB parameter group.

Raises:

Source code in docs_src/capo_neptune/_services/neptune.py
def copy_db_parameter_group(
    self,
    *,
    config_overrides: Optional[NeptuneClientConfig] = None,
    source_db_parameter_group_identifier: Optional[
        "capo_neptune.types.string.String"
    ] = None,
    target_db_parameter_group_identifier: Optional[
        "capo_neptune.types.string.String"
    ] = None,
    target_db_parameter_group_description: Optional[
        "capo_neptune.types.string.String"
    ] = None,
    tags: Optional["capo_neptune.types.tag_list.TagList"] = None,
) -> "capo_neptune.types.copy_db_parameter_group_result.CopyDBParameterGroupResult":
    """<p>Copies the specified DB parameter group.</p>

    Args:
        source_db_parameter_group_identifier: <p>The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href="https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing"> Constructing an Amazon Resource Name (ARN)</a>.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB parameter group.</p> </li> <li> <p>Must specify a valid DB parameter group identifier, for example <code>my-db-param-group</code>, or a valid ARN.</p> </li> <li> <p>The source DB parameter group must be in the same Amazon Region as the copy. Neptune does not support cross-Region copying of parameter groups.</p> </li> </ul>
        target_db_parameter_group_identifier: <p>The identifier for the copied DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot 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>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-db-parameter-group</code> </p>
        target_db_parameter_group_description: <p>A description for the copied DB parameter group.</p>
        tags: <p>The tags to be assigned to the copied DB parameter group.</p>

    Raises:
        capo_neptune.errors.db_parameter_group_already_exists_fault.DBParameterGroupAlreadyExistsFault: <p>A DB parameter group with the same name exists.</p>
        capo_neptune.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group.</p>
        capo_neptune.errors.db_parameter_group_quota_exceeded_fault.DBParameterGroupQuotaExceededFault: <p>Request would result in user exceeding the allowed number of DB parameter groups.</p>
        capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune.types.copy_db_parameter_group_message.CopyDBParameterGroupMessage]",
    ) -> OperationResponse[
        "capo_neptune.types.copy_db_parameter_group_result.CopyDBParameterGroupResult"
    ]:
        import capo_neptune._operations.amazon_rd_sv19.copy_db_parameter_group

        output, http_response = (
            capo_neptune._operations.amazon_rd_sv19.copy_db_parameter_group.copy_db_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CopyDBParameterGroup")
    )
    input_: capo_neptune.types.copy_db_parameter_group_message.CopyDBParameterGroupMessage = {}
    if source_db_parameter_group_identifier is not None:
        input_["source_db_parameter_group_identifier"] = (
            source_db_parameter_group_identifier
        )
    if target_db_parameter_group_identifier is not None:
        input_["target_db_parameter_group_identifier"] = (
            target_db_parameter_group_identifier
        )
    if target_db_parameter_group_description is not None:
        input_["target_db_parameter_group_description"] = (
            target_db_parameter_group_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