Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves information about an entity.
Synopsis
- data GetEntity = GetEntity' {
- workspaceId :: Text
- entityId :: Text
- newGetEntity :: Text -> Text -> GetEntity
- getEntity_workspaceId :: Lens' GetEntity Text
- getEntity_entityId :: Lens' GetEntity Text
- data GetEntityResponse = GetEntityResponse' {
- components :: Maybe (HashMap Text ComponentResponse)
- description :: Maybe Text
- syncSource :: Maybe Text
- httpStatus :: Int
- entityId :: Text
- entityName :: Text
- arn :: Text
- status :: Status
- workspaceId :: Text
- parentEntityId :: Text
- hasChildEntities :: Bool
- creationDateTime :: POSIX
- updateDateTime :: POSIX
- newGetEntityResponse :: Int -> Text -> Text -> Text -> Status -> Text -> Text -> Bool -> UTCTime -> UTCTime -> GetEntityResponse
- getEntityResponse_components :: Lens' GetEntityResponse (Maybe (HashMap Text ComponentResponse))
- getEntityResponse_description :: Lens' GetEntityResponse (Maybe Text)
- getEntityResponse_syncSource :: Lens' GetEntityResponse (Maybe Text)
- getEntityResponse_httpStatus :: Lens' GetEntityResponse Int
- getEntityResponse_entityId :: Lens' GetEntityResponse Text
- getEntityResponse_entityName :: Lens' GetEntityResponse Text
- getEntityResponse_arn :: Lens' GetEntityResponse Text
- getEntityResponse_status :: Lens' GetEntityResponse Status
- getEntityResponse_workspaceId :: Lens' GetEntityResponse Text
- getEntityResponse_parentEntityId :: Lens' GetEntityResponse Text
- getEntityResponse_hasChildEntities :: Lens' GetEntityResponse Bool
- getEntityResponse_creationDateTime :: Lens' GetEntityResponse UTCTime
- getEntityResponse_updateDateTime :: Lens' GetEntityResponse UTCTime
Creating a Request
See: newGetEntity
smart constructor.
GetEntity' | |
|
Instances
Create a value of GetEntity
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:
GetEntity
, getEntity_workspaceId
- The ID of the workspace.
GetEntity
, getEntity_entityId
- The ID of the entity.
Request Lenses
Destructuring the Response
data GetEntityResponse Source #
See: newGetEntityResponse
smart constructor.
GetEntityResponse' | |
|
Instances
Create a value of GetEntityResponse
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:components:GetEntityResponse'
, getEntityResponse_components
- An object that maps strings to the components in the entity. Each string
in the mapping must be unique to this object.
GetEntityResponse
, getEntityResponse_description
- The description of the entity.
GetEntityResponse
, getEntityResponse_syncSource
- The syncSource of the sync job, if this entity was created by a sync
job.
$sel:httpStatus:GetEntityResponse'
, getEntityResponse_httpStatus
- The response's http status code.
GetEntity
, getEntityResponse_entityId
- The ID of the entity.
GetEntityResponse
, getEntityResponse_entityName
- The name of the entity.
GetEntityResponse
, getEntityResponse_arn
- The ARN of the entity.
GetEntityResponse
, getEntityResponse_status
- The current status of the entity.
GetEntity
, getEntityResponse_workspaceId
- The ID of the workspace.
GetEntityResponse
, getEntityResponse_parentEntityId
- The ID of the parent entity for this entity.
GetEntityResponse
, getEntityResponse_hasChildEntities
- A Boolean value that specifies whether the entity has associated child
entities.
GetEntityResponse
, getEntityResponse_creationDateTime
- The date and time when the entity was created.
GetEntityResponse
, getEntityResponse_updateDateTime
- The date and time when the entity was last updated.
Response Lenses
getEntityResponse_components :: Lens' GetEntityResponse (Maybe (HashMap Text ComponentResponse)) Source #
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
getEntityResponse_description :: Lens' GetEntityResponse (Maybe Text) Source #
The description of the entity.
getEntityResponse_syncSource :: Lens' GetEntityResponse (Maybe Text) Source #
The syncSource of the sync job, if this entity was created by a sync job.
getEntityResponse_httpStatus :: Lens' GetEntityResponse Int Source #
The response's http status code.
getEntityResponse_entityId :: Lens' GetEntityResponse Text Source #
The ID of the entity.
getEntityResponse_entityName :: Lens' GetEntityResponse Text Source #
The name of the entity.
getEntityResponse_arn :: Lens' GetEntityResponse Text Source #
The ARN of the entity.
getEntityResponse_status :: Lens' GetEntityResponse Status Source #
The current status of the entity.
getEntityResponse_workspaceId :: Lens' GetEntityResponse Text Source #
The ID of the workspace.
getEntityResponse_parentEntityId :: Lens' GetEntityResponse Text Source #
The ID of the parent entity for this entity.
getEntityResponse_hasChildEntities :: Lens' GetEntityResponse Bool Source #
A Boolean value that specifies whether the entity has associated child entities.
getEntityResponse_creationDateTime :: Lens' GetEntityResponse UTCTime Source #
The date and time when the entity was created.
getEntityResponse_updateDateTime :: Lens' GetEntityResponse UTCTime Source #
The date and time when the entity was last updated.