Skip to content

DescribeEnvironmentMembershipsRequest

Source code in docs_src/capo_cloud9/types/describe_environment_memberships_request.py 
15
16
17
18
19
20
21
22
23
24
25
class DescribeEnvironmentMembershipsRequest(TypedDict, closed=True):
    user_arn: NotRequired["capo_cloud9.types.user_arn.UserArn"]
    """<p>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.</p>"""
    environment_id: NotRequired["capo_cloud9.types.environment_id.EnvironmentId"]
    """<p>The ID of the environment to get environment member information about.</p>"""
    permissions: NotRequired["capo_cloud9.types.permissions_list.PermissionsList"]
    """<p>The type of environment member permissions to get information about. Available values include:</p> <ul> <li> <p> <code>owner</code>: Owns the environment.</p> </li> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul> <p>If no value is specified, information about all environment members are returned.</p>"""
    next_token: NotRequired["capo_cloud9.types.string.String"]
    """<p>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 <i>next token</i>. 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.</p>"""
    max_results: NotRequired["capo_cloud9.types.max_results.MaxResults"]
    """<p>The maximum number of environment members to get information about.</p>"""

environment_id instance-attribute 

environment_id: NotRequired[EnvironmentId]

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

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of environment members to get information about.

next_token instance-attribute 

next_token: NotRequired[String]

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 instance-attribute 

permissions: NotRequired[PermissionsList]

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.

user_arn instance-attribute 

user_arn: NotRequired[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.