ivsrealtime / Client / list_encoder_configurations

list_encoder_configurations#

ivsrealtime.Client.list_encoder_configurations(**kwargs)#

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

Request Syntax

response = client.list_encoder_configurations(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.
maxResults (integer) – Maximum number of results to return. Default: 100.

Return type:

dict

Returns:

Response Syntax

{
    'encoderConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- encoderConfigurations (list) –
  
  List of the matching EncoderConfigurations (summary information only).
  - (dict) –
    
    Summary information about an EncoderConfiguration.
    - arn (string) –
      
      ARN of the EncoderConfiguration resource.
    - name (string) –
      
      Optional name to identify the resource.
    - tags (dict) –
      
      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.
      - (string) –
        
        (string) –
- nextToken (string) –
  
  If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.

Exceptions

ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException
ivsrealtime.Client.exceptions.InternalServerException
ivsrealtime.Client.exceptions.ServiceQuotaExceededException
ivsrealtime.Client.exceptions.ConflictException