Amazonka.QuickSight.SearchGroups

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

Creating a Request

data SearchGroups

See: newSearchGroups smart constructor.

Constructors

SearchGroups'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to return from this request.

• nextToken :: Maybe Text

  A pagination token that can be used in a subsequent request.

• awsAccountId :: Text

  The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

• namespace :: Text

  The namespace that you want to search.

• filters :: NonEmpty GroupSearchFilter

  The structure for the search filters that you want to apply to your search.

Instances

ToJSON SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

toJSON :: SearchGroups -> Value

toEncoding :: SearchGroups -> Encoding

toJSONList :: [SearchGroups] -> Value

toEncodingList :: [SearchGroups] -> Encoding

ToHeaders SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

toHeaders :: SearchGroups -> [Header]

ToPath SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

toPath :: SearchGroups -> ByteString

ToQuery SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

toQuery :: SearchGroups -> QueryString

AWSRequest SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Associated Types

type AWSResponse SearchGroups

Methods

request :: (Service -> Service) -> SearchGroups -> Request SearchGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchGroups)))

Generic SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Associated Types

type Rep SearchGroups :: Type -> Type

Methods

from :: SearchGroups -> Rep SearchGroups x

to :: Rep SearchGroups x -> SearchGroups

Read SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

readsPrec :: Int -> ReadS SearchGroups

readList :: ReadS [SearchGroups]

readPrec :: ReadPrec SearchGroups

readListPrec :: ReadPrec [SearchGroups]

Show SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

showsPrec :: Int -> SearchGroups -> ShowS

show :: SearchGroups -> String

showList :: [SearchGroups] -> ShowS

NFData SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

rnf :: SearchGroups -> ()

Eq SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

(==) :: SearchGroups -> SearchGroups -> Bool

(/=) :: SearchGroups -> SearchGroups -> Bool

Hashable SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

Methods

hashWithSalt :: Int -> SearchGroups -> Int

hash :: SearchGroups -> Int

type AWSResponse SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

type AWSResponse SearchGroups = SearchGroupsResponse

type Rep SearchGroups

Defined in Amazonka.QuickSight.SearchGroups

type Rep SearchGroups = D1 ('MetaData "SearchGroups" "Amazonka.QuickSight.SearchGroups" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty GroupSearchFilter))))))

newSearchGroups

Arguments

:: Text

SearchGroups

-> Text

SearchGroups

-> NonEmpty GroupSearchFilter

SearchGroups

-> SearchGroups

Create a value of SearchGroups 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:maxResults:SearchGroups', searchGroups_maxResults - The maximum number of results to return from this request.

SearchGroups, searchGroups_nextToken - A pagination token that can be used in a subsequent request.

SearchGroups, searchGroups_awsAccountId - The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

SearchGroups, searchGroups_namespace - The namespace that you want to search.

SearchGroups, searchGroups_filters - The structure for the search filters that you want to apply to your search.

Request Lenses

searchGroups_maxResults :: Lens' SearchGroups (Maybe Natural)

The maximum number of results to return from this request.

searchGroups_nextToken :: Lens' SearchGroups (Maybe Text)

A pagination token that can be used in a subsequent request.

searchGroups_awsAccountId :: Lens' SearchGroups Text

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

searchGroups_namespace :: Lens' SearchGroups Text

The namespace that you want to search.

searchGroups_filters :: Lens' SearchGroups (NonEmpty GroupSearchFilter)

The structure for the search filters that you want to apply to your search.

Destructuring the Response

data SearchGroupsResponse

See: newSearchGroupsResponse smart constructor.

Constructors

SearchGroupsResponse'

Fields

• groupList :: Maybe [Group]

  A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

• nextToken :: Maybe Text

  A pagination token that can be used in a subsequent request.

• requestId :: Maybe Text

  The Amazon Web Services request ID for this operation.

• status :: Int

  The HTTP status of the request.

Instances

Generic SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

Associated Types

type Rep SearchGroupsResponse :: Type -> Type

Methods

from :: SearchGroupsResponse -> Rep SearchGroupsResponse x

to :: Rep SearchGroupsResponse x -> SearchGroupsResponse

Read SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

Methods

readsPrec :: Int -> ReadS SearchGroupsResponse

readList :: ReadS [SearchGroupsResponse]

readPrec :: ReadPrec SearchGroupsResponse

readListPrec :: ReadPrec [SearchGroupsResponse]

Show SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

Methods

showsPrec :: Int -> SearchGroupsResponse -> ShowS

show :: SearchGroupsResponse -> String

showList :: [SearchGroupsResponse] -> ShowS

NFData SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

Methods

rnf :: SearchGroupsResponse -> ()

Eq SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

Methods

(==) :: SearchGroupsResponse -> SearchGroupsResponse -> Bool

(/=) :: SearchGroupsResponse -> SearchGroupsResponse -> Bool

type Rep SearchGroupsResponse

Defined in Amazonka.QuickSight.SearchGroups

type Rep SearchGroupsResponse = D1 ('MetaData "SearchGroupsResponse" "Amazonka.QuickSight.SearchGroups" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "SearchGroupsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Group])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchGroupsResponse

Arguments

:: Int

SearchGroupsResponse

-> SearchGroupsResponse

Create a value of SearchGroupsResponse 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:groupList:SearchGroupsResponse', searchGroupsResponse_groupList - A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

SearchGroups, searchGroupsResponse_nextToken - A pagination token that can be used in a subsequent request.

$sel:requestId:SearchGroupsResponse', searchGroupsResponse_requestId - The Amazon Web Services request ID for this operation.

SearchGroupsResponse, searchGroupsResponse_status - The HTTP status of the request.

Response Lenses

searchGroupsResponse_groupList :: Lens' SearchGroupsResponse (Maybe [Group])

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

searchGroupsResponse_nextToken :: Lens' SearchGroupsResponse (Maybe Text)

A pagination token that can be used in a subsequent request.

searchGroupsResponse_requestId :: Lens' SearchGroupsResponse (Maybe Text)

The Amazon Web Services request ID for this operation.

searchGroupsResponse_status :: Lens' SearchGroupsResponse Int

The HTTP status of the request.