Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribePortfolioShareStatus

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Request Syntax


{
   "PortfolioShareToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

PortfolioShareToken

The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

Response Syntax


{
   "OrganizationNodeValue": "string",
   "PortfolioId": "string",
   "PortfolioShareToken": "string",
   "ShareDetails": { 
      "ShareErrors": [ 
         { 
            "Accounts": [ "string" ],
            "Error": "string",
            "Message": "string"
         }
      ],
      "SuccessfulShares": [ "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.

OrganizationNodeValue

Organization node identifier. It can be either account id, organizational unit id or organization id.

Type: String

Pattern: (^[0-9]{12}$)|(^arn:aws:organizations::\d{12}:organization\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\d{12}:ou\/o-[a-z0-9]{10,32}\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)

PortfolioId

The portfolio identifier.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-]*

PortfolioShareToken

The token for the portfolio share operation. For example, share-6v24abcdefghi.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-]*

ShareDetails

Information about the portfolio share operation.

Type: ShareDetails object

Status

Status of the portfolio share operation.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | ERROR

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

OperationNotSupportedException

The operation is not supported.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400