AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Lists the roots that are defined in the current organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is nullonly when there are no more results to display.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginListRoots and EndListRoots.

Namespace: Amazon.Organizations
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<ListRootsResponse> ListRootsAsync(
         ListRootsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Organizations.Model.ListRootsRequest

Container for the necessary parameters to execute the ListRoots service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ListRoots service method, as returned by Organizations.

Exceptions

ExceptionCondition
AccessDeniedException You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
AWSOrganizationsNotInUseException Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.
InvalidInputException The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit: Some of the reasons in the following list might not be applicable to this specific API or operation. DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity. IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be modified. INPUT_REQUIRED: You must include a value for all required parameters. INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner. INVALID_ENUM: You specified an invalid value. INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string. INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters. INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value. INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation. INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party. INVALID_PATTERN: You provided a value that doesn't match the required pattern. INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern. INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor. INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization. INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for Amazon Web Services use. System tags don’t count against your tags per resource limit. MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation. MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed. MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed. MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed. MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed. MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root. TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity. UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.
ServiceException Organizations can't complete your request because of an internal service error. Try again later.
TooManyRequestsException You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later. For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also