Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateShare

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

HealthOmics variant stores
HealthOmics annotation stores
Private workflows

Request Syntax


POST /share HTTP/1.1
Content-type: application/json

{
   "principalSubscriber": "string",
   "resourceArn": "string",
   "shareName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

principalSubscriber

The principal subscriber is the account being offered shared access to the resource.

Type: String

Required: Yes

resourceArn

The ARN of the resource to be shared.

Type: String

Required: Yes

shareName

A name that the owner defines for the share.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "shareId": "string",
   "shareName": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

shareId

The ID that HealthOmics generates for the share.

Type: String

shareName

The name of the share.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

status

The status of the share.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400