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.Cloud9.DescribeEnvironmentMemberships

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about environment members for an Cloud9 development environment.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEnvironmentMemberships Source #

See: newDescribeEnvironmentMemberships smart constructor.

Constructors

DescribeEnvironmentMemberships'

Fields

environmentId :: Maybe Text
The ID of the environment to get environment member information about.
maxResults :: Maybe Natural
The maximum number of environment members to get information about.
nextToken :: Maybe Text
During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
permissions :: Maybe [Permissions]
The type of environment member permissions to get information about. Available values include:
- owner: Owns the environment.
- read-only: Has read-only access to the environment.
- read-write: Has read-write access to the environment.
If no value is specified, information about all environment members are returned.
userArn :: Maybe Text
The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

Instances

Instances details

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

newDescribeEnvironmentMemberships :: DescribeEnvironmentMemberships Source #

Create a value of DescribeEnvironmentMemberships 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:

DescribeEnvironmentMemberships, describeEnvironmentMemberships_environmentId - The ID of the environment to get environment member information about.

$sel:maxResults:DescribeEnvironmentMemberships', describeEnvironmentMemberships_maxResults - The maximum number of environment members to get information about.

DescribeEnvironmentMemberships, describeEnvironmentMemberships_nextToken - During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

DescribeEnvironmentMemberships, describeEnvironmentMemberships_permissions - The type of environment member permissions to get information about. Available values include:

owner: Owns the environment.
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

DescribeEnvironmentMemberships, describeEnvironmentMemberships_userArn - The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

Request Lenses

describeEnvironmentMemberships_environmentId :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

The ID of the environment to get environment member information about.

describeEnvironmentMemberships_maxResults :: Lens' DescribeEnvironmentMemberships (Maybe Natural) Source #

The maximum number of environment members to get information about.

describeEnvironmentMemberships_nextToken :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

describeEnvironmentMemberships_permissions :: Lens' DescribeEnvironmentMemberships (Maybe [Permissions]) Source #

The type of environment member permissions to get information about. Available values include:

owner: Owns the environment.
read-only: Has read-only access to the environment.
read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

describeEnvironmentMemberships_userArn :: Lens' DescribeEnvironmentMemberships (Maybe Text) Source #

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

Destructuring the Response

data DescribeEnvironmentMembershipsResponse Source #

See: newDescribeEnvironmentMembershipsResponse smart constructor.

Constructors

DescribeEnvironmentMembershipsResponse'

Fields

memberships :: Maybe [EnvironmentMember]
Information about the environment members for the environment.
nextToken :: Maybe Text
If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeEnvironmentMembershipsResponse Source #

Arguments

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

Create a value of DescribeEnvironmentMembershipsResponse 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:memberships:DescribeEnvironmentMembershipsResponse', describeEnvironmentMembershipsResponse_memberships - Information about the environment members for the environment.

DescribeEnvironmentMemberships, describeEnvironmentMembershipsResponse_nextToken - If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

$sel:httpStatus:DescribeEnvironmentMembershipsResponse', describeEnvironmentMembershipsResponse_httpStatus - The response's http status code.

Response Lenses

describeEnvironmentMembershipsResponse_memberships :: Lens' DescribeEnvironmentMembershipsResponse (Maybe [EnvironmentMember]) Source #

Information about the environment members for the environment.

describeEnvironmentMembershipsResponse_nextToken :: Lens' DescribeEnvironmentMembershipsResponse (Maybe Text) Source #

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

describeEnvironmentMembershipsResponse_httpStatus :: Lens' DescribeEnvironmentMembershipsResponse Int Source #

The response's http status code.