RuntimeforBedrockDataAutomation ******************************* Client ====== class RuntimeforBedrockDataAutomation.Client A low-level client representing Runtime for Amazon Bedrock Data Automation Amazon Bedrock Data Automation Runtime import boto3 client = boto3.client('bedrock-data-automation-runtime') These are the available methods: * can_paginate * close * get_data_automation_status * get_paginator * get_waiter * invoke_data_automation_async * list_tags_for_resource * tag_resource * untag_resource RuntimeforBedrockDataAutomation / Client / invoke_data_automation_async invoke_data_automation_async **************************** RuntimeforBedrockDataAutomation.Client.invoke_data_automation_async(**kwargs) Async API: Invoke data automation. See also: AWS API Documentation **Request Syntax** response = client.invoke_data_automation_async( clientToken='string', inputConfiguration={ 's3Uri': 'string', 'assetProcessingConfiguration': { 'video': { 'segmentConfiguration': { 'timestampSegment': { 'startTimeMillis': 123, 'endTimeMillis': 123 } } } } }, outputConfiguration={ 's3Uri': 'string' }, dataAutomationConfiguration={ 'dataAutomationProjectArn': 'string', 'stage': 'LIVE'|'DEVELOPMENT' }, encryptionConfiguration={ 'kmsKeyId': 'string', 'kmsEncryptionContext': { 'string': 'string' } }, notificationConfiguration={ 'eventBridgeConfiguration': { 'eventBridgeEnabled': True|False } }, blueprints=[ { 'blueprintArn': 'string', 'version': 'string', 'stage': 'DEVELOPMENT'|'LIVE' }, ], dataAutomationProfileArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **clientToken** (*string*) -- Idempotency token. This field is autopopulated if not provided. * **inputConfiguration** (*dict*) -- **[REQUIRED]** Input configuration. * **s3Uri** *(string) --* **[REQUIRED]** S3 uri. * **assetProcessingConfiguration** *(dict) --* Asset processing configuration * **video** *(dict) --* Video asset processing configuration * **segmentConfiguration** *(dict) --* Delimits the segment of the input that will be processed Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "timestampSegment". * **timestampSegment** *(dict) --* Timestamp segment * **startTimeMillis** *(integer) --* **[REQUIRED]** Start timestamp in milliseconds * **endTimeMillis** *(integer) --* **[REQUIRED]** End timestamp in milliseconds * **outputConfiguration** (*dict*) -- **[REQUIRED]** Output configuration. * **s3Uri** *(string) --* **[REQUIRED]** S3 uri. * **dataAutomationConfiguration** (*dict*) -- Data automation configuration. * **dataAutomationProjectArn** *(string) --* **[REQUIRED]** Data automation project arn. * **stage** *(string) --* Data automation stage. * **encryptionConfiguration** (*dict*) -- Encryption configuration. * **kmsKeyId** *(string) --* **[REQUIRED]** Customer KMS key used for encryption * **kmsEncryptionContext** *(dict) --* KMS encryption context. * *(string) --* Excryption context key. * *(string) --* Encryption context value. * **notificationConfiguration** (*dict*) -- Notification configuration. * **eventBridgeConfiguration** *(dict) --* **[REQUIRED]** Event bridge configuration. * **eventBridgeEnabled** *(boolean) --* **[REQUIRED]** Event bridge flag. * **blueprints** (*list*) -- Blueprint list. * *(dict) --* Blueprint. * **blueprintArn** *(string) --* **[REQUIRED]** Arn of blueprint. * **version** *(string) --* Version of blueprint. * **stage** *(string) --* Stage of blueprint. * **dataAutomationProfileArn** (*string*) -- **[REQUIRED]** Data automation profile ARN * **tags** (*list*) -- List of tags. * *(dict) --* Key value pair of a tag * **key** *(string) --* **[REQUIRED]** Defines the context of the tag. * **value** *(string) --* **[REQUIRED]** Defines the value within the context. e.g. . Return type: dict Returns: **Response Syntax** { 'invocationArn': 'string' } **Response Structure** * *(dict) --* Invoke Data Automation Async Response * **invocationArn** *(string) --* ARN of the automation job **Exceptions** * "RuntimeforBedrockDataAutomation.Client.exceptions.ServiceQuotaE xceededException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ValidationExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.AccessDeniedE xception" * "RuntimeforBedrockDataAutomation.Client.exceptions.InternalServe rException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ThrottlingExc eption" RuntimeforBedrockDataAutomation / Client / get_paginator get_paginator ************* RuntimeforBedrockDataAutomation.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. RuntimeforBedrockDataAutomation / Client / can_paginate can_paginate ************ RuntimeforBedrockDataAutomation.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. RuntimeforBedrockDataAutomation / Client / list_tags_for_resource list_tags_for_resource ********************** RuntimeforBedrockDataAutomation.Client.list_tags_for_resource(**kwargs) List tags for an Amazon Bedrock Data Automation resource See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceARN='string' ) Parameters: **resourceARN** (*string*) -- **[REQUIRED]** ARN of a taggable resource Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* List of tags * *(dict) --* Key value pair of a tag * **key** *(string) --* Defines the context of the tag. * **value** *(string) --* Defines the value within the context. e.g. . **Exceptions** * "RuntimeforBedrockDataAutomation.Client.exceptions.ValidationExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.AccessDeniedE xception" * "RuntimeforBedrockDataAutomation.Client.exceptions.InternalServe rException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ResourceNotFo undException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ThrottlingExc eption" RuntimeforBedrockDataAutomation / Client / untag_resource untag_resource ************** RuntimeforBedrockDataAutomation.Client.untag_resource(**kwargs) Untag an Amazon Bedrock Data Automation resource See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceARN='string', tagKeys=[ 'string', ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** ARN of a taggable resource * **tagKeys** (*list*) -- **[REQUIRED]** List of tag keys * *(string) --* Defines the context of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RuntimeforBedrockDataAutomation.Client.exceptions.ValidationExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.AccessDeniedE xception" * "RuntimeforBedrockDataAutomation.Client.exceptions.InternalServe rException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ResourceNotFo undException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ThrottlingExc eption" RuntimeforBedrockDataAutomation / Client / get_waiter get_waiter ********** RuntimeforBedrockDataAutomation.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" RuntimeforBedrockDataAutomation / Client / get_data_automation_status get_data_automation_status ************************** RuntimeforBedrockDataAutomation.Client.get_data_automation_status(**kwargs) API used to get data automation status. See also: AWS API Documentation **Request Syntax** response = client.get_data_automation_status( invocationArn='string' ) Parameters: **invocationArn** (*string*) -- **[REQUIRED]** Invocation arn. Return type: dict Returns: **Response Syntax** { 'status': 'Created'|'InProgress'|'Success'|'ServiceError'|'ClientError', 'errorType': 'string', 'errorMessage': 'string', 'outputConfiguration': { 's3Uri': 'string' } } **Response Structure** * *(dict) --* Response of GetDataAutomationStatus API. * **status** *(string) --* Job Status. * **errorType** *(string) --* Error Type. * **errorMessage** *(string) --* Error Message. * **outputConfiguration** *(dict) --* Output configuration. * **s3Uri** *(string) --* S3 uri. **Exceptions** * "RuntimeforBedrockDataAutomation.Client.exceptions.ValidationExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.AccessDeniedE xception" * "RuntimeforBedrockDataAutomation.Client.exceptions.InternalServe rException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ThrottlingExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.ResourceNotFo undException" RuntimeforBedrockDataAutomation / Client / close close ***** RuntimeforBedrockDataAutomation.Client.close() Closes underlying endpoint connections. RuntimeforBedrockDataAutomation / Client / tag_resource tag_resource ************ RuntimeforBedrockDataAutomation.Client.tag_resource(**kwargs) Tag an Amazon Bedrock Data Automation resource See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceARN='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** ARN of a taggable resource * **tags** (*list*) -- **[REQUIRED]** List of tags * *(dict) --* Key value pair of a tag * **key** *(string) --* **[REQUIRED]** Defines the context of the tag. * **value** *(string) --* **[REQUIRED]** Defines the value within the context. e.g. . Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RuntimeforBedrockDataAutomation.Client.exceptions.ServiceQuotaE xceededException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ValidationExc eption" * "RuntimeforBedrockDataAutomation.Client.exceptions.AccessDeniedE xception" * "RuntimeforBedrockDataAutomation.Client.exceptions.InternalServe rException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ResourceNotFo undException" * "RuntimeforBedrockDataAutomation.Client.exceptions.ThrottlingExc eption"