ElasticTranscoder / Client / update_pipeline_status

update_pipeline_status#

ElasticTranscoder.Client.update_pipeline_status(**kwargs)#

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can’t cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

See also: AWS API Documentation

Request Syntax

response = client.update_pipeline_status(
    Id='string',
    Status='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The identifier of the pipeline to update.

  • Status (string) –

    [REQUIRED]

    The desired status of the pipeline:

    • Active: The pipeline is processing jobs.

    • Paused: The pipeline is not currently processing jobs.

Return type:

dict

Returns:

Response Syntax

{
    'Pipeline': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Status': 'string',
        'InputBucket': 'string',
        'OutputBucket': 'string',
        'Role': 'string',
        'AwsKmsKeyArn': 'string',
        'Notifications': {
            'Progressing': 'string',
            'Completed': 'string',
            'Warning': 'string',
            'Error': 'string'
        },
        'ContentConfig': {
            'Bucket': 'string',
            'StorageClass': 'string',
            'Permissions': [
                {
                    'GranteeType': 'string',
                    'Grantee': 'string',
                    'Access': [
                        'string',
                    ]
                },
            ]
        },
        'ThumbnailConfig': {
            'Bucket': 'string',
            'StorageClass': 'string',
            'Permissions': [
                {
                    'GranteeType': 'string',
                    'Grantee': 'string',
                    'Access': [
                        'string',
                    ]
                },
            ]
        }
    }
}

Response Structure

  • (dict) –

    When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

    • Pipeline (dict) –

      A section of the response body that provides information about the pipeline.

      • Id (string) –

        The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

      • Arn (string) –

        The Amazon Resource Name (ARN) for the pipeline.

      • Name (string) –

        The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

        Constraints: Maximum 40 characters

      • Status (string) –

        The current status of the pipeline:

        • Active: The pipeline is processing jobs.

        • Paused: The pipeline is not currently processing jobs.

      • InputBucket (string) –

        The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

      • OutputBucket (string) –

        The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

      • Role (string) –

        The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

      • AwsKmsKeyArn (string) –

        The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

        If you use either s3 or s3-aws-kms as your Encryption:Mode, you don’t need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

      • Notifications (dict) –

        The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

        Warning

        To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

        • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

        • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

        • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

        • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

        • Progressing (string) –

          The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

        • Completed (string) –

          The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

        • Warning (string) –

          The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

        • Error (string) –

          The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

      • ContentConfig (dict) –

        Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

        • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

        • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

          • GranteeType: The type of value that appears in the Grantee object:

            • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

            • Email: The registered email address of an AWS account.

            • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

          • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

          • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

            • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

            • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

            • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

            • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

        • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

        • Bucket (string) –

          The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:

          • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

          • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

          • You do not want to specify the permissions that Elastic Transcoder grants to the files.

          • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

          If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

        • StorageClass (string) –

          The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

        • Permissions (list) –

          Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

          If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.

          If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.

          • (dict) –

            The Permission structure.

            • GranteeType (string) –

              The type of value that appears in the Grantee object:

              • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

              Warning

              A canonical user ID is not the same as an AWS account number.

              • Email: The registered email address of an AWS account.

              • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

            • Grantee (string) –

              The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

            • Access (list) –

              The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

              • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • (string) –

      • ThumbnailConfig (dict) –

        Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

        • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

        • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

          • GranteeType: The type of value that appears in the Grantee object:

            • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

            Warning

            A canonical user ID is not the same as an AWS account number.

            • Email: The registered email address of an AWS account.

            • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

          • Grantee: The AWS user or group that you want to have access to thumbnail files.

          • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

            • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

            • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

            • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

            • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

        • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

        • Bucket (string) –

          The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:

          • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

          • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

          • You do not want to specify the permissions that Elastic Transcoder grants to the files.

          • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

          If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

        • StorageClass (string) –

          The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

        • Permissions (list) –

          Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

          If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.

          If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.

          • (dict) –

            The Permission structure.

            • GranteeType (string) –

              The type of value that appears in the Grantee object:

              • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

              Warning

              A canonical user ID is not the same as an AWS account number.

              • Email: The registered email address of an AWS account.

              • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

            • Grantee (string) –

              The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

            • Access (list) –

              The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

              • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

              • (string) –

Exceptions

  • ElasticTranscoder.Client.exceptions.ValidationException

  • ElasticTranscoder.Client.exceptions.IncompatibleVersionException

  • ElasticTranscoder.Client.exceptions.ResourceNotFoundException

  • ElasticTranscoder.Client.exceptions.ResourceInUseException

  • ElasticTranscoder.Client.exceptions.AccessDeniedException

  • ElasticTranscoder.Client.exceptions.InternalServiceException