InputSecurityGroups
URI
/prod/inputSecurityGroups
HTTP Methods
GET
Operation ID: ListInputSecurityGroups
Produces a list of Input Security Groups for an account
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
nextToken
|
String | False | |
maxResults
|
String | False |
Responses
Status Code | Response Model | Description |
---|---|---|
200
|
ListInputSecurityGroupsResultModel
|
An array of Input Security Groups |
400
|
InvalidRequest
|
This request was invalid. |
500
|
InternalServiceError
|
Unexpected internal service error. |
502
|
None |
Bad Gateway Error |
403
|
AccessDenied
|
You do not have permission to list channels. |
504
|
None |
Gateway Timeout Error |
429
|
LimitExceeded
|
Request limit exceeded on list channel calls to channel service. |
POST
Operation ID: CreateInputSecurityGroup
Creates a Input Security Group
Responses
Status Code | Response Model | Description |
---|---|---|
200
|
CreateInputSecurityGroupResultModel
|
Successfully created the Input Security Group. |
400
|
InvalidRequest
|
This request was invalid. |
500
|
InternalServiceError
|
Unexpected internal service error. |
502
|
None |
Bad Gateway Error |
403
|
AccessDenied
|
You do not have permission to list channels. |
504
|
None |
Gateway Timeout Error |
429
|
LimitExceeded
|
Request limit exceeded on list channel calls to channel service. |
Schemas
Request Bodies
Example POST
{ "whitelistRules": [ { "cidr": "string" } ] }
Response Bodies
Example ListInputSecurityGroupsResultModel
{ "inputSecurityGroups": [ { "id": "string", "arn": "string", "whitelistRules": [ { "cidr": "string" } ] } ], "nextToken": "string" }
Example CreateInputSecurityGroupResultModel
{ "securityGroup": { "id": "string", "arn": "string", "whitelistRules": [ { "cidr": "string" } ] } }
Example InvalidRequest
{ "message": "string" }
Example AccessDenied
{ "message": "string" }
Example LimitExceeded
{ "message": "string" }
Example InternalServiceError
{ "message": "string" }
Properties
Property | Type | Required | Description |
---|---|---|---|
id
|
string |
False |
The Id of the Input Security Group |
arn
|
string |
False |
Unique ARN of Input Security Group |
whitelistRules
|
Array of type InputWhitelistRule |
False |
Whitelist rules and their sync status |
InputSecurityGroupWhitelistRequest
Property | Type | Required | Description |
---|---|---|---|
whitelistRules
|
Array of type InputWhitelistRuleCidr |
False |
List of IPv4 CIDR addresses to whitelist |
ListInputSecurityGroupsResultModel
Property | Type | Required | Description |
---|---|---|---|
inputSecurityGroups
|
Array of type InputSecurityGroup |
False |
List of input security groups |
nextToken
|
string |
False |