GetIPSet
Retrieves the IPSet specified by the ipSetId
.
Request Syntax
GET /detector/detectorId
/ipset/ipSetId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The unique ID of the detector that the IPSet is associated with.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- ipSetId
-
The unique ID of the IPSet to retrieve.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"format": "string",
"location": "string",
"name": "string",
"status": "string",
"tags": {
"string" : "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.
- format
-
The format of the file that contains the IPSet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
TXT | STIX | OTX_CSV | ALIEN_VAULT | PROOF_POINT | FIRE_EYE
- location
-
The URI of the file that contains the IPSet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
- name
-
The user-friendly name for the IPSet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
- status
-
The status of IPSet file that was uploaded.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
INACTIVE | ACTIVATING | ACTIVE | DEACTIVATING | ERROR | DELETE_PENDING | DELETED
-
The tags of the IPSet resource.
Type: String to string map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: