Input security groups: group ID
URI
/prod/inputSecurityGroups/
inputSecurityGroupId
HTTP methods
DELETE
Operation ID: DeleteInputSecurityGroup
Name | Type | Required | Description |
---|---|---|---|
inputSecurityGroupId | String | True |
Status code | Response model | Description |
---|---|---|
200 | Empty | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
404 | ResourceNotFound | 404 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
GET
Operation ID: DescribeInputSecurityGroup
Name | Type | Required | Description |
---|---|---|---|
inputSecurityGroupId | String | True |
Status code | Response model | Description |
---|---|---|
200 | InputSecurityGroup | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
404 | ResourceNotFound | 404 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
PUT
Operation ID: UpdateInputSecurityGroup
Name | Type | Required | Description |
---|---|---|---|
inputSecurityGroupId | String | True |
Status code | Response model | Description |
---|---|---|
200 | UpdateInputSecurityGroupResultModel | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
404 | ResourceNotFound | 404 response |
409 | ResourceConflict | 409 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
Schemas
Request bodies
{ "tags": { }, "whitelistRules": [ { "cidr": "string" } ] }
Response bodies
{ }
{ "arn": "string", "id": "string", "inputs": [ "string" ], "state": enum, "tags": { }, "whitelistRules": [ { "cidr": "string" } ] }
{ "securityGroup": { "arn": "string", "id": "string", "inputs": [ "string" ], "state": enum, "tags": { }, "whitelistRules": [ { "cidr": "string" } ] } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
Properties
AccessDenied
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
BadGatewayException
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
Empty
GatewayTimeoutException
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
InputSecurityGroup
An Input Security Group
Property | Type | Required | Description |
---|---|---|---|
arn | string | False | Unique ARN of Input Security Group |
id | string | False | The Id of the Input Security Group |
inputs | Array of type string | False | The list of inputs currently using this Input Security Group. |
state | False | The current state of the Input Security Group. | |
tags | False | A collection of key-value pairs. | |
whitelistRules | Array of type InputWhitelistRule | False | Whitelist rules and their sync status |
InputSecurityGroupState
IDLE
IN_USE
UPDATING
DELETED
InputSecurityGroupWhitelistRequest
Request of IPv4 CIDR addresses to whitelist in a security group.
Property | Type | Required | Description |
---|---|---|---|
tags | False | A collection of key-value pairs. | |
whitelistRules | Array of type InputWhitelistRuleCidr | False | List of IPv4 CIDR addresses to whitelist |
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 |
ResourceConflict
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
ResourceNotFound
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
Tags
Property | Type | Required | Description |
---|---|---|---|
| string | False |
UpdateInputSecurityGroupResultModel
Property | Type | Required | Description |
---|---|---|---|
securityGroup | False |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: