Channels id Credentials - AWS Elemental MediaPackage
URIHTTP methodsSchemasPropertiesSee also

Channels id Credentials

URI

/channels/id/credentials

HTTP methods

PUT

Operation ID: RotateChannelCredentials

Changes the username and password of the first IngestEndpoint on the channel.

Important

This API is being deprecated. Use RotateIngestEndpointCredentials instead.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200Channel

200 OK response

New WebDAV credentials are generated successfully.

403None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429None

429 Too Many Requests response

One of these two error conditions:

Too many requests have been sent in a given amount of time.

Your account has exceeded the quota allotted for the resource that you're creating.

500None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

OPTIONS

Enable CORS by returning correct headers.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method.

Schemas

Response bodies

{
  "createdAt createdAt": "string",
  "ingressAccessLogs ingressAccessLogs": {
    "logGroupName logGroupName": "string"
  },
  "egressAccessLogs egressAccessLogs": {
    "logGroupName logGroupName": "string"
  },
  "description description": "string",
  "hlsIngest hlsIngest": {
    "ingestEndpoints ingestEndpoints": [
      {
        "password password": "string",
        "id id": "string",
        "url url": "string",
        "username username": "string"
      }
    ]
  },
  "id id": "string",
  "arn arn": "string",
  "tags tags": {
  }
}

Properties

Channel

Channel configuration.

PropertyTypeRequiredDescription
arn

string

False

The channel's unique system-generated resource name, based on the AWS record.

createdAt

string

False

The date and time the Channel was created.

description

string

False

Any descriptive information that you want to add to the channel for future identification purposes.

egressAccessLogs

EgressAccessLogs

False

Configures egress access logs.

hlsIngest

HlsIngest

False

System-generated information about the channel.

id

string

False

Unique identifier that you assign to the channel.

ingressAccessLogs

IngressAccessLogs

False

Configures ingress access logs.

tags

Tags

False

The tags assigned to the channel.

createdAt

The date and time the Channel was created.

  • Type: string

  • Required: False

ingressAccessLogs

Configures ingress access logs.

egressAccessLogs

Configures egress access logs.

description

Any descriptive information that you want to add to the channel for future identification purposes.

  • Type: string

  • Required: False

hlsIngest

System-generated information about the channel.

id

Unique identifier that you assign to the channel.

  • Type: string

  • Required: False

arn

The channel's unique system-generated resource name, based on the AWS record.

  • Type: string

  • Required: False

tags

The tags assigned to the channel.

  • Type: Tags

  • Required: False

EgressAccessLogs

Egress access log configuration parameters.

PropertyTypeRequiredDescription
logGroupName

string

False

Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/EgressAccessLogs.

logGroupName

Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/EgressAccessLogs.

  • Type: string

  • Required: False

HlsIngest

HLS ingest configuration.

PropertyTypeRequiredDescription
ingestEndpoints

Array of type IngestEndpoint

False

The input URL where the source stream should be sent.

ingestEndpoints

The input URL where the source stream should be sent.

  • Type: Array of type IngestEndpoint

  • Required: False

IngestEndpoint

An endpoint for ingesting source content for a channel.

PropertyTypeRequiredDescription
id

string

False

The system-generated unique identifier for the IngestEndpoint.

password

string

False

The system-generated password for WebDAV input authentication.

url

string

False

The input URL where the source stream should be sent.

username

string

False

The system-generated username for WebDAV input authentication.

password

The system-generated password for WebDAV input authentication.

  • Type: string

  • Required: False

id

The system-generated unique identifier for the IngestEndpoint.

  • Type: string

  • Required: False

url

The input URL where the source stream should be sent.

  • Type: string

  • Required: False

username

The system-generated username for WebDAV input authentication.

  • Type: string

  • Required: False

IngressAccessLogs

Ingress access log configuration parameters.

PropertyTypeRequiredDescription
logGroupName

string

False

Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/IngressAccessLogs.

logGroupName

Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/IngressAccessLogs.

  • Type: string

  • Required: False

Tags

A collection of tags associated with a resource.

Value description:

  • Property: "key1": "value1"

  • Type: string

  • Required: True

  • Description: A comma-separated list of tag key:value pairs that you define. For example:

     {
   "Key1": "Value1",
   "Key2": "Value2"
 }
PropertyTypeRequiredDescription

*

string

False
key-value pairs

  • Type: string

See also

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

RotateChannelCredentials