InputSecurityGroups inputSecurityGroupId - AWS Elemental MediaLive 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
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

Update an Input Security Group's Whilelists.

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

Deletes an 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

Whitelist rules and their sync status

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

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

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