AWS IoT Fleet Hub 2020-11-03
- Client: Aws\IoTFleetHub\IoTFleetHubClient
- Service ID: iotfleethub
- Version: 2020-11-03
This page describes the parameters and results for the operations of the AWS IoT Fleet Hub (2020-11-03), and shows how to use the Aws\IoTFleetHub\IoTFleetHubClient object to call the described operations. This documentation is specific to the 2020-11-03 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateApplication ( array $params = [] )
Creates a Fleet Hub for AWS IoT Device Management web application.
- DeleteApplication ( array $params = [] )
Deletes a Fleet Hub for AWS IoT Device Management web application.
- DescribeApplication ( array $params = [] )
Gets information about a Fleet Hub for AWS IoT Device Management web application.
- ListApplications ( array $params = [] )
Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- TagResource ( array $params = [] )
Adds to or modifies the tags of the specified resource.
- UntagResource ( array $params = [] )
Removes the specified tags (metadata) from the resource.
- UpdateApplication ( array $params = [] )
Updates information about a Fleet Hub for a AWS IoT Device Management web application.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateApplication
$result = $client->createApplication([/* ... */]); $promise = $client->createApplicationAsync([/* ... */]);
Creates a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->createApplication([
'applicationDescription' => '<string>',
'applicationName' => '<string>', // REQUIRED
'clientToken' => '<string>',
'roleArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- applicationDescription
-
- Type: string
An optional description of the web application.
- applicationName
-
- Required: Yes
- Type: string
The name of the web application.
- clientToken
-
- Type: string
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.
- roleArn
-
- Required: Yes
- Type: string
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. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of key/value pairs that you can use to manage the web application resource.
Result Syntax
[
'applicationArn' => '<string>',
'applicationId' => '<string>',
]
Result Details
Members
Errors
-
The request is not valid.
-
An unexpected error has occurred.
-
The rate exceeds the limit.
-
A limit has been exceeded.
DeleteApplication
$result = $client->deleteApplication([/* ... */]); $promise = $client->deleteApplicationAsync([/* ... */]);
Deletes a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->deleteApplication([
'applicationId' => '<string>', // REQUIRED
'clientToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request is not valid.
-
The specified resource does not exist.
-
An unexpected error has occurred.
-
The rate exceeds the limit.
DescribeApplication
$result = $client->describeApplication([/* ... */]); $promise = $client->describeApplicationAsync([/* ... */]);
Gets information about a Fleet Hub for AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->describeApplication([
'applicationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'applicationArn' => '<string>',
'applicationCreationDate' => <integer>,
'applicationDescription' => '<string>',
'applicationId' => '<string>',
'applicationLastUpdateDate' => <integer>,
'applicationName' => '<string>',
'applicationState' => 'CREATING|DELETING|ACTIVE|CREATE_FAILED|DELETE_FAILED',
'applicationUrl' => '<string>',
'errorMessage' => '<string>',
'roleArn' => '<string>',
'ssoClientId' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- applicationArn
-
- Required: Yes
- Type: string
The ARN of the web application.
- applicationCreationDate
-
- Required: Yes
- Type: long (int|float)
The date (in Unix epoch time) when the application was created.
- applicationDescription
-
- Type: string
An optional description of the web application.
- applicationId
-
- Required: Yes
- Type: string
The unique Id of the web application.
- applicationLastUpdateDate
-
- Required: Yes
- Type: long (int|float)
The date (in Unix epoch time) when the application was last updated.
- applicationName
-
- Required: Yes
- Type: string
The name of the web application.
- applicationState
-
- Required: Yes
- Type: string
The current state of the web application.
- applicationUrl
-
- Required: Yes
- Type: string
The URL of the web application.
- errorMessage
-
- Type: string
A message indicating why the
DescribeApplicationAPI failed. - roleArn
-
- Required: Yes
- Type: string
The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
- ssoClientId
-
- Type: string
The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A set of key/value pairs that you can use to manage the web application resource.
Errors
-
The request is not valid.
-
The specified resource does not exist.
-
An unexpected error has occurred.
-
The rate exceeds the limit.
ListApplications
$result = $client->listApplications([/* ... */]); $promise = $client->listApplicationsAsync([/* ... */]);
Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->listApplications([
'nextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'applicationSummaries' => [
[
'applicationCreationDate' => <integer>,
'applicationDescription' => '<string>',
'applicationId' => '<string>',
'applicationLastUpdateDate' => <integer>,
'applicationName' => '<string>',
'applicationState' => 'CREATING|DELETING|ACTIVE|CREATE_FAILED|DELETE_FAILED',
'applicationUrl' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- applicationSummaries
-
- Type: Array of ApplicationSummary structures
An array of objects that provide summaries of information about the web applications in the list.
- nextToken
-
- Type: string
A token used to get the next set of results.
Errors
-
The request is not valid.
-
An unexpected error has occurred.
-
The rate exceeds the limit.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
An unexpected error has occurred.
-
The request is not valid.
-
The specified resource does not exist.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An unexpected error has occurred.
-
The request is not valid.
-
The specified resource does not exist.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the specified tags (metadata) from the resource.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An unexpected error has occurred.
-
The request is not valid.
-
The specified resource does not exist.
UpdateApplication
$result = $client->updateApplication([/* ... */]); $promise = $client->updateApplicationAsync([/* ... */]);
Updates information about a Fleet Hub for a AWS IoT Device Management web application.
Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
Parameter Syntax
$result = $client->updateApplication([
'applicationDescription' => '<string>',
'applicationId' => '<string>', // REQUIRED
'applicationName' => '<string>',
'clientToken' => '<string>',
]);
Parameter Details
Members
- applicationDescription
-
- Type: string
An optional description of the web application.
- applicationId
-
- Required: Yes
- Type: string
The unique Id of the web application.
- applicationName
-
- Type: string
The name of the web application.
- clientToken
-
- Type: string
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.
Result Syntax
[]
Result Details
Errors
-
The request is not valid.
-
The specified resource does not exist.
-
An unexpected error has occurred.
-
The request conflicts with the current state of the resource.
-
The rate exceeds the limit.
Shapes
ApplicationSummary
Description
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.
Members
- applicationCreationDate
-
- Type: long (int|float)
The date (in Unix epoch time) when the web application was created.
- applicationDescription
-
- Type: string
An optional description of the web application.
- applicationId
-
- Required: Yes
- Type: string
The unique Id of the web application.
- applicationLastUpdateDate
-
- Type: long (int|float)
The date (in Unix epoch time) when the web application was last updated.
- applicationName
-
- Required: Yes
- Type: string
The name of the web application.
- applicationState
-
- Type: string
The current state of the web application.
- applicationUrl
-
- Required: Yes
- Type: string
The URL of the web application.
ConflictException
Description
The request conflicts with the current state of the resource.