ivsrealtime / Client / list_storage_configurations

list_storage_configurations#

ivsrealtime.Client.list_storage_configurations(**kwargs)#

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

Request Syntax

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

Parameters:

nextToken (string) – The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.
maxResults (integer) – Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.

Return type:

dict

Returns:

Response Syntax

{
    'storageConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            's3': {
                'bucketName': 'string'
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- storageConfigurations (list) –
  
  List of the matching storage configurations.
  - (dict) –
    
    Summary information about a storage configuration.
    - arn (string) –
      
      ARN of the storage configuration.
    - name (string) –
      
      Name of the storage configuration.
    - s3 (dict) –
      
      An S3 destination configuration where recorded videos will be stored.
      - bucketName (string) –
        
        Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.
    - 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 storage 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