| 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 |
Amazonka.IoTFleetHub
Description
Derived from API version 2020-11-03 of the AWS service descriptions, licensed under Apache 2.0.
With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- data CreateApplication = CreateApplication' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateApplication :: Text -> Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' Int Text Text
- newCreateApplicationResponse :: Int -> Text -> Text -> CreateApplicationResponse
- data DeleteApplication = DeleteApplication' (Maybe Text) Text
- newDeleteApplication :: Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' Int
- newDeleteApplicationResponse :: Int -> DeleteApplicationResponse
- data DescribeApplication = DescribeApplication' Text
- newDescribeApplication :: Text -> DescribeApplication
- data DescribeApplicationResponse = DescribeApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text Text Text ApplicationState Integer Integer Text
- newDescribeApplicationResponse :: Int -> Text -> Text -> Text -> Text -> ApplicationState -> Integer -> Integer -> Text -> DescribeApplicationResponse
- data ListApplications = ListApplications' (Maybe Text)
- newListApplications :: ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' (Maybe [ApplicationSummary]) (Maybe Text) Int
- newListApplicationsResponse :: Int -> ListApplicationsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data UpdateApplicationResponse = UpdateApplicationResponse' Int
- newUpdateApplicationResponse :: Int -> UpdateApplicationResponse
- newtype ApplicationState where
- ApplicationState' { }
- pattern ApplicationState_ACTIVE :: ApplicationState
- pattern ApplicationState_CREATE_FAILED :: ApplicationState
- pattern ApplicationState_CREATING :: ApplicationState
- pattern ApplicationState_DELETE_FAILED :: ApplicationState
- pattern ApplicationState_DELETING :: ApplicationState
- data ApplicationSummary = ApplicationSummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe ApplicationState) Text Text Text
- newApplicationSummary :: Text -> Text -> Text -> ApplicationSummary
Service Configuration
defaultService :: Service Source #
API version 2020-11-03 of the Amazon IoT Fleet Hub SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTFleetHub.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request conflicts with the current state of the resource.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An unexpected error has occurred.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request is not valid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit has been exceeded.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The rate exceeds the limit.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateApplication
data CreateApplication Source #
See: newCreateApplication smart constructor.
Instances
Create a value of CreateApplication 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:
CreateApplication, createApplication_applicationDescription - An optional description of the web application.
$sel:clientToken:CreateApplication', createApplication_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
$sel:tags:CreateApplication', createApplication_tags - A set of key/value pairs that you can use to manage the web application
resource.
CreateApplication, createApplication_applicationName - The name of the web application.
$sel:roleArn:CreateApplication', createApplication_roleArn - The ARN of the role that the web application assumes when it interacts
with AWS IoT Core.
The name of the role must be in the form
AWSIotFleetHub_random_string .
data CreateApplicationResponse Source #
See: newCreateApplicationResponse smart constructor.
Constructors
| CreateApplicationResponse' Int Text Text |
Instances
newCreateApplicationResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateApplicationResponse |
Create a value of CreateApplicationResponse 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:httpStatus:CreateApplicationResponse', createApplicationResponse_httpStatus - The response's http status code.
CreateApplicationResponse, createApplicationResponse_applicationId - The unique Id of the web application.
$sel:applicationArn:CreateApplicationResponse', createApplicationResponse_applicationArn - The ARN of the web application.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication smart constructor.
Constructors
| DeleteApplication' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteApplication |
Create a value of DeleteApplication 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:clientToken:DeleteApplication', deleteApplication_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
DeleteApplication, deleteApplication_applicationId - The unique Id of the web application.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse smart constructor.
Constructors
| DeleteApplicationResponse' Int |
Instances
newDeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse 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:httpStatus:DeleteApplicationResponse', deleteApplicationResponse_httpStatus - The response's http status code.
DescribeApplication
data DescribeApplication Source #
See: newDescribeApplication smart constructor.
Constructors
| DescribeApplication' Text |
Instances
newDescribeApplication Source #
Arguments
| :: Text | |
| -> DescribeApplication |
Create a value of DescribeApplication 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:
DescribeApplication, describeApplication_applicationId - The unique Id of the web application.
data DescribeApplicationResponse Source #
See: newDescribeApplicationResponse smart constructor.
Constructors
| DescribeApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text Text Text ApplicationState Integer Integer Text |
Instances
newDescribeApplicationResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ApplicationState | |
| -> Integer | |
| -> Integer | |
| -> Text | |
| -> DescribeApplicationResponse |
Create a value of DescribeApplicationResponse 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:
DescribeApplicationResponse, describeApplicationResponse_applicationDescription - An optional description of the web application.
$sel:errorMessage:DescribeApplicationResponse', describeApplicationResponse_errorMessage - A message indicating why the DescribeApplication API failed.
$sel:ssoClientId:DescribeApplicationResponse', describeApplicationResponse_ssoClientId - The Id of the single sign-on client that you use to authenticate and
authorize users on the web application.
$sel:tags:DescribeApplicationResponse', describeApplicationResponse_tags - A set of key/value pairs that you can use to manage the web application
resource.
$sel:httpStatus:DescribeApplicationResponse', describeApplicationResponse_httpStatus - The response's http status code.
DescribeApplication, describeApplicationResponse_applicationId - The unique Id of the web application.
$sel:applicationArn:DescribeApplicationResponse', describeApplicationResponse_applicationArn - The ARN of the web application.
DescribeApplicationResponse, describeApplicationResponse_applicationName - The name of the web application.
DescribeApplicationResponse, describeApplicationResponse_applicationUrl - The URL of the web application.
DescribeApplicationResponse, describeApplicationResponse_applicationState - The current state of the web application.
DescribeApplicationResponse, describeApplicationResponse_applicationCreationDate - The date (in Unix epoch time) when the application was created.
DescribeApplicationResponse, describeApplicationResponse_applicationLastUpdateDate - The date (in Unix epoch time) when the application was last updated.
$sel:roleArn:DescribeApplicationResponse', describeApplicationResponse_roleArn - The ARN of the role that the web application assumes when it interacts
with AWS IoT Core.
ListApplications (Paginated)
data ListApplications Source #
See: newListApplications smart constructor.
Constructors
| ListApplications' (Maybe Text) |
Instances
newListApplications :: ListApplications Source #
Create a value of ListApplications 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:
ListApplications, listApplications_nextToken - A token used to get the next set of results.
data ListApplicationsResponse Source #
See: newListApplicationsResponse smart constructor.
Constructors
| ListApplicationsResponse' (Maybe [ApplicationSummary]) (Maybe Text) Int |
Instances
newListApplicationsResponse Source #
Create a value of ListApplicationsResponse 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:applicationSummaries:ListApplicationsResponse', listApplicationsResponse_applicationSummaries - An array of objects that provide summaries of information about the web
applications in the list.
ListApplications, listApplicationsResponse_nextToken - A token used to get the next set of results.
$sel:httpStatus:ListApplicationsResponse', listApplicationsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource.
$sel:tags:TagResource', tagResource_tags - The new or modified tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of the keys of the tags to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateApplication |
Create a value of UpdateApplication 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:
UpdateApplication, updateApplication_applicationDescription - An optional description of the web application.
UpdateApplication, updateApplication_applicationName - The name of the web application.
$sel:clientToken:UpdateApplication', updateApplication_clientToken - A unique case-sensitive identifier that you can provide to ensure the
idempotency of the request. Don't reuse this client token if a new
idempotent request is required.
UpdateApplication, updateApplication_applicationId - The unique Id of the web application.
data UpdateApplicationResponse Source #
See: newUpdateApplicationResponse smart constructor.
Constructors
| UpdateApplicationResponse' Int |
Instances
newUpdateApplicationResponse Source #
Create a value of UpdateApplicationResponse 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:httpStatus:UpdateApplicationResponse', updateApplicationResponse_httpStatus - The response's http status code.
Types
ApplicationState
newtype ApplicationState Source #
Constructors
| ApplicationState' | |
Fields | |
Bundled Patterns
| pattern ApplicationState_ACTIVE :: ApplicationState | |
| pattern ApplicationState_CREATE_FAILED :: ApplicationState | |
| pattern ApplicationState_CREATING :: ApplicationState | |
| pattern ApplicationState_DELETE_FAILED :: ApplicationState | |
| pattern ApplicationState_DELETING :: ApplicationState |
Instances
ApplicationSummary
data ApplicationSummary Source #
A summary of information about a AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
See: newApplicationSummary smart constructor.
Constructors
| ApplicationSummary' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe ApplicationState) Text Text Text |
Instances
newApplicationSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ApplicationSummary |
Create a value of ApplicationSummary 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:applicationCreationDate:ApplicationSummary', applicationSummary_applicationCreationDate - The date (in Unix epoch time) when the web application was created.
$sel:applicationDescription:ApplicationSummary', applicationSummary_applicationDescription - An optional description of the web application.
$sel:applicationLastUpdateDate:ApplicationSummary', applicationSummary_applicationLastUpdateDate - The date (in Unix epoch time) when the web application was last updated.
$sel:applicationState:ApplicationSummary', applicationSummary_applicationState - The current state of the web application.
$sel:applicationId:ApplicationSummary', applicationSummary_applicationId - The unique Id of the web application.
$sel:applicationName:ApplicationSummary', applicationSummary_applicationName - The name of the web application.
$sel:applicationUrl:ApplicationSummary', applicationSummary_applicationUrl - The URL of the web application.