Skip to content

disassociate_resource_share async 

disassociate_resource_share(
    resource_share_arn: String,
    *,
    config_overrides: Optional[AsyncRAMClientConfig] = None,
    resource_arns: Optional[ResourceArnList] = None,
    principals: Optional[PrincipalArnOrIdList] = None,
    client_token: Optional[String] = None,
    sources: Optional[SourceArnOrAccountList] = None,
) -> DisassociateResourceShareResponse

Removes the specified principals, resources, or source constraints from participating in the specified resource share.

Parameters:

  • resource_share_arn (String) –

    Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.

  • resource_arns (Optional[ResourceArnList], default: None ) –

    Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.

  • principals (Optional[PrincipalArnOrIdList], default: None ) –

    Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012

    • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

    • An ARN of an IAM role, for example: iam::123456789012:role/rolename

    • An ARN of an IAM user, for example: iam::123456789012user/username

    • A service principal name, for example: service-id.amazonaws.com

    Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

  • 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.

  • sources (Optional[SourceArnOrAccountList], default: None ) –

    Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) to remove from the resource share. This enables granular management of source constraints while maintaining service principal associations. At least one source must remain when service principals are present.

Raises:

Source code in docs_src/capo_ram/_services/async_ram.py 
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
async def disassociate_resource_share(
    self,
    resource_share_arn: "capo_ram.types.string.String",
    *,
    config_overrides: Optional[AsyncRAMClientConfig] = None,
    resource_arns: Optional[
        "capo_ram.types.resource_arn_list.ResourceArnList"
    ] = None,
    principals: Optional[
        "capo_ram.types.principal_arn_or_id_list.PrincipalArnOrIdList"
    ] = None,
    client_token: Optional["capo_ram.types.string.String"] = None,
    sources: Optional[
        "capo_ram.types.source_arn_or_account_list.SourceArnOrAccountList"
    ] = None,
) -> "capo_ram.types.disassociate_resource_share_response.DisassociateResourceShareResponse":
    """<p>Removes the specified principals, resources, or source constraints from participating in the specified resource share.</p>

    Args:
        resource_share_arn: <p>Specifies <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 remove resources or principals from.</p>
        resource_arns: <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.</p>
        principals: <p>Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.</p> <p>You can include the following values:</p> <ul> <li> <p>An Amazon Web Services account ID, for example: <code>123456789012</code> </p> </li> <li> <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an organization in Organizations, for example: <code>organizations::123456789012:organization/o-exampleorgid</code> </p> </li> <li> <p>An ARN of an organizational unit (OU) in Organizations, for example: <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code> </p> </li> <li> <p>An ARN of an IAM role, for example: <code>iam::123456789012:role/rolename</code> </p> </li> <li> <p>An ARN of an IAM user, for example: <code>iam::123456789012user/username</code> </p> </li> <li> <p>A service principal name, for example: <code>service-id.amazonaws.com</code> </p> </li> </ul> <note> <p>Not all resource types can be shared with IAM roles and users. For more information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and users</a> in the <i>Resource Access Manager User Guide</i>.</p> </note>
        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>
        sources: <p>Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) to remove from the resource share. This enables granular management of source constraints while maintaining service principal associations. At least one source must remain when service principals are present.</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.invalid_state_transition_exception.InvalidStateTransitionException: <p>The operation failed because the requested operation isn't valid for the resource share in its current state.</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.resource_share_limit_exceeded_exception.ResourceShareLimitExceededException: <p>The operation failed because it would exceed the limit for resource shares for your account. You can associate up to 100 resources per call. To view the limits for your Amazon Web Services account, see the <a href="https://console.aws.amazon.com/servicequotas/home/services/ram/quotas">RAM page in the Service Quotas console</a>.</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.throttling_exception.ThrottlingException: <p>The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please 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.disassociate_resource_share_request.DisassociateResourceShareRequest]",
    ) -> AsyncOperationResponse[
        "capo_ram.types.disassociate_resource_share_response.DisassociateResourceShareResponse"
    ]:
        import capo_ram._operations.amazon_resource_sharing.disassociate_resource_share

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisassociateResourceShare")
    )
    input_: capo_ram.types.disassociate_resource_share_request.DisassociateResourceShareRequest = {
        "resource_share_arn": resource_share_arn
    }
    if resource_arns is not None:
        input_["resource_arns"] = resource_arns
    if principals is not None:
        input_["principals"] = principals
    if client_token is not None:
        input_["client_token"] = client_token
    if sources is not None:
        input_["sources"] = sources

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