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.ListOrganizationPortfolioAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListOrganizationPortfolioAccess Source #

See: newListOrganizationPortfolioAccess smart constructor.

Constructors

ListOrganizationPortfolioAccess'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
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. For example, port-2abcdext3y5fk.
organizationNodeType :: OrganizationNodeType
The organization node type that will be returned in the output.
- ORGANIZATION - Organization that has access to the portfolio.
- ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
- ACCOUNT - Account that has access to the portfolio within your organization.

Instances

Instances details

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

newListOrganizationPortfolioAccess Source #

Arguments

:: Text	`ListOrganizationPortfolioAccess`
-> OrganizationNodeType	`$sel:organizationNodeType:ListOrganizationPortfolioAccess'`
-> ListOrganizationPortfolioAccess

Create a value of ListOrganizationPortfolioAccess 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:ListOrganizationPortfolioAccess', listOrganizationPortfolioAccess_acceptLanguage - The language code.

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

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

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

ListOrganizationPortfolioAccess, listOrganizationPortfolioAccess_portfolioId - The portfolio identifier. For example, port-2abcdext3y5fk.

$sel:organizationNodeType:ListOrganizationPortfolioAccess', listOrganizationPortfolioAccess_organizationNodeType - The organization node type that will be returned in the output.

ORGANIZATION - Organization that has access to the portfolio.
ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
ACCOUNT - Account that has access to the portfolio within your organization.

Request Lenses

listOrganizationPortfolioAccess_acceptLanguage :: Lens' ListOrganizationPortfolioAccess (Maybe Text) Source #

The language code.

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

listOrganizationPortfolioAccess_pageSize :: Lens' ListOrganizationPortfolioAccess (Maybe Natural) Source #

The maximum number of items to return with this call.

listOrganizationPortfolioAccess_pageToken :: Lens' ListOrganizationPortfolioAccess (Maybe Text) Source #

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

listOrganizationPortfolioAccess_portfolioId :: Lens' ListOrganizationPortfolioAccess Text Source #

The portfolio identifier. For example, port-2abcdext3y5fk.

listOrganizationPortfolioAccess_organizationNodeType :: Lens' ListOrganizationPortfolioAccess OrganizationNodeType Source #

The organization node type that will be returned in the output.

ORGANIZATION - Organization that has access to the portfolio.
ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
ACCOUNT - Account that has access to the portfolio within your organization.

Destructuring the Response

data ListOrganizationPortfolioAccessResponse Source #

See: newListOrganizationPortfolioAccessResponse smart constructor.

Constructors

ListOrganizationPortfolioAccessResponse'
Fields 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. organizationNodes :: Maybe [OrganizationNode] Displays information about the organization nodes. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListOrganizationPortfolioAccessResponse Source #

Arguments

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

Create a value of ListOrganizationPortfolioAccessResponse 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:ListOrganizationPortfolioAccessResponse', listOrganizationPortfolioAccessResponse_nextPageToken - The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

$sel:organizationNodes:ListOrganizationPortfolioAccessResponse', listOrganizationPortfolioAccessResponse_organizationNodes - Displays information about the organization nodes.

$sel:httpStatus:ListOrganizationPortfolioAccessResponse', listOrganizationPortfolioAccessResponse_httpStatus - The response's http status code.

Response Lenses

listOrganizationPortfolioAccessResponse_nextPageToken :: Lens' ListOrganizationPortfolioAccessResponse (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.

listOrganizationPortfolioAccessResponse_organizationNodes :: Lens' ListOrganizationPortfolioAccessResponse (Maybe [OrganizationNode]) Source #

Displays information about the organization nodes.

listOrganizationPortfolioAccessResponse_httpStatus :: Lens' ListOrganizationPortfolioAccessResponse Int Source #

The response's http status code.