// Code generated by smithy-go-codegen DO NOT EDIT. package organizations import ( "context" "fmt" awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" "github.com/aws/aws-sdk-go-v2/aws/signer/v4" "github.com/aws/aws-sdk-go-v2/service/organizations/types" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" ) // 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 null only // 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 . func (c *Client) ListRoots(ctx context.Context, params *ListRootsInput, optFns ...func(*Options)) (*ListRootsOutput, error) { if params == nil { params = &ListRootsInput{} } result, metadata, err := c.invokeOperation(ctx, "ListRoots", params, optFns, c.addOperationListRootsMiddlewares) if err != nil { return nil, err } out := result.(*ListRootsOutput) out.ResultMetadata = metadata return out, nil } type ListRootsInput struct { // The total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the maximum you // specify, the NextToken response element is present and has a value (is not // null). Include that value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that Organizations // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken // response in a previous request. A NextToken response indicates that more output // is available. Set this parameter to the value of the previous call's NextToken // response to indicate where the output should continue from. NextToken *string noSmithyDocumentSerde } type ListRootsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . NextToken *string // A list of roots that are defined in an organization. Roots []types.Root // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationListRootsMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsAwsjson11_serializeOpListRoots{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListRoots{}, middleware.After) if err != nil { return err } if err = addSetLoggerMiddleware(stack, options); err != nil { return err } if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { return err } if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { return err } if err = addResolveEndpointMiddleware(stack, options); err != nil { return err } if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { return err } if err = addRetryMiddlewares(stack, options); err != nil { return err } if err = addHTTPSignerV4Middleware(stack, options); err != nil { return err } if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { return err } if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { return err } if err = addClientUserAgent(stack, options); err != nil { return err } if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { return err } if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListRoots(options.Region), middleware.Before); err != nil { return err } if err = awsmiddleware.AddRecursionDetection(stack); err != nil { return err } if err = addRequestIDRetrieverMiddleware(stack); err != nil { return err } if err = addResponseErrorMiddleware(stack); err != nil { return err } if err = addRequestResponseLogging(stack, options); err != nil { return err } return nil } // ListRootsAPIClient is a client that implements the ListRoots operation. type ListRootsAPIClient interface { ListRoots(context.Context, *ListRootsInput, ...func(*Options)) (*ListRootsOutput, error) } var _ ListRootsAPIClient = (*Client)(nil) // ListRootsPaginatorOptions is the paginator options for ListRoots type ListRootsPaginatorOptions struct { // The total number of results that you want included on each page of the // response. If you do not include this parameter, it defaults to a value that is // specific to the operation. If additional items exist beyond the maximum you // specify, the NextToken response element is present and has a value (is not // null). Include that value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that Organizations // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool } // ListRootsPaginator is a paginator for ListRoots type ListRootsPaginator struct { options ListRootsPaginatorOptions client ListRootsAPIClient params *ListRootsInput nextToken *string firstPage bool } // NewListRootsPaginator returns a new ListRootsPaginator func NewListRootsPaginator(client ListRootsAPIClient, params *ListRootsInput, optFns ...func(*ListRootsPaginatorOptions)) *ListRootsPaginator { if params == nil { params = &ListRootsInput{} } options := ListRootsPaginatorOptions{} if params.MaxResults != nil { options.Limit = *params.MaxResults } for _, fn := range optFns { fn(&options) } return &ListRootsPaginator{ options: options, client: client, params: params, firstPage: true, nextToken: params.NextToken, } } // HasMorePages returns a boolean indicating whether more pages are available func (p *ListRootsPaginator) HasMorePages() bool { return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0) } // NextPage retrieves the next ListRoots page. func (p *ListRootsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRootsOutput, error) { if !p.HasMorePages() { return nil, fmt.Errorf("no more pages available") } params := *p.params params.NextToken = p.nextToken var limit *int32 if p.options.Limit > 0 { limit = &p.options.Limit } params.MaxResults = limit result, err := p.client.ListRoots(ctx, ¶ms, optFns...) if err != nil { return nil, err } p.firstPage = false prevToken := p.nextToken p.nextToken = result.NextToken if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { p.nextToken = nil } return result, nil } func newServiceMetadataMiddleware_opListRoots(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "organizations", OperationName: "ListRoots", } }