Amazonka.IotTwinMaker.ListEntities

Lists all entities in a workspace.

Creating a Request

data ListEntities

See: newListEntities smart constructor.

Constructors

ListEntities'

Fields

• filters :: Maybe [ListEntitiesFilter]

  A list of objects that filter the request.

  Only one object is accepted as a valid input.

• maxResults :: Maybe Natural

  The maximum number of results to return at one time. The default is 25.

  Valid Range: Minimum value of 1. Maximum value of 250.

• nextToken :: Maybe Text

  The string that specifies the next page of results.

• workspaceId :: Text

  The ID of the workspace.

Instances

ToJSON ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

toJSON :: ListEntities -> Value

toEncoding :: ListEntities -> Encoding

toJSONList :: [ListEntities] -> Value

toEncodingList :: [ListEntities] -> Encoding

ToHeaders ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

toHeaders :: ListEntities -> [Header]

ToPath ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

toPath :: ListEntities -> ByteString

ToQuery ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

toQuery :: ListEntities -> QueryString

AWSRequest ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Associated Types

type AWSResponse ListEntities

Methods

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

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

Generic ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Associated Types

type Rep ListEntities :: Type -> Type

Methods

from :: ListEntities -> Rep ListEntities x

to :: Rep ListEntities x -> ListEntities

Read ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

readsPrec :: Int -> ReadS ListEntities

readList :: ReadS [ListEntities]

readPrec :: ReadPrec ListEntities

readListPrec :: ReadPrec [ListEntities]

Show ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

showsPrec :: Int -> ListEntities -> ShowS

show :: ListEntities -> String

showList :: [ListEntities] -> ShowS

NFData ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

rnf :: ListEntities -> ()

Eq ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

(==) :: ListEntities -> ListEntities -> Bool

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

Hashable ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

hashWithSalt :: Int -> ListEntities -> Int

hash :: ListEntities -> Int

type AWSResponse ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

type AWSResponse ListEntities = ListEntitiesResponse

type Rep ListEntities

Defined in Amazonka.IotTwinMaker.ListEntities

type Rep ListEntities = D1 ('MetaData "ListEntities" "Amazonka.IotTwinMaker.ListEntities" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ListEntities'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ListEntitiesFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListEntities

Arguments

:: Text

ListEntities

-> ListEntities

Create a value of ListEntities 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:filters:ListEntities', listEntities_filters - A list of objects that filter the request.

Only one object is accepted as a valid input.

$sel:maxResults:ListEntities', listEntities_maxResults - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

ListEntities, listEntities_nextToken - The string that specifies the next page of results.

ListEntities, listEntities_workspaceId - The ID of the workspace.

Request Lenses

listEntities_filters :: Lens' ListEntities (Maybe [ListEntitiesFilter])

A list of objects that filter the request.

Only one object is accepted as a valid input.

listEntities_maxResults :: Lens' ListEntities (Maybe Natural)

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

listEntities_nextToken :: Lens' ListEntities (Maybe Text)

The string that specifies the next page of results.

listEntities_workspaceId :: Lens' ListEntities Text

The ID of the workspace.

Destructuring the Response

data ListEntitiesResponse

See: newListEntitiesResponse smart constructor.

Constructors

ListEntitiesResponse'

Fields

• entitySummaries :: Maybe [EntitySummary]

  A list of objects that contain information about the entities.

• nextToken :: Maybe Text

  The string that specifies the next page of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

Associated Types

type Rep ListEntitiesResponse :: Type -> Type

Methods

from :: ListEntitiesResponse -> Rep ListEntitiesResponse x

to :: Rep ListEntitiesResponse x -> ListEntitiesResponse

Read ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

readsPrec :: Int -> ReadS ListEntitiesResponse

readList :: ReadS [ListEntitiesResponse]

readPrec :: ReadPrec ListEntitiesResponse

readListPrec :: ReadPrec [ListEntitiesResponse]

Show ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

showsPrec :: Int -> ListEntitiesResponse -> ShowS

show :: ListEntitiesResponse -> String

showList :: [ListEntitiesResponse] -> ShowS

NFData ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

rnf :: ListEntitiesResponse -> ()

Eq ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

Methods

(==) :: ListEntitiesResponse -> ListEntitiesResponse -> Bool

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

type Rep ListEntitiesResponse

Defined in Amazonka.IotTwinMaker.ListEntities

type Rep ListEntitiesResponse = D1 ('MetaData "ListEntitiesResponse" "Amazonka.IotTwinMaker.ListEntities" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "ListEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntitySummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntitiesResponse

Arguments

:: Int

$sel:httpStatus:ListEntitiesResponse'

-> ListEntitiesResponse

Create a value of ListEntitiesResponse 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:entitySummaries:ListEntitiesResponse', listEntitiesResponse_entitySummaries - A list of objects that contain information about the entities.

ListEntities, listEntitiesResponse_nextToken - The string that specifies the next page of results.

$sel:httpStatus:ListEntitiesResponse', listEntitiesResponse_httpStatus - The response's http status code.

Response Lenses

listEntitiesResponse_entitySummaries :: Lens' ListEntitiesResponse (Maybe [EntitySummary])

A list of objects that contain information about the entities.

listEntitiesResponse_nextToken :: Lens' ListEntitiesResponse (Maybe Text)

The string that specifies the next page of results.

listEntitiesResponse_httpStatus :: Lens' ListEntitiesResponse Int

The response's http status code.