Skip to content

replace_permission_associations

replace_permission_associations(
    from_permission_arn: String,
    to_permission_arn: String,
    *,
    config_overrides: Optional[RAMClientConfig] = None,
    from_permission_version: Optional[Integer] = None,
    client_token: Optional[String] = None,
) -> ReplacePermissionAssociationsResponse

Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.

You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the fromPermissionArn and toPermissionArn parameters.

You can use the optional fromPermissionVersion parameter to update only those resources that use a specified version of the managed permission to the new managed permission.

To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.

Parameters:

  • from_permission_arn (String) –

    Specifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.

  • from_permission_version (Optional[Integer], default: None ) –

    Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.

  • to_permission_arn (String) –

    Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one specified by fromPerssionArn and fromPermissionVersion.

    The operation always associates the version that is currently the default for the specified managed permission.

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

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Raises:

Source code in docs_src/capo_ram/_services/ram.py
def replace_permission_associations(
    self,
    from_permission_arn: "capo_ram.types.string.String",
    to_permission_arn: "capo_ram.types.string.String",
    *,
    config_overrides: Optional[RAMClientConfig] = None,
    from_permission_version: Optional["capo_ram.types.integer.Integer"] = None,
    client_token: Optional["capo_ram.types.string.String"] = None,
) -> "capo_ram.types.replace_permission_associations_response.ReplacePermissionAssociationsResponse":
    """<p>Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.</p> <p>You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the <code>fromPermissionArn</code> and <code>toPermissionArn</code> parameters.</p> <p>You can use the optional <code>fromPermissionVersion</code> parameter to update only those resources that use a specified version of the managed permission to the new managed permission.</p> <important> <p>To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.</p> </important>

    Args:
        from_permission_arn: <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission that you want to replace.</p>
        from_permission_version: <p>Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.</p>
        to_permission_arn: <p>Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one specified by <code>fromPerssionArn</code> and <code>fromPermissionVersion</code>.</p> <p>The operation always associates the version that is currently the default for the specified managed permission.</p>
        client_token: <p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>

    Raises:
        capo_ram.errors.idempotent_parameter_mismatch_exception.IdempotentParameterMismatchException: <p>The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.</p>
        capo_ram.errors.invalid_client_token_exception.InvalidClientTokenException: <p>The operation failed because the specified client token isn't valid.</p>
        capo_ram.errors.invalid_parameter_exception.InvalidParameterException: <p>The operation failed because a parameter you specified isn't valid.</p>
        capo_ram.errors.malformed_arn_exception.MalformedArnException: <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't valid.</p>
        capo_ram.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The operation failed because the requested operation isn't permitted.</p>
        capo_ram.errors.server_internal_exception.ServerInternalException: <p>The operation failed because the service could not respond to the request due to an internal problem. Try again later.</p>
        capo_ram.errors.service_unavailable_exception.ServiceUnavailableException: <p>The operation failed because the service isn't available. Try again later.</p>
        capo_ram.errors.unknown_resource_exception.UnknownResourceException: <p>The operation failed because a specified resource couldn't be found.</p>
        capo_ram.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ram.types.replace_permission_associations_request.ReplacePermissionAssociationsRequest]",
    ) -> OperationResponse[
        "capo_ram.types.replace_permission_associations_response.ReplacePermissionAssociationsResponse"
    ]:
        import capo_ram._operations.amazon_resource_sharing.replace_permission_associations

        output, http_response = (
            capo_ram._operations.amazon_resource_sharing.replace_permission_associations.replace_permission_associations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReplacePermissionAssociations")
    )
    input_: capo_ram.types.replace_permission_associations_request.ReplacePermissionAssociationsRequest = {
        "from_permission_arn": from_permission_arn,
        "to_permission_arn": to_permission_arn,
    }
    if from_permission_version is not None:
        input_["from_permission_version"] = from_permission_version
    if client_token is not None:
        input_["client_token"] = client_token

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