Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ServiceCatalog.ListPortfolioAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

Synopsis

data ListPortfolioAccess = ListPortfolioAccess' {
- acceptLanguage :: Maybe Text
- organizationParentId :: Maybe Text
- pageSize :: Maybe Natural
- pageToken :: Maybe Text
- portfolioId :: Text
}
newListPortfolioAccess :: Text -> ListPortfolioAccess
listPortfolioAccess_acceptLanguage :: Lens' ListPortfolioAccess (Maybe Text)
listPortfolioAccess_organizationParentId :: Lens' ListPortfolioAccess (Maybe Text)
listPortfolioAccess_pageSize :: Lens' ListPortfolioAccess (Maybe Natural)
listPortfolioAccess_pageToken :: Lens' ListPortfolioAccess (Maybe Text)
listPortfolioAccess_portfolioId :: Lens' ListPortfolioAccess Text
data ListPortfolioAccessResponse = ListPortfolioAccessResponse' {
- accountIds :: Maybe [Text]
- nextPageToken :: Maybe Text
- httpStatus :: Int
}
newListPortfolioAccessResponse :: Int -> ListPortfolioAccessResponse
listPortfolioAccessResponse_accountIds :: Lens' ListPortfolioAccessResponse (Maybe [Text])
listPortfolioAccessResponse_nextPageToken :: Lens' ListPortfolioAccessResponse (Maybe Text)
listPortfolioAccessResponse_httpStatus :: Lens' ListPortfolioAccessResponse Int

Creating a Request

data ListPortfolioAccess Source #

See: newListPortfolioAccess smart constructor.

Constructors

ListPortfolioAccess'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
organizationParentId :: Maybe Text
The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.
pageSize :: Maybe Natural
The maximum number of items to return with this call.
pageToken :: Maybe Text
The page token for the next set of results. To retrieve the first set of results, use null.
portfolioId :: Text
The portfolio identifier.

Instances

Instances details

ToJSON ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods toJSON :: ListPortfolioAccess -> Value # toEncoding :: ListPortfolioAccess -> Encoding # toJSONList :: [ListPortfolioAccess] -> Value # toEncodingList :: [ListPortfolioAccess] -> Encoding #
ToHeaders ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods toHeaders :: ListPortfolioAccess -> [Header] #
ToPath ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods toPath :: ListPortfolioAccess -> ByteString #
ToQuery ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods toQuery :: ListPortfolioAccess -> QueryString #
AWSRequest ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Associated Types type AWSResponse ListPortfolioAccess # Methods request :: (Service -> Service) -> ListPortfolioAccess -> Request ListPortfolioAccess # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPortfolioAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPortfolioAccess))) #
Generic ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Associated Types type Rep ListPortfolioAccess :: Type -> Type # Methods from :: ListPortfolioAccess -> Rep ListPortfolioAccess x # to :: Rep ListPortfolioAccess x -> ListPortfolioAccess #
Read ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods readsPrec :: Int -> ReadS ListPortfolioAccess # readList :: ReadS [ListPortfolioAccess] # readPrec :: ReadPrec ListPortfolioAccess # readListPrec :: ReadPrec [ListPortfolioAccess] #
Show ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods showsPrec :: Int -> ListPortfolioAccess -> ShowS # show :: ListPortfolioAccess -> String # showList :: [ListPortfolioAccess] -> ShowS #
NFData ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods rnf :: ListPortfolioAccess -> () #
Eq ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods (==) :: ListPortfolioAccess -> ListPortfolioAccess -> Bool # (/=) :: ListPortfolioAccess -> ListPortfolioAccess -> Bool #
Hashable ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods hashWithSalt :: Int -> ListPortfolioAccess -> Int # hash :: ListPortfolioAccess -> Int #
type AWSResponse ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess type AWSResponse ListPortfolioAccess = ListPortfolioAccessResponse
type Rep ListPortfolioAccess Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess type Rep ListPortfolioAccess = D1 ('MetaData "ListPortfolioAccess" "Amazonka.ServiceCatalog.ListPortfolioAccess" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "ListPortfolioAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "organizationParentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "portfolioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListPortfolioAccess Source #

Arguments

:: Text	`ListPortfolioAccess`
-> ListPortfolioAccess

Create a value of ListPortfolioAccess 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:acceptLanguage:ListPortfolioAccess', listPortfolioAccess_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:organizationParentId:ListPortfolioAccess', listPortfolioAccess_organizationParentId - The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

$sel:pageSize:ListPortfolioAccess', listPortfolioAccess_pageSize - The maximum number of items to return with this call.

$sel:pageToken:ListPortfolioAccess', listPortfolioAccess_pageToken - The page token for the next set of results. To retrieve the first set of results, use null.

ListPortfolioAccess, listPortfolioAccess_portfolioId - The portfolio identifier.

Request Lenses

listPortfolioAccess_acceptLanguage :: Lens' ListPortfolioAccess (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

listPortfolioAccess_organizationParentId :: Lens' ListPortfolioAccess (Maybe Text) Source #

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

listPortfolioAccess_pageSize :: Lens' ListPortfolioAccess (Maybe Natural) Source #

The maximum number of items to return with this call.

listPortfolioAccess_pageToken :: Lens' ListPortfolioAccess (Maybe Text) Source #

The page token for the next set of results. To retrieve the first set of results, use null.

listPortfolioAccess_portfolioId :: Lens' ListPortfolioAccess Text Source #

The portfolio identifier.

Destructuring the Response

data ListPortfolioAccessResponse Source #

See: newListPortfolioAccessResponse smart constructor.

Constructors

ListPortfolioAccessResponse'
Fields accountIds :: Maybe [Text] Information about the Amazon Web Services accounts with access to the portfolio. nextPageToken :: Maybe Text The page token to use to retrieve the next set of results. If there are no additional results, this value is null. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Associated Types type Rep ListPortfolioAccessResponse :: Type -> Type # Methods from :: ListPortfolioAccessResponse -> Rep ListPortfolioAccessResponse x # to :: Rep ListPortfolioAccessResponse x -> ListPortfolioAccessResponse #
Read ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods readsPrec :: Int -> ReadS ListPortfolioAccessResponse # readList :: ReadS [ListPortfolioAccessResponse] # readPrec :: ReadPrec ListPortfolioAccessResponse # readListPrec :: ReadPrec [ListPortfolioAccessResponse] #
Show ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods showsPrec :: Int -> ListPortfolioAccessResponse -> ShowS # show :: ListPortfolioAccessResponse -> String # showList :: [ListPortfolioAccessResponse] -> ShowS #
NFData ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods rnf :: ListPortfolioAccessResponse -> () #
Eq ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess Methods (==) :: ListPortfolioAccessResponse -> ListPortfolioAccessResponse -> Bool # (/=) :: ListPortfolioAccessResponse -> ListPortfolioAccessResponse -> Bool #
type Rep ListPortfolioAccessResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.ListPortfolioAccess type Rep ListPortfolioAccessResponse = D1 ('MetaData "ListPortfolioAccessResponse" "Amazonka.ServiceCatalog.ListPortfolioAccess" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "ListPortfolioAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPortfolioAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListPortfolioAccessResponse'`
-> ListPortfolioAccessResponse

Create a value of ListPortfolioAccessResponse 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:accountIds:ListPortfolioAccessResponse', listPortfolioAccessResponse_accountIds - Information about the Amazon Web Services accounts with access to the portfolio.

$sel:nextPageToken:ListPortfolioAccessResponse', listPortfolioAccessResponse_nextPageToken - The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

$sel:httpStatus:ListPortfolioAccessResponse', listPortfolioAccessResponse_httpStatus - The response's http status code.

Response Lenses

listPortfolioAccessResponse_accountIds :: Lens' ListPortfolioAccessResponse (Maybe [Text]) Source #

Information about the Amazon Web Services accounts with access to the portfolio.

listPortfolioAccessResponse_nextPageToken :: Lens' ListPortfolioAccessResponse (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.

listPortfolioAccessResponse_httpStatus :: Lens' ListPortfolioAccessResponse Int Source #

The response's http status code.