libZSservicesZSamazonka-cloud9ZSamazonka-cloud9
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Cloud9.DescribeEnvironmentMemberships

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

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

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

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

Instances

Instances details
Eq DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Read DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Show DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Generic DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Associated Types

type Rep DescribeEnvironmentMemberships :: Type -> Type #

NFData DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Hashable DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

ToJSON DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

AWSPager DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

AWSRequest DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

ToHeaders DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

ToPath DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

ToQuery DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

type Rep DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

type Rep DescribeEnvironmentMemberships = D1 ('MetaData "DescribeEnvironmentMemberships" "Amazonka.Cloud9.DescribeEnvironmentMemberships" "libZSservicesZSamazonka-cloud9ZSamazonka-cloud9" 'False) (C1 ('MetaCons "DescribeEnvironmentMemberships'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Permissions])) :*: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse DescribeEnvironmentMemberships Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

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:

$sel:userArn: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.

$sel:nextToken: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.

$sel:permissions: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.

$sel:environmentId: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.

Request Lenses

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.

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

Destructuring the Response

data DescribeEnvironmentMembershipsResponse Source #

Constructors

DescribeEnvironmentMembershipsResponse' 

Fields

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

  • memberships :: Maybe [EnvironmentMember]

    Information about the environment members for the environment.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Read DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Show DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

Generic DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

NFData DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

type Rep DescribeEnvironmentMembershipsResponse Source # 
Instance details

Defined in Amazonka.Cloud9.DescribeEnvironmentMemberships

type Rep DescribeEnvironmentMembershipsResponse = D1 ('MetaData "DescribeEnvironmentMembershipsResponse" "Amazonka.Cloud9.DescribeEnvironmentMemberships" "libZSservicesZSamazonka-cloud9ZSamazonka-cloud9" 'False) (C1 ('MetaCons "DescribeEnvironmentMembershipsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "memberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentMember])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEnvironmentMembershipsResponse Source #

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

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

Response Lenses

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.