InputDevices inputDeviceId Deregister - AWS Elemental MediaLive API Reference

InputDevices inputDeviceId Deregister

URI

/prod/inputDevices/inputDeviceId/deregister

HTTP Methods

POST

Operation ID: DeregisterInputDevice

Deregisters an input device.

Path Parameters
Name Type Required Description
inputDeviceId String True
Query Parameters
Name Type Required Description
accountId String False
Responses
Status Code Response Model Description
200 InputDeviceRegistration

200 response

400 InvalidRequest

400 response

403 AccessDenied

403 response

404 ResourceNotFound

404 response

409 ResourceConflict

409 response

429 LimitExceeded

429 response

500 InternalServiceError

500 response

502 BadGatewayException

502 response

504 GatewayTimeoutException

504 response

Schemas

Request Bodies

Example POST

{ "force": boolean, "dryRun": boolean }

Response Bodies

Example InputDeviceRegistration

{ "id": "string", "arn": "string", "registrationState": enum, "attachmentCount": integer }

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

DeregisterInputDevice

Property Type Required Description
force

boolean

False

Force deregister if inputs are attached to the device.

dryRun

boolean

False

Check if inputs are attached without deregistering.

GatewayTimeoutException

Property Type Required Description
message

string

False

InputDeviceRegistration

The registration details of the input device.

Property Type Required Description
id

string

False

The unique ID of the input device. For example, hd-123456789abcdef.

arn

string

False

The unique ARN of the input device. The ARN includes the device ID. For example, arn:aws:medialive:us-west-2:123456789012:inputDevice:hd-123456789abcdef

registrationState

InputDeviceRegistrationState

False

The state of the registration of the input device.

attachmentCount

integer

False

The number of inputs attached to this device.

InputDeviceRegistrationState

The registration state of the input device.

  • DEREGISTERED

  • REGISTERING

  • REGISTERED

  • DEREGISTERING

  • FAILED

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

See Also

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

DeregisterInputDevice