Amazonka.ResourceGroups.SearchResources

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

• resource-groups:SearchResources

• cloudformation:DescribeStacks

• cloudformation:ListStackResources

• tag:GetResources

This operation returns paginated results.

Creating a Request

data SearchResources

See: newSearchResources smart constructor.

Constructors

SearchResources'

Fields

• maxResults :: Maybe Natural

  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 the service 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.

• nextToken :: Maybe Text

  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 provided by a previous call's NextToken response to indicate where the output should continue from.

• resourceQuery :: ResourceQuery

  The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Instances

ToJSON SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

toJSON :: SearchResources -> Value

toEncoding :: SearchResources -> Encoding

toJSONList :: [SearchResources] -> Value

toEncodingList :: [SearchResources] -> Encoding

ToHeaders SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

toHeaders :: SearchResources -> [Header]

ToPath SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

toPath :: SearchResources -> ByteString

ToQuery SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

toQuery :: SearchResources -> QueryString

AWSPager SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

page :: SearchResources -> AWSResponse SearchResources -> Maybe SearchResources

AWSRequest SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Associated Types

type AWSResponse SearchResources

Methods

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

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

Generic SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Associated Types

type Rep SearchResources :: Type -> Type

Methods

from :: SearchResources -> Rep SearchResources x

to :: Rep SearchResources x -> SearchResources

Read SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

readsPrec :: Int -> ReadS SearchResources

readList :: ReadS [SearchResources]

readPrec :: ReadPrec SearchResources

readListPrec :: ReadPrec [SearchResources]

Show SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

showsPrec :: Int -> SearchResources -> ShowS

show :: SearchResources -> String

showList :: [SearchResources] -> ShowS

NFData SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

rnf :: SearchResources -> ()

Eq SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

(==) :: SearchResources -> SearchResources -> Bool

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

Hashable SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

Methods

hashWithSalt :: Int -> SearchResources -> Int

hash :: SearchResources -> Int

type AWSResponse SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

type AWSResponse SearchResources = SearchResourcesResponse

type Rep SearchResources

Defined in Amazonka.ResourceGroups.SearchResources

type Rep SearchResources = D1 ('MetaData "SearchResources" "Amazonka.ResourceGroups.SearchResources" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" 'False) (C1 ('MetaCons "SearchResources'" '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 "resourceQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceQuery))))

newSearchResources

Arguments

:: ResourceQuery

SearchResources

-> SearchResources

Create a value of SearchResources 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:SearchResources', searchResources_maxResults - 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 the service 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.

SearchResources, searchResources_nextToken - 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 provided by a previous call's NextToken response to indicate where the output should continue from.

SearchResources, searchResources_resourceQuery - The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Request Lenses

searchResources_maxResults :: Lens' SearchResources (Maybe Natural)

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 the service 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.

searchResources_nextToken :: Lens' SearchResources (Maybe Text)

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 provided by a previous call's NextToken response to indicate where the output should continue from.

searchResources_resourceQuery :: Lens' SearchResources ResourceQuery

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Destructuring the Response

data SearchResourcesResponse

See: newSearchResourcesResponse smart constructor.

Constructors

SearchResourcesResponse'

Fields

• nextToken :: Maybe Text

  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.

• queryErrors :: Maybe [QueryError]

  A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

• resourceIdentifiers :: Maybe [ResourceIdentifier]

  The ARNs and resource types of resources that are members of the group that you specified.

• httpStatus :: Int

  The response's http status code.

Instances

Generic SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

Associated Types

type Rep SearchResourcesResponse :: Type -> Type

Methods

from :: SearchResourcesResponse -> Rep SearchResourcesResponse x

to :: Rep SearchResourcesResponse x -> SearchResourcesResponse

Read SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

Methods

readsPrec :: Int -> ReadS SearchResourcesResponse

readList :: ReadS [SearchResourcesResponse]

readPrec :: ReadPrec SearchResourcesResponse

readListPrec :: ReadPrec [SearchResourcesResponse]

Show SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

Methods

showsPrec :: Int -> SearchResourcesResponse -> ShowS

show :: SearchResourcesResponse -> String

showList :: [SearchResourcesResponse] -> ShowS

NFData SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

Methods

rnf :: SearchResourcesResponse -> ()

Eq SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

Methods

(==) :: SearchResourcesResponse -> SearchResourcesResponse -> Bool

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

type Rep SearchResourcesResponse

Defined in Amazonka.ResourceGroups.SearchResources

type Rep SearchResourcesResponse = D1 ('MetaData "SearchResourcesResponse" "Amazonka.ResourceGroups.SearchResources" "amazonka-resourcegroups-2.0-B1PbpVYkdAmDCiu1dJFqfU" 'False) (C1 ('MetaCons "SearchResourcesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueryError]))) :*: (S1 ('MetaSel ('Just "resourceIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceIdentifier])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchResourcesResponse

Arguments

:: Int

$sel:httpStatus:SearchResourcesResponse'

-> SearchResourcesResponse

Create a value of SearchResourcesResponse 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:

SearchResources, searchResourcesResponse_nextToken - 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.

$sel:queryErrors:SearchResourcesResponse', searchResourcesResponse_queryErrors - A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

$sel:resourceIdentifiers:SearchResourcesResponse', searchResourcesResponse_resourceIdentifiers - The ARNs and resource types of resources that are members of the group that you specified.

$sel:httpStatus:SearchResourcesResponse', searchResourcesResponse_httpStatus - The response's http status code.

Response Lenses

searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (Maybe Text)

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.

searchResourcesResponse_queryErrors :: Lens' SearchResourcesResponse (Maybe [QueryError])

A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

searchResourcesResponse_resourceIdentifiers :: Lens' SearchResourcesResponse (Maybe [ResourceIdentifier])

The ARNs and resource types of resources that are members of the group that you specified.

searchResourcesResponse_httpStatus :: Lens' SearchResourcesResponse Int

The response's http status code.