Input security groups: group ID - AWS Elemental MediaLive API Reference

URI HTTP methods Schemas Properties See also

Input security groups: group ID

URI

/prod/inputSecurityGroups/inputSecurityGroupId

HTTP methods

DELETE

Operation ID: DeleteInputSecurityGroup

Path parameters
Name	Type	Required	Description
`inputSecurityGroupId`	String	True

Responses
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

Path parameters
Name	Type	Required	Description
`inputSecurityGroupId`	String	True

Responses
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

Path parameters
Name	Type	Required	Description
`inputSecurityGroupId`	String	True

Responses
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"
    }
  ]
}

PUT schema


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

Response bodies

{
}

Empty schema

{
}


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

InputSecurityGroup schema


{
  "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"
      }
    ]
  }
}

UpdateInputSecurityGroupResultModel schema


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


{
  "message": "string"
}

InvalidRequest schema


{
  "message": "string"
}


{
  "message": "string"
}

AccessDenied schema


{
  "message": "string"
}


{
  "message": "string"
}

ResourceNotFound schema


{
  "message": "string"
}


{
  "message": "string"
}

ResourceConflict schema


{
  "message": "string"
}


{
  "message": "string"
}

LimitExceeded schema


{
  "message": "string"
}


{
  "message": "string"
}

InternalServiceError schema


{
  "message": "string"
}


{
  "message": "string"
}

BadGatewayException schema


{
  "message": "string"
}


{
  "message": "string"
}

GatewayTimeoutException schema


{
  "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`	InputSecurityGroupState	False	The current state of the Input Security Group.
`tags`	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`	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

Property	Type	Required	Description
`*`	string	False

UpdateInputSecurityGroupResultModel

Property	Type	Required	Description
`securityGroup`	InputSecurityGroup	False

Select your cookie preferences