UpdateConfig
Updates the Config
used when scheduling contacts.
Updating a Config
will not update the execution parameters
for existing future contacts scheduled with this Config
.
Request Syntax
PUT /config/configType
/configId
HTTP/1.1
Content-type: application/json
{
"configData": { ... },
"name": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- configId
-
UUID of a
Config
.Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes
- configType
-
Type of a
Config
.Valid Values:
antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording
Required: Yes
Request Body
The request accepts the following data in JSON format.
- configData
-
Parameters of a
Config
.Type: ConfigTypeData object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- name
-
Name of a
Config
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[ a-zA-Z0-9_:-]{1,256}$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"configArn": "string",
"configId": "string",
"configType": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- configArn
-
ARN of a
Config
.Type: String
- configId
-
UUID of a
Config
.Type: String
- configType
-
Type of a
Config
.Type: String
Valid Values:
antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording
Errors
For information about the errors that are common to all actions, see Common Errors.
- DependencyException
-
Dependency encountered an error.
HTTP Status Code: 531
- InvalidParameterException
-
One or more parameters are not valid.
HTTP Status Code: 431
- ResourceNotFoundException
-
Resource was not found.
HTTP Status Code: 434
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: