| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ServiceCatalog.DescribePortfolioShares
Description
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The PortfolioId and Type parameters are both required.
Synopsis
- data DescribePortfolioShares = DescribePortfolioShares' {}
- newDescribePortfolioShares :: Text -> DescribePortfolioShareType -> DescribePortfolioShares
- describePortfolioShares_pageToken :: Lens' DescribePortfolioShares (Maybe Text)
- describePortfolioShares_pageSize :: Lens' DescribePortfolioShares (Maybe Natural)
- describePortfolioShares_portfolioId :: Lens' DescribePortfolioShares Text
- describePortfolioShares_type :: Lens' DescribePortfolioShares DescribePortfolioShareType
- data DescribePortfolioSharesResponse = DescribePortfolioSharesResponse' {}
- newDescribePortfolioSharesResponse :: Int -> DescribePortfolioSharesResponse
- describePortfolioSharesResponse_nextPageToken :: Lens' DescribePortfolioSharesResponse (Maybe Text)
- describePortfolioSharesResponse_portfolioShareDetails :: Lens' DescribePortfolioSharesResponse (Maybe [PortfolioShareDetail])
- describePortfolioSharesResponse_httpStatus :: Lens' DescribePortfolioSharesResponse Int
Creating a Request
data DescribePortfolioShares Source #
See: newDescribePortfolioShares smart constructor.
Constructors
| DescribePortfolioShares' | |
Fields
| |
Instances
newDescribePortfolioShares Source #
Arguments
| :: Text | |
| -> DescribePortfolioShareType | |
| -> DescribePortfolioShares |
Create a value of DescribePortfolioShares with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pageToken:DescribePortfolioShares', describePortfolioShares_pageToken - The page token for the next set of results. To retrieve the first set of
results, use null.
$sel:pageSize:DescribePortfolioShares', describePortfolioShares_pageSize - The maximum number of items to return with this call.
$sel:portfolioId:DescribePortfolioShares', describePortfolioShares_portfolioId - The unique identifier of the portfolio for which shares will be
retrieved.
$sel:type':DescribePortfolioShares', describePortfolioShares_type - The type of portfolio share to summarize. This field acts as a filter on
the type of portfolio share, which can be one of the following:
ACCOUNT- Represents an external account to account share.ORGANIZATION- Represents a share to an organization. This share is available to every account in the organization.ORGANIZATIONAL_UNIT- Represents a share to an organizational unit.ORGANIZATION_MEMBER_ACCOUNT- Represents a share to an account in the organization.
Request Lenses
describePortfolioShares_pageToken :: Lens' DescribePortfolioShares (Maybe Text) Source #
The page token for the next set of results. To retrieve the first set of results, use null.
describePortfolioShares_pageSize :: Lens' DescribePortfolioShares (Maybe Natural) Source #
The maximum number of items to return with this call.
describePortfolioShares_portfolioId :: Lens' DescribePortfolioShares Text Source #
The unique identifier of the portfolio for which shares will be retrieved.
describePortfolioShares_type :: Lens' DescribePortfolioShares DescribePortfolioShareType Source #
The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:
ACCOUNT- Represents an external account to account share.ORGANIZATION- Represents a share to an organization. This share is available to every account in the organization.ORGANIZATIONAL_UNIT- Represents a share to an organizational unit.ORGANIZATION_MEMBER_ACCOUNT- Represents a share to an account in the organization.
Destructuring the Response
data DescribePortfolioSharesResponse Source #
See: newDescribePortfolioSharesResponse smart constructor.
Constructors
| DescribePortfolioSharesResponse' | |
Fields
| |
Instances
newDescribePortfolioSharesResponse Source #
Create a value of DescribePortfolioSharesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextPageToken:DescribePortfolioSharesResponse', describePortfolioSharesResponse_nextPageToken - The page token to use to retrieve the next set of results. If there are
no additional results, this value is null.
$sel:portfolioShareDetails:DescribePortfolioSharesResponse', describePortfolioSharesResponse_portfolioShareDetails - Summaries about each of the portfolio shares.
$sel:httpStatus:DescribePortfolioSharesResponse', describePortfolioSharesResponse_httpStatus - The response's http status code.
Response Lenses
describePortfolioSharesResponse_nextPageToken :: Lens' DescribePortfolioSharesResponse (Maybe Text) Source #
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
describePortfolioSharesResponse_portfolioShareDetails :: Lens' DescribePortfolioSharesResponse (Maybe [PortfolioShareDetail]) Source #
Summaries about each of the portfolio shares.
describePortfolioSharesResponse_httpStatus :: Lens' DescribePortfolioSharesResponse Int Source #
The response's http status code.