InputSecurityGroups inputSecurityGroupId - AWS Elemental MediaLive API Reference

InputSecurityGroups inputSecurityGroupId

URI

/prod/inputSecurityGroups/inputSecurityGroupId

HTTP Methods

GET

Operation ID: DescribeInputSecurityGroup

Get the properties of one input security group.

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

Change the list of IP addresses (CIDR blocks) that are allowed to push content to MediaLive.

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.

DELETE

Operation ID: DeleteInputSecurityGroup

Delete one input security group.

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.

Schemas

Request Bodies

Example PUT

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

Response Bodies

Example InputSecurityGroup

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

Example UpdateInputSecurityGroupResultModel

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

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

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.

whitelistRules

Array of type InputWhitelistRule

False

A list of one or more IPv4 CIDR addresses to allow. The input security group must include this list.

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.

InputSecurityGroupState

  • IDLE

  • IN_USE

  • UPDATING

  • DELETED

InputSecurityGroupWhitelistRequest

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

Property Type Required Description
whitelistRules

Array of type InputWhitelistRuleCidr

False

A list of one or more IPv4 CIDR addresses to allow. The input security group must include this list.

tags

Tags

False

A collection of key-value pairs.

InputWhitelistRule

Configures one rule for this input security group. Each rule is a range of IP addresses (CIDR blocks) that are allowed to push content to MediaLive. This element belongs to InputSecurityGroup.

Property Type Required Description
cidr

string

False

The IPv4 CIDR that is allowed to push content to MediaLive.

InputWhitelistRuleCidr

An IPv4 CIDR to allow.

Property Type Required Description
cidr

string

False

The IPv4 CIDR to allow.

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

Tags for the resource. This element belongs to many resources belon.

Property Type Required Description

*

string

False

UpdateInputSecurityGroupResultModel

Property Type Required Description
securityGroup

InputSecurityGroup

False

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeInputSecurityGroup

UpdateInputSecurityGroup

DeleteInputSecurityGroup