{ "opencollection": "1.0.0", "info": { "name": "AWS IoT Accept Certificate Transfer Security Profiles API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Security Profiles", "type": "folder" }, "items": [ { "info": { "name": "Amazon IoT Device Management Attach Security Profile", "type": "http" }, "http": { "method": "PUT", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName/targets#securityProfileTargetArn", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The security profile that is attached." }, { "name": "securityProfileTargetArn", "value": "", "type": "query", "description": "The ARN of the target (thing group) to which the security profile is attached." } ] }, "docs": "
Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management Detach Security Profile", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName/targets#securityProfileTargetArn", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The security profile that is detached." }, { "name": "securityProfileTargetArn", "value": "", "type": "query", "description": "The ARN of the thing group from which the security profile is detached." } ] }, "docs": "Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management Describe Security Profile", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The name of the security profile whose information you want to get." } ] }, "docs": "Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management Create Security Profile", "type": "http" }, "http": { "method": "POST", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The name you are giving to the security profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management Update Security Profile", "type": "http" }, "http": { "method": "PATCH", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The name of the security profile you want to update." }, { "name": "expectedVersion", "value": "", "type": "query", "description": "The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, aVersionConflictException is thrown."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management Delete Security Profile", "type": "http" }, "http": { "method": "DELETE", "url": "http://iot.{region}.amazonaws.com/security-profiles/:securityProfileName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "securityProfileName", "value": "", "type": "path", "description": "The name of the security profile to be deleted." }, { "name": "expectedVersion", "value": "", "type": "query", "description": "The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, aVersionConflictException is thrown."
}
]
},
"docs": "Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
" }, { "info": { "name": "Amazon IoT Device Management List Security Profiles", "type": "http" }, "http": { "method": "GET", "url": "http://iot.{region}.amazonaws.com/security-profiles", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "The token for the next set of results." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to return at one time." }, { "name": "dimensionName", "value": "", "type": "query", "description": "A filter to limit results to the security profiles that use the defined dimension. Cannot be used withmetricName "
},
{
"name": "metricName",
"value": "",
"type": "query",
"description": " The name of the custom metric. Cannot be used with dimensionName. "
}
]
},
"docs": "Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName and metricName cannot be used in the same request.
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
" } ] } ], "bundled": true }