AWS Elemental MediaLive API Reference
API Reference

InputSecurityGroups inputSecurityGroupId

URI

/prod/inputSecurityGroups/ inputSecurityGroupId

HTTP Methods

GET

Operation ID: DescribeInputSecurityGroup

Produces a summary of an Input Security Group

Path Parameters

Name Type Required Description
inputSecurityGroupId String True

The id of the Input Security Group to describe

Responses

Status Code Response Model Description
200 InputSecurityGroup

An Input Security Group

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

PUT

Operation ID: UpdateInputSecurityGroup

Update an Input Security Group's Whilelists.

Path Parameters

Name Type Required Description
inputSecurityGroupId String True

The id of the Input Security Group to describe

Responses

Status Code Response Model Description
200 UpdateInputSecurityGroupResultModel

Successfully initiated the update of the Input Security Group.

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

409 ResourceConflict

The channel is unable to create due to an issue with channel resources.

DELETE

Operation ID: DeleteInputSecurityGroup

Deletes an Input Security Group

Path Parameters

Name Type Required Description
inputSecurityGroupId String True

The id of the Input Security Group to describe

Responses

Status Code Response Model Description
200 Empty

An Input Security Group

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

Schemas

Request Bodies

Example PUT

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

Response Bodies

Example InputSecurityGroup

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

Example UpdateInputSecurityGroupResultModel

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

Example Empty

{ }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

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

Empty

Property Type Required Description

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

string

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

InputSecurityGroupState (enum)

  • 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

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

UpdateInputSecurityGroupResultModel

Property Type Required Description
securityGroup

InputSecurityGroup

False