AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeUsersInput

import "github.com/aws/aws-sdk-go/service/workdocs"

type DescribeUsersInput struct { AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"` Fields *string `location:"querystring" locationName:"fields" min:"1" type:"string"` Include *string `location:"querystring" locationName:"include" type:"string" enum:"UserFilterType"` Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"` Marker *string `location:"querystring" locationName:"marker" min:"1" type:"string"` Order *string `location:"querystring" locationName:"order" type:"string" enum:"OrderType"` OrganizationId *string `location:"querystring" locationName:"organizationId" min:"1" type:"string"` Query *string `location:"querystring" locationName:"query" min:"1" type:"string" sensitive:"true"` Sort *string `location:"querystring" locationName:"sort" type:"string" enum:"UserSortType"` UserIds *string `location:"querystring" locationName:"userIds" min:"1" type:"string"` }

AuthenticationToken

Type: *string

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Fields

Type: *string

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Include

Type: *string

The state of the users. Specify "ALL" to include inactive users.

Limit

Type: *int64

The maximum number of items to return.

Marker

Type: *string

The marker for the next set of results. (You received this marker from a previous call.)

Order

Type: *string

The order for the results.

OrganizationId

Type: *string

The ID of the organization.

Query

Type: *string

A query to filter users by user name.

Sort

Type: *string

The sorting criteria.

UserIds

Type: *string

The IDs of the users.

Method

GoString

func (s DescribeUsersInput) GoString() string

GoString returns the string representation

SetAuthenticationToken

func (s *DescribeUsersInput) SetAuthenticationToken(v string) *DescribeUsersInput

SetAuthenticationToken sets the AuthenticationToken field's value.

SetFields

func (s *DescribeUsersInput) SetFields(v string) *DescribeUsersInput

SetFields sets the Fields field's value.

SetInclude

func (s *DescribeUsersInput) SetInclude(v string) *DescribeUsersInput

SetInclude sets the Include field's value.

SetLimit

func (s *DescribeUsersInput) SetLimit(v int64) *DescribeUsersInput

SetLimit sets the Limit field's value.

SetMarker

func (s *DescribeUsersInput) SetMarker(v string) *DescribeUsersInput

SetMarker sets the Marker field's value.

SetOrder

func (s *DescribeUsersInput) SetOrder(v string) *DescribeUsersInput

SetOrder sets the Order field's value.

SetOrganizationId

func (s *DescribeUsersInput) SetOrganizationId(v string) *DescribeUsersInput

SetOrganizationId sets the OrganizationId field's value.

SetQuery

func (s *DescribeUsersInput) SetQuery(v string) *DescribeUsersInput

SetQuery sets the Query field's value.

SetSort

func (s *DescribeUsersInput) SetSort(v string) *DescribeUsersInput

SetSort sets the Sort field's value.

SetUserIds

func (s *DescribeUsersInput) SetUserIds(v string) *DescribeUsersInput

SetUserIds sets the UserIds field's value.

String

func (s DescribeUsersInput) String() string

String returns the string representation

Validate

func (s *DescribeUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: