create_resource_share async ¶

async def create_resource_share(
    self,
    name: "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,
    tags: Optional["capo_ram.types.tag_list.TagList"] = None,
    allow_external_principals: Optional["capo_ram.types.boolean.Boolean"] = None,
    client_token: Optional["capo_ram.types.string.String"] = None,
    permission_arns: Optional[
        "capo_ram.types.permission_arn_list.PermissionArnList"
    ] = None,
    sources: Optional[
        "capo_ram.types.source_arn_or_account_list.SourceArnOrAccountList"
    ] = None,
    resource_share_configuration: Optional[
        "capo_ram.types.resource_share_configuration.ResourceShareConfiguration"
    ] = None,
) -> "capo_ram.types.create_resource_share_response.CreateResourceShareResponse":
    """<p>Creates a resource share. You can provide a list of the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for the resources that you want to share, a list of principals you want to share the resources with, the permissions to grant those principals, and optionally source constraints to enhance security for service principal sharing.</p> <note> <p>Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.</p> </note>

    Args:
        name: <p>Specifies the name of the resource share.</p>
        resource_arns: <p>Specifies a list of one or more ARNs of the resources to associate with the resource share.</p>
        principals: <p>Specifies a list of one or more principals to associate with the 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>
        tags: <p>Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.</p>
        allow_external_principals: <p>Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of <code>true</code> lets you share with individual Amazon Web Services accounts that are <i>not</i> in your organization. A value of <code>false</code> only has meaning if your account is a member of an Amazon Web Services Organization. The default value is <code>true</code>.</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>
        permission_arns: <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.</p>
        sources: <p>Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.</p>
        resource_share_configuration: <p>Specifies the configuration of this resource share.</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.tag_limit_exceeded_exception.TagLimitExceededException: <p>The operation failed because it would exceed the limit for tags for your Amazon Web Services account.</p>
        capo_ram.errors.tag_policy_violation_exception.TagPolicyViolationException: <p>The operation failed because the specified tag key is a reserved word and can't be used.</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.create_resource_share_request.CreateResourceShareRequest]",
    ) -> AsyncOperationResponse[
        "capo_ram.types.create_resource_share_response.CreateResourceShareResponse"
    ]:
        import capo_ram._operations.amazon_resource_sharing.create_resource_share

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateResourceShare")
    )
    input_: capo_ram.types.create_resource_share_request.CreateResourceShareRequest = {
        "name": name
    }
    if resource_arns is not None:
        input_["resource_arns"] = resource_arns
    if principals is not None:
        input_["principals"] = principals
    if tags is not None:
        input_["tags"] = tags
    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
    if permission_arns is not None:
        input_["permission_arns"] = permission_arns
    if sources is not None:
        input_["sources"] = sources
    if resource_share_configuration is not None:
        input_["resource_share_configuration"] = resource_share_configuration

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