Skip to content

update_resource_share async

update_resource_share(
    resource_share_arn: String,
    *,
    config_overrides: Optional[AsyncRAMClientConfig] = None,
    name: Optional[String] = None,
    allow_external_principals: Optional[Boolean] = None,
    client_token: Optional[String] = None,
) -> UpdateResourceShareResponse

Modifies some of the properties of the specified resource share.

Parameters:

  • resource_share_arn (String) –

    Specifies the Amazon Resource Name (ARN) of the resource share that you want to modify.

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

    If specified, the new name that you want to attach to the resource share.

  • allow_external_principals (Optional[Boolean], default: None ) –

    Specifies whether principals outside your organization in Organizations can be associated with a resource share.

  • 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/async_ram.py
async def update_resource_share(
    self,
    resource_share_arn: "capo_ram.types.string.String",
    *,
    config_overrides: Optional[AsyncRAMClientConfig] = None,
    name: Optional["capo_ram.types.string.String"] = None,
    allow_external_principals: Optional["capo_ram.types.boolean.Boolean"] = None,
    client_token: Optional["capo_ram.types.string.String"] = None,
) -> "capo_ram.types.update_resource_share_response.UpdateResourceShareResponse":
    """<p>Modifies some of the properties of the specified resource share.</p>

    Args:
        resource_share_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 resource share that you want to modify.</p>
        name: <p>If specified, the new name that you want to attach to the resource share.</p>
        allow_external_principals: <p>Specifies whether principals outside your organization in Organizations can be associated with a resource share.</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.missing_required_parameter_exception.MissingRequiredParameterException: <p>The operation failed because a required input parameter is missing.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ram.types.update_resource_share_request.UpdateResourceShareRequest]",
    ) -> AsyncOperationResponse[
        "capo_ram.types.update_resource_share_response.UpdateResourceShareResponse"
    ]:
        import capo_ram._operations.amazon_resource_sharing.update_resource_share

        (
            output,
            http_response,
        ) = await capo_ram._operations.amazon_resource_sharing.update_resource_share.async_update_resource_share(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateResourceShare")
    )
    input_: capo_ram.types.update_resource_share_request.UpdateResourceShareRequest = {
        "resource_share_arn": resource_share_arn
    }
    if name is not None:
        input_["name"] = name
    if allow_external_principals is not None:
        input_["allow_external_principals"] = allow_external_principals
    if client_token is not None:
        input_["client_token"] = client_token

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