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.
`403`	`AccessDenied`	You do not have permission to list channels.
`429`	`LimitExceeded`	Request limit exceeded on list channel calls to channel service.
`500`	`InternalServiceError`	Unexpected internal service error.
`502`	`BadGatewayException`	Bad Gateway Error
`504`	`GatewayTimeoutException`	Gateway Timeout Error

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.
`403`	`AccessDenied`	You do not have permission to list channels.
`429`	`LimitExceeded`	Request limit exceeded on list channel calls to channel service.
`500`	`InternalServiceError`	Unexpected internal service error.
`502`	`BadGatewayException`	Bad Gateway Error
`504`	`GatewayTimeoutException`	Gateway Timeout Error

Schemas

Request Bodies

Example POST


{
  "whitelistRules": [
    {
      "cidr": "string"
    }
  ],
  "tags": {
  }
}

Response Bodies

Example ListInputSecurityGroupsResultModel


{
  "inputSecurityGroups": [
    {
      "inputs": [
        "string"
      ],
      "id": "string",
      "state": enum,
      "arn": "string",
      "whitelistRules": [
        {
          "cidr": "string"
        }
      ],
      "tags": {
      }
    }
  ],
  "nextToken": "string"
}

Example CreateInputSecurityGroupResultModel


{
  "securityGroup": {
    "inputs": [
      "string"
    ],
    "id": "string",
    "state": enum,
    "arn": "string",
    "whitelistRules": [
      {
        "cidr": "string"
      }
    ],
    "tags": {
    }
  }
}

Example InvalidRequest


{
  "message": "string"
}

Example AccessDenied


{
  "message": "string"
}

Example LimitExceeded


{
  "message": "string"
}

Example InternalServiceError


{
  "message": "string"
}

Example BadGatewayException


{
  "message": "string"
}

Example GatewayTimeoutException


{
  "message": "string"
}

Properties

AccessDenied

Property	Type	Required	Description
`message`	string	False

BadGatewayException

Property	Type	Required	Description
`message`	string	False

CreateInputSecurityGroupResultModel

Property	Type	Required	Description
`securityGroup`	InputSecurityGroup	False

GatewayTimeoutException

Property	Type	Required	Description
`message`	string	False

InputSecurityGroup

An Input Security Group

Property	Type	Required	Description
`inputs`	Array of type string	False	The list of inputs currently using this Input Security Group.
`id`	string	False	The Id of the Input Security Group
`state`	InputSecurityGroupState	False	The current state 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
`tags`	Tags	False	A collection of key-value pairs.

InputSecurityGroupState

IDLE
IN_USE
UPDATING
DELETED

InputSecurityGroupWhitelistRequest

Request of IPv4 CIDR addresses to whitelist in a security group.

Property	Type	Required	Description
`whitelistRules`	Array of type InputWhitelistRuleCidr	False	List of IPv4 CIDR addresses to whitelist
`tags`	Tags	False	A collection of key-value pairs.

InputWhitelistRule

Whitelist rule

Property	Type	Required	Description
`cidr`	string	False	The IPv4 CIDR that's whitelisted.

InputWhitelistRuleCidr

An IPv4 CIDR to whitelist.

Property	Type	Required	Description
`cidr`	string	False	The IPv4 CIDR to whitelist.

InternalServiceError

Property	Type	Required	Description
`message`	string	False

InvalidRequest

Property	Type	Required	Description
`message`	string	False

LimitExceeded

Property	Type	Required	Description
`message`	string	False

ListInputSecurityGroupsResultModel

Result of input security group list request

Property	Type	Required	Description
`inputSecurityGroups`	Array of type InputSecurityGroup	False	List of input security groups
`nextToken`	string	False