diff --git a/packages/sdk/src/agent_builder_sdk/botocore_models/transformagenticservice/2018-05-10/paginators-1.json b/packages/sdk/src/agent_builder_sdk/botocore_models/transformagenticservice/2018-05-10/paginators-1.json new file mode 100644 index 0000000..f252f62 --- /dev/null +++ b/packages/sdk/src/agent_builder_sdk/botocore_models/transformagenticservice/2018-05-10/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListAgentInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "agentInstanceSummaries" + }, + "ListArtifacts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "artifacts" + }, + "ListHitlTasks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "hitlTasks" + }, + "ListJobPlanSteps": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "steps" + } + } +} diff --git a/packages/types/README.md b/packages/types/README.md index cbe8943..ca44dec 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -18,7 +18,7 @@ No import or code change required. Once installed, your type checker picks up th import boto3 # Your IDE now knows the full shape of this client. -client = boto3.client("elasticgumbyagenticservice") +client = boto3.client("transformagenticservice") # Autocomplete works on method names and arguments. response = client.list_agents(...) @@ -30,10 +30,25 @@ For explicit annotations, you can import type defs directly: from agent_builder_types import TransformAgenticServiceClient from agent_builder_types.type_defs import GetAgentInstanceResponseTypeDef -client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") +client: TransformAgenticServiceClient = boto3.client("transformagenticservice") response: GetAgentInstanceResponseTypeDef = client.get_agent_instance(...) ``` +## Regenerating stubs + +If the service model (`service-2.json`) is updated, regenerate stubs: + +```bash +pip install mypy-boto3-builder +python scripts/generate_stubs.py --model ../sdk/src/agent_builder_sdk/botocore_models/transformagenticservice/2018-05-10/service-2.json +``` + +Validate that current stubs match the model (useful in CI): + +```bash +python scripts/generate_stubs.py --model ../sdk/src/agent_builder_sdk/botocore_models/transformagenticservice/2018-05-10/service-2.json --validate +``` + ## Requirements - Python 3.11+ diff --git a/packages/types/pyproject.toml b/packages/types/pyproject.toml index 4a7bb4c..671c987 100644 --- a/packages/types/pyproject.toml +++ b/packages/types/pyproject.toml @@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta" [project] name = "agent-builder-types-aws-transform" -version = "1.0.0" -description = "Type stubs for boto3 TransformAgenticService client" +version = "1.1.0" +description = "Type stubs for the AWS Transform Agentic service boto3 client" readme = "README.md" requires-python = ">=3.11" authors = [{ name = "AWS Transform Team" }] diff --git a/packages/types/scripts/generate_stubs.py b/packages/types/scripts/generate_stubs.py new file mode 100644 index 0000000..45150d4 --- /dev/null +++ b/packages/types/scripts/generate_stubs.py @@ -0,0 +1,277 @@ +#!/usr/bin/env python3 +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 +""" +Generate type stubs for the TransformAgenticService from its service-2.json model. + +Usage: + python scripts/generate_stubs.py [--model PATH_TO_SERVICE_2_JSON] [--validate] + +Requirements: + pip install mypy-boto3-builder + +What it does: + 1. Injects the service model into botocore's data dir (temporarily) + 2. Runs mypy-boto3-builder to generate type stubs + 3. Copies generated stubs into src/agent_builder_types/ + 4. Cleans up the injected model and temp output dir + +Flags: + --model Path to service-2.json (default: ~/.aws/models/transformagenticservice/2018-05-10/service-2.json) + --validate Only validate that current stubs match what would be generated (exit 1 if different) +""" + +import argparse +import difflib +import json +import os +import shutil +import subprocess +import sys +import tempfile +from pathlib import Path + +SERVICE_NAME = "transformagenticservice" +API_VERSION = "2018-05-10" +PACKAGE_MODULE = "agent_builder_types" +DEFAULT_MODEL = os.path.join( + os.path.dirname(__file__), "..", "..", "sdk", "src", "agent_builder_sdk", + "botocore_models", SERVICE_NAME, API_VERSION, "service-2.json" +) + +# Files to copy from generated output to our package +STUB_FILES = [ + "__init__.py", + "__init__.pyi", + "client.py", + "client.pyi", + "literals.py", + "literals.pyi", + "paginator.py", + "paginator.pyi", + "type_defs.py", + "type_defs.pyi", +] + + +def get_botocore_data_dir() -> Path: + import botocore + + return Path(botocore.__file__).parent / "data" + + +def inject_model(model_path: Path, botocore_data: Path) -> Path: + """Copy service model into botocore data dir. Returns the created dir.""" + target = botocore_data / SERVICE_NAME / API_VERSION + target.mkdir(parents=True, exist_ok=True) + shutil.copy2(model_path, target / "service-2.json") + + # Also copy paginators-1.json if it exists alongside the service model + paginators = model_path.parent / "paginators-1.json" + if paginators.exists(): + shutil.copy2(paginators, target / "paginators-1.json") + + return target.parent + + +def remove_model(botocore_data: Path) -> None: + """Remove injected service model from botocore data dir.""" + target = botocore_data / SERVICE_NAME + if target.exists(): + shutil.rmtree(target) + + +def generate(model_path: Path) -> Path: + """Run mypy-boto3-builder and return path to generated module dir.""" + botocore_data = get_botocore_data_dir() + injected = False + + # Check if model already exists in botocore data + existing = botocore_data / SERVICE_NAME / API_VERSION / "service-2.json" + if not existing.exists(): + inject_model(model_path, botocore_data) + injected = True + + try: + output_dir = Path(tempfile.mkdtemp(prefix="types-gen-")) + + # Find mypy_boto3_builder — prefer the installed command, fall back to python -m + builder_cmd = shutil.which("mypy_boto3_builder") + if builder_cmd: + cmd = [builder_cmd] + else: + cmd = [sys.executable, "-m", "mypy_boto3_builder"] + + result = subprocess.run( + cmd + [ + str(output_dir), + "--product", + "boto3-services", + "-s", + SERVICE_NAME, + "--no-smart-version", + "-b", + "1.0.0", + ], + capture_output=True, + text=True, + ) + + if result.returncode != 0: + print(f"mypy-boto3-builder failed:\n{result.stderr}", file=sys.stderr) + sys.exit(1) + + generated_module = ( + output_dir + / f"mypy_boto3_{SERVICE_NAME}_package" + / f"mypy_boto3_{SERVICE_NAME}" + ) + + if not generated_module.exists(): + print( + f"Expected output not found: {generated_module}", file=sys.stderr + ) + sys.exit(1) + + return generated_module + + finally: + if injected: + remove_model(botocore_data) + + +COPYRIGHT_HEADER = """\ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 +""" + + +def rewrite_imports(content: str) -> str: + """Rewrite generated import paths to match our package structure.""" + content = content.replace( + f"mypy_boto3_{SERVICE_NAME}", PACKAGE_MODULE + ) + # Add copyright header if not present + if not content.startswith("# Copyright"): + content = COPYRIGHT_HEADER + content + return content + + +def copy_stubs(generated_module: Path, target_dir: Path) -> None: + """Copy and rewrite generated stubs into the package source.""" + for filename in STUB_FILES: + src = generated_module / filename + dst = target_dir / filename + if src.exists(): + content = src.read_text() + content = rewrite_imports(content) + dst.write_text(content) + print(f" Updated: {filename}") + else: + print(f" Skipped (not generated): {filename}") + + +def validate_stubs(generated_module: Path, target_dir: Path) -> bool: + """Compare generated stubs against current stubs. Returns True if matching.""" + all_match = True + for filename in STUB_FILES: + src = generated_module / filename + dst = target_dir / filename + if not src.exists(): + continue + if not dst.exists(): + print(f" MISSING: {filename}") + all_match = False + continue + + generated_content = rewrite_imports(src.read_text()) + current_content = dst.read_text() + + if generated_content != current_content: + print(f" DIFFERS: {filename}") + diff = difflib.unified_diff( + current_content.splitlines(keepends=True), + generated_content.splitlines(keepends=True), + fromfile=f"current/{filename}", + tofile=f"generated/{filename}", + n=3, + ) + # Show first 30 lines of diff + for i, line in enumerate(diff): + if i >= 30: + print(" ... (truncated)") + break + print(f" {line}", end="") + all_match = False + else: + print(f" OK: {filename}") + + return all_match + + +def main(): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument( + "--model", + type=Path, + default=Path(DEFAULT_MODEL), + help=f"Path to service-2.json (default: {DEFAULT_MODEL})", + ) + parser.add_argument( + "--validate", + action="store_true", + help="Only validate current stubs match generated output", + ) + args = parser.parse_args() + + if not args.model.exists(): + print(f"Service model not found: {args.model}", file=sys.stderr) + print( + "Register it with: aws configure add-model --service-name " + f"{SERVICE_NAME} --service-model file://{args.model}", + file=sys.stderr, + ) + sys.exit(1) + + # Verify service name in model + with open(args.model) as f: + model = json.load(f) + endpoint_prefix = model["metadata"].get("endpointPrefix", "") + if endpoint_prefix != SERVICE_NAME: + print( + f"Warning: model endpointPrefix is '{endpoint_prefix}', " + f"expected '{SERVICE_NAME}'", + file=sys.stderr, + ) + + print(f"Service: {model['metadata']['serviceFullName']}") + print(f"Operations: {len(model['operations'])}, Shapes: {len(model['shapes'])}") + print() + + # Generate + print("Generating stubs...") + generated_module = generate(args.model) + + # Target directory + package_root = Path(__file__).parent.parent + target_dir = package_root / "src" / PACKAGE_MODULE + + if args.validate: + print("\nValidating against current stubs:") + if validate_stubs(generated_module, target_dir): + print("\nAll stubs match.") + sys.exit(0) + else: + print("\nStubs are out of date. Run without --validate to regenerate.") + sys.exit(1) + else: + print(f"\nCopying stubs to {target_dir}:") + copy_stubs(generated_module, target_dir) + print("\nDone. Review changes with: git diff") + + # Cleanup temp dir + shutil.rmtree(generated_module.parent.parent, ignore_errors=True) + + +if __name__ == "__main__": + main() diff --git a/packages/types/src/agent_builder_types/__init__.py b/packages/types/src/agent_builder_types/__init__.py index ea3dd1a..ee5f2f2 100644 --- a/packages/types/src/agent_builder_types/__init__.py +++ b/packages/types/src/agent_builder_types/__init__.py @@ -1,25 +1,23 @@ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ -Main interface for AWS Transform Agentic service. +Main interface for transformagenticservice service. Usage:: ```python - import boto3 + from boto3.session import Session from agent_builder_types import ( Client, - TransformAgenticServiceClient, ListAgentInstancesPaginator, ListArtifactsPaginator, ListHitlTasksPaginator, ListJobPlanStepsPaginator, + TransformAgenticServiceClient, ) - session = boto3.Session() - - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") - session_client: TransformAgenticServiceClient = session.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") list_agent_instances_paginator: ListAgentInstancesPaginator = client.get_paginator("list_agent_instances") list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts") @@ -38,12 +36,11 @@ Client = TransformAgenticServiceClient - __all__ = ( "Client", - "TransformAgenticServiceClient", "ListAgentInstancesPaginator", "ListArtifactsPaginator", "ListHitlTasksPaginator", "ListJobPlanStepsPaginator", + "TransformAgenticServiceClient", ) diff --git a/packages/types/src/agent_builder_types/__init__.pyi b/packages/types/src/agent_builder_types/__init__.pyi index b59e61a..ee5f2f2 100644 --- a/packages/types/src/agent_builder_types/__init__.pyi +++ b/packages/types/src/agent_builder_types/__init__.pyi @@ -1,23 +1,23 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 """ -Main interface for AWS Transform Agentic service. +Main interface for transformagenticservice service. Usage:: ```python - import boto3 + from boto3.session import Session from agent_builder_types import ( Client, - TransformAgenticServiceClient, ListAgentInstancesPaginator, ListArtifactsPaginator, ListHitlTasksPaginator, ListJobPlanStepsPaginator, + TransformAgenticServiceClient, ) - session = boto3.Session() - - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") - session_client: TransformAgenticServiceClient = session.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") list_agent_instances_paginator: ListAgentInstancesPaginator = client.get_paginator("list_agent_instances") list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts") @@ -38,9 +38,9 @@ Client = TransformAgenticServiceClient __all__ = ( "Client", - "TransformAgenticServiceClient", "ListAgentInstancesPaginator", "ListArtifactsPaginator", "ListHitlTasksPaginator", "ListJobPlanStepsPaginator", + "TransformAgenticServiceClient", ) diff --git a/packages/types/src/agent_builder_types/client.py b/packages/types/src/agent_builder_types/client.py index 116d264..96ef0b9 100644 --- a/packages/types/src/agent_builder_types/client.py +++ b/packages/types/src/agent_builder_types/client.py @@ -1,23 +1,23 @@ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service client. +Type annotations for transformagenticservice service client. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/) Usage:: ```python - import boto3 - from agent_builder_types import TransformAgenticServiceClient + from boto3.session import Session + from agent_builder_types.client import TransformAgenticServiceClient - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") ``` """ import sys -from datetime import datetime -from typing import Any, Dict, List, Type, Union, overload +from typing import Any, Dict, Mapping, Sequence, Type, overload from botocore.client import BaseClient, ClientMeta @@ -31,6 +31,13 @@ ResourceTypeType, RetrievalScopeType, SeverityType, + UmrAgreementStatusType, + UmrEligibilityOutcomeType, + UmrIncentiveTypeType, + UmrMigrationPhaseType, + UmrPartnerTypeType, + UmrRiskLevelType, + UmrStatusType, UpdateAgentInstanceStatusType, VisibilityType, ) @@ -65,6 +72,7 @@ GetTaskResponseTypeDef, GetTemporaryCredentialsForConnectorResponseTypeDef, GetTemporaryCredentialsForRoleResponseTypeDef, + GetUMRResponseTypeDef, GetUsageResponseTypeDef, HitlTaskArtifactTypeDef, HitlTaskFilterTypeDef, @@ -81,12 +89,15 @@ ListHitlTasksResponseTypeDef, ListJobPlanStepsResponseTypeDef, ListWorklogsResponseTypeDef, - MetadataContextTypeDef, MeteredAmountTypeDef, MeteringAttributeTypeDef, PlanStepUpdateTypeDef, + PutAgreementResponseTypeDef, + PutEligibilityResponseTypeDef, PutJobPlanModeTypeDef, PutJobPlanResponseTypeDef, + PutMigrationPlanResponseTypeDef, + PutPartnerDetailsResponseTypeDef, RefreshAuthTokenResponseTypeDef, RequestContextTypeDef, RetrievalConfigurationTypeDef, @@ -94,26 +105,27 @@ RetrieveFromKnowledgeBaseResponseTypeDef, SendMessageResponseTypeDef, StartHitlTaskResponseTypeDef, - StartJobResponseTypeDef, StartKnowledgeBaseIngestionResponseTypeDef, StatusInfoTypeDef, + TimestampTypeDef, + UmrResourceUnionTypeDef, + UpdateUMRStatusResponseTypeDef, WorklogFilterTypeDef, - WorklogTypeDef, + WorklogUnionTypeDef, ) -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal - __all__ = ("TransformAgenticServiceClient",) -class BotocoreClientError(BaseException): +class BotocoreClientError(Exception): MSG_TEMPLATE: str - def __init__(self, error_response: Dict[str, Any], operation_name: str) -> None: + def __init__(self, error_response: Mapping[str, Any], operation_name: str) -> None: self.response: Dict[str, Any] self.operation_name: str @@ -136,8 +148,8 @@ class Exceptions: class TransformAgenticServiceClient(BaseClient): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/) """ meta: ClientMeta @@ -146,790 +158,787 @@ class TransformAgenticServiceClient(BaseClient): def exceptions(self) -> Exceptions: """ TransformAgenticServiceClient exceptions. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.exceptions) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#exceptions) """ def acknowledge_deletion( - self, *, requestContext: "RequestContextTypeDef", deletionAcknowledgementToken: str + self, *, requestContext: RequestContextTypeDef, deletionAcknowledgementToken: str ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.acknowledge_deletion( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'work... + API used by agents to acknowledge they have completed the data cleanup for the + corresponding job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/AcknowledgeDeletion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.acknowledge_deletion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#acknowledge_deletion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.acknowledge_deletion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#acknowledge_deletion) """ def can_paginate(self, operation_name: str) -> bool: """ Check if an operation can be paginated. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.can_paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#can_paginate) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.can_paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#can_paginate) """ def close(self) -> None: """ Closes underlying endpoint connections. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.close) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#close) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.close) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#close) """ def close_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, hitlTaskId: str, - closureType: ClosureTypeType = None, - idempotencyToken: str = None + closureType: ClosureTypeType = ..., + idempotencyToken: str = ..., ) -> CloseHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.close_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CloseHitlTask). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.close_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#close_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.close_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#close_hitl_task) """ def complete_artifact_upload( - self, *, requestContext: "RequestContextTypeDef", artifactId: str + self, *, requestContext: RequestContextTypeDef, artifactId: str ) -> CompleteArtifactUploadResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.complete_artifact_upload( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + API used by agents to let ATX Foundation know that upload is complete. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.complete_artifact_upload) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#complete_artifact_upload) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.complete_artifact_upload) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#complete_artifact_upload) """ def copy_artifact( - self, - *, - requestContext: "RequestContextTypeDef", - artifactId: str, - idempotencyToken: str = None + self, *, requestContext: RequestContextTypeDef, artifactId: str, idempotencyToken: str = ... ) -> CopyArtifactResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.copy_artifact( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... + API used by agents to copy artifacts from artifact store bucket to public + bucket See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CopyArtifact). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.copy_artifact) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#copy_artifact) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.copy_artifact) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#copy_artifact) """ def create_artifact_download_url( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, - visibility: VisibilityType = None + visibility: VisibilityType = ..., ) -> CreateArtifactDownloadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.create_artifact_download_url( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to generate an S3 presigned URL for downloading an artifact. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_artifact_download_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_artifact_download_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_artifact_download_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_artifact_download_url) """ def create_artifact_upload_url( self, *, - requestContext: "RequestContextTypeDef", - contentDigest: "ContentDigestTypeDef", - artifactReference: "ArtifactReferenceTypeDef", - label: str = None, - planStepId: str = None, - visibility: VisibilityType = None, - metadata: "MetadataContextTypeDef" = None, - fileMetadata: "FileMetadataTypeDef" = None + requestContext: RequestContextTypeDef, + contentDigest: ContentDigestTypeDef, + artifactReference: ArtifactReferenceTypeDef, + label: str = ..., + planStepId: str = ..., + visibility: VisibilityType = ..., + fileMetadata: FileMetadataTypeDef = ..., ) -> CreateArtifactUploadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response - = client.create_artifact_upload_url( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + API used by agents to generate an S3 presigned URL for uploading an artifact. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_artifact_upload_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_artifact_upload_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_artifact_upload_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_artifact_upload_url) """ def create_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, uxComponentId: str, description: str, title: str, - severity: SeverityType = None, - hitlTaskType: HitlTaskTypeType = None, - stepId: str = None, - blockingType: BlockingTypeType = None, - hitlRequestArtifact: "HitlTaskArtifactTypeDef" = None, - expiredAt: Union[datetime, str] = None, - tag: str = None, - idempotencyToken: str = None, - category: CategoryType = None + severity: SeverityType = ..., + hitlTaskType: HitlTaskTypeType = ..., + stepId: str = ..., + blockingType: BlockingTypeType = ..., + hitlRequestArtifact: HitlTaskArtifactTypeDef = ..., + expiredAt: TimestampTypeDef = ..., + tag: str = ..., + idempotencyToken: str = ..., + category: CategoryType = ..., ) -> CreateHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId':... + API used by agents to trigger a Human-In-The-Loop request. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_hitl_task) """ def create_skill_download_url( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, skillName: str, - idempotencyToken: str = None, - version: str = None + idempotencyToken: str = ..., + version: str = ..., ) -> CreateSkillDownloadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_skill_download_url( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CreateSkillDownloadUrl). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_skill_download_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_skill_download_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_skill_download_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_skill_download_url) """ def create_worklog( self, *, - requestContext: "RequestContextTypeDef", - worklog: "WorklogTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + worklog: WorklogUnionTypeDef, + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_worklog( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + API to allow ingestion of agent/ HITL/ job level worklogs See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CreateWorklog). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_worklog) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_worklog) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_worklog) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_worklog) """ def delete_job_plan_step( - self, *, requestContext: "RequestContextTypeDef", stepId: str, idempotencyToken: str = None + self, *, requestContext: RequestContextTypeDef, stepId: str, idempotencyToken: str = ... ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.delete_job_plan_step( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'worksp... + API used by agents to delete an existing step of the job plan. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.delete_job_plan_step) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#delete_job_plan_step) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.delete_job_plan_step) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#delete_job_plan_step) """ def deregister_knowledge_base_document( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, - knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"] + knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.deregister_knowledge_base_document( requestContext={ - 'jobMetadata': { 'jobId': 'st... + API used by agents to deregister a document from knowledge base See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/DeregisterKnowledgeBaseDocument). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.deregister_knowledge_base_document) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#deregister_knowledge_base_document) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.deregister_knowledge_base_document) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#deregister_knowledge_base_document) """ def generate_presigned_url( self, ClientMethod: str, - Params: Dict[str, Any] = None, + Params: Mapping[str, Any] = ..., ExpiresIn: int = 3600, - HttpMethod: str = None, + HttpMethod: str = ..., ) -> str: """ Generate a presigned url given a client, its method, and arguments. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.generate_presigned_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#generate_presigned_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.generate_presigned_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#generate_presigned_url) """ def get_agent_instance( - self, *, requestContext: "RequestContextTypeDef", agentInstanceId: str + self, *, requestContext: RequestContextTypeDef, agentInstanceId: str ) -> GetAgentInstanceResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_agent_instance( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspace... + API used to Get details about a specific agent's invocation See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetAgentInstance). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_agent_instance) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_agent_instance) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_agent_instance) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_agent_instance) """ def get_agent_version( - self, *, requestContext: "RequestContextTypeDef", name: str, version: str = None + self, *, requestContext: RequestContextTypeDef, name: str, version: str = ... ) -> GetAgentVersionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_agent_version( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetAgentVersion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_agent_version) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_agent_version) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_agent_version) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_agent_version) """ def get_artifact_metadata( - self, *, requestContext: "RequestContextTypeDef", artifactId: str + self, *, requestContext: RequestContextTypeDef, artifactId: str ) -> GetArtifactMetadataResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_artifact_metadata( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'wor... + This API is used to retrieve metadata about an artifact See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetArtifactMetadata). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_artifact_metadata) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_artifact_metadata) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_artifact_metadata) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_artifact_metadata) """ def get_connector( - self, *, requestContext: "RequestContextTypeDef", connectorId: str + self, *, requestContext: RequestContextTypeDef, connectorId: str ) -> GetConnectorResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_connector( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... + API used by agents to get resource level details of connector by connectorId + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetConnector). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_connector) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_connector) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_connector) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_connector) """ def get_hitl_task( - self, *, requestContext: "RequestContextTypeDef", hitlTaskId: str + self, *, requestContext: RequestContextTypeDef, hitlTaskId: str ) -> GetHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'stri... + API used by agents to Get the status for a Human-In-The-Loop request. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_hitl_task) """ def get_job( - self, *, requestContext: "RequestContextTypeDef", includeObjective: bool = None + self, *, requestContext: RequestContextTypeDef, includeObjective: bool = ... ) -> GetJobResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = client.get_job( - requestContext={ 'jobMetadata': { 'jobId': 'string', 'workspaceId': 'string' ... + API used by agents to Get details about a Transformation Job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetJob). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_job) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_job) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_job) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_job) """ def get_knowledge_base_ingestion( - self, *, requestContext: "RequestContextTypeDef", ingestionId: str + self, *, requestContext: RequestContextTypeDef, ingestionId: str ) -> GetKnowledgeBaseIngestionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.get_knowledge_base_ingestion( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to get ingestion details See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetKnowledgeBaseIngestion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_knowledge_base_ingestion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_knowledge_base_ingestion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_knowledge_base_ingestion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_knowledge_base_ingestion) """ def get_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - params: Dict[str, Any] = None + params: Mapping[str, Any] = ..., ) -> GetTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... + This API is modeled similarly to the corresponding A2A protocol method + (https://a2a-protocol.org/latest/specification/#73-tasksget). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_task) """ def get_temporary_credentials_for_connector( - self, *, requestContext: "RequestContextTypeDef", connectorId: str, targetRegion: str = None + self, *, requestContext: RequestContextTypeDef, connectorId: str, targetRegion: str = ... ) -> GetTemporaryCredentialsForConnectorResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request - Syntax** response = client.get_temporary_credentials_for_connector( - requestContext={ 'jobMetadata': { 'jo... + API used by agents to get temporary credentials and details related to data + source See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetTemporaryCredentialsForConnector). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_temporary_credentials_for_connector) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_temporary_credentials_for_connector) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_temporary_credentials_for_connector) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_temporary_credentials_for_connector) """ def get_temporary_credentials_for_role( - self, *, requestContext: "RequestContextTypeDef", hitlTaskId: str + self, *, requestContext: RequestContextTypeDef, hitlTaskId: str ) -> GetTemporaryCredentialsForRoleResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.get_temporary_credentials_for_role( requestContext={ - 'jobMetadata': { 'jobId': 'str... + API used by agents to get temporary credentials for a given IAM role See also: + [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetTemporaryCredentialsForRole). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_temporary_credentials_for_role) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_temporary_credentials_for_role) + """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_temporary_credentials_for_role) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_temporary_credentials_for_role) + def get_umr(self, *, requestContext: RequestContextTypeDef) -> GetUMRResponseTypeDef: + """ + Retrieves the full UMR record for an engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_umr) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_umr) """ def get_usage( - self, *, requestContext: "RequestContextTypeDef", resourceTypes: List[ResourceTypeType] + self, *, requestContext: RequestContextTypeDef, resourceTypes: Sequence[ResourceTypeType] ) -> GetUsageResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_usage( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... + API used to get a customers usage of a resource type See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetUsage). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_usage) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_usage) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_usage) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_usage) """ def invoke_agent( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentId: str, - inputPayload: "AgentInputPayloadTypeDef" = None, - idempotencyToken: str = None, - agentVersion: str = None, - agentInstanceId: str = None, - agentType: AgentTypeType = None + inputPayload: AgentInputPayloadTypeDef = ..., + idempotencyToken: str = ..., + agentVersion: str = ..., + agentInstanceId: str = ..., + agentType: AgentTypeType = ..., ) -> InvokeAgentResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.invoke_agent( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'strin... + API used to Invoke Agents See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/InvokeAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.invoke_agent) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#invoke_agent) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.invoke_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#invoke_agent) """ def list_agent_instances( self, *, - requestContext: "RequestContextTypeDef", - nextToken: str = None, - agentFilter: "ListAgentFilterTypeDef" = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + nextToken: str = ..., + agentFilter: ListAgentFilterTypeDef = ..., + maxResults: int = ..., ) -> ListAgentInstancesResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_agent_instances( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'works... + API used to List all agent invocations for a specific transformation job See + also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListAgentInstances). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_agent_instances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_agent_instances) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_agent_instances) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_agent_instances) """ def list_agents( self, *, - requestContext: "RequestContextTypeDef", - agentFilter: "ListAgentsFilterTypeDef" = None, - nextToken: str = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + agentFilter: ListAgentsFilterTypeDef = ..., + nextToken: str = ..., + maxResults: int = ..., ) -> ListAgentsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_agents( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string'... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListAgents). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_agents) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_agents) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_agents) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_agents) """ def list_artifacts( self, *, - requestContext: "RequestContextTypeDef", - artifactFilter: "ArtifactFilterTypeDef" = None, - nextToken: str = None, - pathPrefix: str = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + artifactFilter: ArtifactFilterTypeDef = ..., + nextToken: str = ..., + pathPrefix: str = ..., + maxResults: int = ..., ) -> ListArtifactsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_artifacts( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + API used by agents to list artifacts for a transformation job See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListArtifacts). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_artifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_artifacts) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_artifacts) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_artifacts) """ def list_connectors( - self, - *, - requestContext: "RequestContextTypeDef", - maxResults: int = None, - nextToken: str = None + self, *, requestContext: RequestContextTypeDef, maxResults: int = ..., nextToken: str = ... ) -> ListConnectorsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_connectors( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': ... + API used by agents to get list of all the connectors available based on the + agent Type See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListConnectors). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_connectors) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_connectors) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_connectors) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_connectors) """ def list_hitl_tasks( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, taskType: HitlTaskTypeType, - taskFilter: "HitlTaskFilterTypeDef" = None, - nextToken: str = None, - maxResults: int = None + taskFilter: HitlTaskFilterTypeDef = ..., + nextToken: str = ..., + maxResults: int = ..., ) -> ListHitlTasksResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_hitl_tasks( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListHitlTasks). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_hitl_tasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_hitl_tasks) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_hitl_tasks) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_hitl_tasks) """ def list_job_plan_steps( self, *, - requestContext: "RequestContextTypeDef", - parentStepId: str = None, - maxResults: int = None, - nextToken: str = None + requestContext: RequestContextTypeDef, + parentStepId: str = ..., + maxResults: int = ..., + nextToken: str = ..., ) -> ListJobPlanStepsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_job_plan_steps( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspac... + API used by agents to list the plan steps for a job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListJobPlanSteps). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_job_plan_steps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_job_plan_steps) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_job_plan_steps) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_job_plan_steps) """ def list_worklogs( self, *, - requestContext: "RequestContextTypeDef", - worklogFilter: "WorklogFilterTypeDef" = None, - nextToken: str = None + requestContext: RequestContextTypeDef, + worklogFilter: WorklogFilterTypeDef = ..., + nextToken: str = ..., ) -> ListWorklogsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_worklogs( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_worklogs) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_worklogs) - """ - - def pre_prod_test_operation(self, *, requestContext: "RequestContextTypeDef") -> Dict[str, Any]: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.pre_prod_test_operation( requestContext={ 'jobMetadata': { 'jobId': - 'string', '... + API to allow retrieval of worklogs for a specific job. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.pre_prod_test_operation) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#pre_prod_test_operation) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_worklogs) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_worklogs) """ def publish_metering_event( self, *, - requestContext: "RequestContextTypeDef", - entity: "EntityTypeDef", + requestContext: RequestContextTypeDef, + entity: EntityTypeDef, resourceType: ResourceTypeType, resourceId: str, - startTime: Union[datetime, str], - amount: "MeteredAmountTypeDef" = None, - idempotencyToken: str = None, - attributes: List["MeteringAttributeTypeDef"] = None + startTime: TimestampTypeDef, + amount: MeteredAmountTypeDef = ..., + idempotencyToken: str = ..., + attributes: Sequence[MeteringAttributeTypeDef] = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.publish_metering_event( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'w... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/PublishMeteringEvent). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.publish_metering_event) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#publish_metering_event) + """ + + def put_agreement( + self, + *, + requestContext: RequestContextTypeDef, + agreementId: str, + agreementStatus: UmrAgreementStatusType, + agreementType: UmrIncentiveTypeType = ..., + executedTimestamp: TimestampTypeDef = ..., + amendmentVersion: int = ..., + agreementUrl: str = ..., + signedBy: str = ..., + awsSignatory: str = ..., + idempotencyToken: str = ..., + ) -> PutAgreementResponseTypeDef: + """ + Creates or updates agreement details for a UMR engagement. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.publish_metering_event) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#publish_metering_event) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_agreement) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_agreement) + """ + + def put_eligibility( + self, + *, + requestContext: RequestContextTypeDef, + outcome: UmrEligibilityOutcomeType, + assessmentDate: TimestampTypeDef, + assessmentScore: int = ..., + riskLevel: UmrRiskLevelType = ..., + qualificationCriteria: Mapping[str, bool] = ..., + idempotencyToken: str = ..., + ) -> PutEligibilityResponseTypeDef: + """ + Creates or updates eligibility assessment for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_eligibility) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_eligibility) """ def put_job_plan( self, *, - requestContext: "RequestContextTypeDef", - plan: "JobPlanTreeTypeDef", - mode: "PutJobPlanModeTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + plan: JobPlanTreeTypeDef, + mode: PutJobPlanModeTypeDef, + idempotencyToken: str = ..., ) -> PutJobPlanResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.put_job_plan( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string... + API used by agents to put a job plan See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/PutJobPlan). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.put_job_plan) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#put_job_plan) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_job_plan) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_job_plan) + """ + + def put_migration_plan( + self, + *, + requestContext: RequestContextTypeDef, + incentiveType: UmrIncentiveTypeType, + startDate: TimestampTypeDef, + endDate: TimestampTypeDef, + creditCap: float, + creditPercentage: float = ..., + linkedAccountDisbursement: bool = ..., + baselineSpend: Mapping[str, float] = ..., + programFlags: Mapping[str, bool] = ..., + partnerSpmsId: str = ..., + idempotencyToken: str = ..., + ) -> PutMigrationPlanResponseTypeDef: + """ + Creates or updates a migration plan for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_migration_plan) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_migration_plan) + """ + + def put_partner_details( + self, + *, + requestContext: RequestContextTypeDef, + partnerAccountId: str, + partnerName: str, + partnerType: UmrPartnerTypeType = ..., + migrationPhase: UmrMigrationPhaseType = ..., + prmId: str = ..., + workspaceId: str = ..., + resources: Sequence[UmrResourceUnionTypeDef] = ..., + idempotencyToken: str = ..., + ) -> PutPartnerDetailsResponseTypeDef: + """ + Creates or updates partner details for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_partner_details) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_partner_details) """ def refresh_auth_token( - self, *, requestContext: "RequestContextTypeDef", sessionDuration: int + self, *, requestContext: RequestContextTypeDef, sessionDuration: int ) -> RefreshAuthTokenResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.refresh_auth_token( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspace... + API used to generate a new agent authorization token with a later expiration + time See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RefreshAuthToken). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.refresh_auth_token) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#refresh_auth_token) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.refresh_auth_token) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#refresh_auth_token) """ def register_knowledge_base_document( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], - indexingMetadata: Dict[str, str] = None + indexingMetadata: Mapping[str, str] = ..., + ) -> Dict[str, Any]: + """ + API used by agents to register a document to knowledge base See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RegisterKnowledgeBaseDocument). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.register_knowledge_base_document) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#register_knowledge_base_document) + """ + + def restore_agent( + self, + *, + requestContext: RequestContextTypeDef, + agentId: str, + agentInstanceId: str, + agentType: AgentTypeType, + agentVersion: str = ..., + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.register_knowledge_base_document( requestContext={ - 'jobMetadata': { 'jobId': 'string... + API used to restore an agent instance, supporting session chaining when an + agent is approaching the max session lifetime See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RestoreAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.register_knowledge_base_document) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#register_knowledge_base_document) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.restore_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#restore_agent) """ def retrieve_from_knowledge_base( self, *, - requestContext: "RequestContextTypeDef", - retrievalQuery: "RetrievalQueryTypeDef", + requestContext: RequestContextTypeDef, + retrievalQuery: RetrievalQueryTypeDef, retrievalScope: RetrievalScopeType, - retrievalConfiguration: "RetrievalConfigurationTypeDef" = None, - nextToken: str = None + retrievalConfiguration: RetrievalConfigurationTypeDef = ..., + nextToken: str = ..., ) -> RetrieveFromKnowledgeBaseResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.retrieve_from_knowledge_base( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to retrieve information from knowledge base See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RetrieveFromKnowledgeBase). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.retrieve_from_knowledge_base) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#retrieve_from_knowledge_base) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.retrieve_from_knowledge_base) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#retrieve_from_knowledge_base) """ def rollback_metering_event( self, *, - requestContext: "RequestContextTypeDef", - entity: "EntityTypeDef", + requestContext: RequestContextTypeDef, + entity: EntityTypeDef, resourceType: ResourceTypeType, resourceId: str, - amendTime: Union[datetime, str] + amendTime: TimestampTypeDef, ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.rollback_metering_event( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RollbackMeteringEvent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.rollback_metering_event) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#rollback_metering_event) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.rollback_metering_event) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#rollback_metering_event) """ def send_message( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - params: Dict[str, Any] = None + params: Mapping[str, Any] = ..., ) -> SendMessageResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.send_message( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'strin... + This API is modeled similarly to the corresponding A2A protocol method + https://google-a2a.github.io/A2A/specification/#71-messagesend. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.send_message) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#send_message) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.send_message) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#send_message) """ def start_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, hitlTaskId: str, - firstInChain: bool = None, - idempotencyToken: str = None + firstInChain: bool = ..., + idempotencyToken: str = ..., ) -> StartHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.start_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StartHitlTask). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_hitl_task) - """ - - def start_job( - self, *, requestContext: "RequestContextTypeDef", idempotencyToken: str = None - ) -> StartJobResponseTypeDef: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.start_job( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_job) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_job) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.start_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#start_hitl_task) """ def start_knowledge_base_ingestion( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], - ingestionScopeMetadata: "IngestionScopeMetadataTypeDef", - ingestionConfiguration: "IngestionConfigurationTypeDef" = None + ingestionScopeMetadata: IngestionScopeMetadataTypeDef, + ingestionConfiguration: IngestionConfigurationTypeDef = ..., ) -> StartKnowledgeBaseIngestionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.start_knowledge_base_ingestion( requestContext={ - 'jobMetadata': { 'jobId': 'string', ... + API used by agents to start ingestion to knowledge base See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StartKnowledgeBaseIngestion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_knowledge_base_ingestion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_knowledge_base_ingestion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.start_knowledge_base_ingestion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#start_knowledge_base_ingestion) """ def stop_agent( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - idempotencyToken: str = None + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.stop_agent( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.stop_agent) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#stop_agent) - """ - - def test_operation(self, *, requestContext: "RequestContextTypeDef") -> Dict[str, Any]: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.test_operation( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StopAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.test_operation) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#test_operation) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.stop_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#stop_agent) """ def update_agent_instance( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, agentInstanceStatus: UpdateAgentInstanceStatusType, - agentInstanceStatusReason: str = None, - agentOutput: "AgentOutputPayloadTypeDef" = None + agentInstanceStatusReason: str = ..., + agentOutput: AgentOutputPayloadTypeDef = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_agent_instance( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'wor... + API used to Update details like status, output artifact, etc. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_agent_instance) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_agent_instance) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_agent_instance) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_agent_instance) """ def update_job_plan_step( self, *, - requestContext: "RequestContextTypeDef", - planStep: "PlanStepUpdateTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + planStep: PlanStepUpdateTypeDef, + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_job_plan_step( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'worksp... + API used by agents to update fields of an existing step of the job plan. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_job_plan_step) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_job_plan_step) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_job_plan_step) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_job_plan_step) """ def update_job_status( self, *, - requestContext: "RequestContextTypeDef", - status: JobStatusType = None, - statusInfo: "StatusInfoTypeDef" = None, - idempotencyToken: str = None, - notificationArtifactId: str = None + requestContext: RequestContextTypeDef, + status: JobStatusType = ..., + statusInfo: StatusInfoTypeDef = ..., + idempotencyToken: str = ..., + notificationArtifactId: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_job_status( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId... + API used by agents to update the status of a job they are operating on. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_job_status) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_job_status) + """ + + def update_umr_status( + self, + *, + requestContext: RequestContextTypeDef, + status: UmrStatusType, + idempotencyToken: str = ..., + ) -> UpdateUMRStatusResponseTypeDef: + """ + Updates the status of a UMR engagement. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_job_status) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_job_status) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_umr_status) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_umr_status) """ @overload @@ -937,22 +946,22 @@ def get_paginator( self, operation_name: Literal["list_agent_instances"] ) -> ListAgentInstancesPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload def get_paginator(self, operation_name: Literal["list_artifacts"]) -> ListArtifactsPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload def get_paginator(self, operation_name: Literal["list_hitl_tasks"]) -> ListHitlTasksPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload @@ -960,6 +969,6 @@ def get_paginator( self, operation_name: Literal["list_job_plan_steps"] ) -> ListJobPlanStepsPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ diff --git a/packages/types/src/agent_builder_types/client.pyi b/packages/types/src/agent_builder_types/client.pyi index a3ee556..ccb4e67 100644 --- a/packages/types/src/agent_builder_types/client.pyi +++ b/packages/types/src/agent_builder_types/client.pyi @@ -1,21 +1,23 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service client. +Type annotations for transformagenticservice service client. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/) Usage:: ```python - import boto3 - from agent_builder_types import TransformAgenticServiceClient + from boto3.session import Session + from agent_builder_types.client import TransformAgenticServiceClient - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") ``` """ import sys -from datetime import datetime -from typing import Any, Dict, List, Type, Union, overload +from typing import Any, Dict, Mapping, Sequence, Type, overload from botocore.client import BaseClient, ClientMeta @@ -29,6 +31,13 @@ from .literals import ( ResourceTypeType, RetrievalScopeType, SeverityType, + UmrAgreementStatusType, + UmrEligibilityOutcomeType, + UmrIncentiveTypeType, + UmrMigrationPhaseType, + UmrPartnerTypeType, + UmrRiskLevelType, + UmrStatusType, UpdateAgentInstanceStatusType, VisibilityType, ) @@ -63,6 +72,7 @@ from .type_defs import ( GetTaskResponseTypeDef, GetTemporaryCredentialsForConnectorResponseTypeDef, GetTemporaryCredentialsForRoleResponseTypeDef, + GetUMRResponseTypeDef, GetUsageResponseTypeDef, HitlTaskArtifactTypeDef, HitlTaskFilterTypeDef, @@ -79,12 +89,15 @@ from .type_defs import ( ListHitlTasksResponseTypeDef, ListJobPlanStepsResponseTypeDef, ListWorklogsResponseTypeDef, - MetadataContextTypeDef, MeteredAmountTypeDef, MeteringAttributeTypeDef, PlanStepUpdateTypeDef, + PutAgreementResponseTypeDef, + PutEligibilityResponseTypeDef, PutJobPlanModeTypeDef, PutJobPlanResponseTypeDef, + PutMigrationPlanResponseTypeDef, + PutPartnerDetailsResponseTypeDef, RefreshAuthTokenResponseTypeDef, RequestContextTypeDef, RetrievalConfigurationTypeDef, @@ -92,24 +105,26 @@ from .type_defs import ( RetrieveFromKnowledgeBaseResponseTypeDef, SendMessageResponseTypeDef, StartHitlTaskResponseTypeDef, - StartJobResponseTypeDef, StartKnowledgeBaseIngestionResponseTypeDef, StatusInfoTypeDef, + TimestampTypeDef, + UmrResourceUnionTypeDef, + UpdateUMRStatusResponseTypeDef, WorklogFilterTypeDef, - WorklogTypeDef, + WorklogUnionTypeDef, ) -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal __all__ = ("TransformAgenticServiceClient",) -class BotocoreClientError(BaseException): +class BotocoreClientError(Exception): MSG_TEMPLATE: str - def __init__(self, error_response: Dict[str, Any], operation_name: str) -> None: + def __init__(self, error_response: Mapping[str, Any], operation_name: str) -> None: self.response: Dict[str, Any] self.operation_name: str @@ -130,8 +145,8 @@ class Exceptions: class TransformAgenticServiceClient(BaseClient): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/) """ meta: ClientMeta @@ -140,790 +155,787 @@ class TransformAgenticServiceClient(BaseClient): def exceptions(self) -> Exceptions: """ TransformAgenticServiceClient exceptions. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.exceptions) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#exceptions) """ def acknowledge_deletion( - self, *, requestContext: "RequestContextTypeDef", deletionAcknowledgementToken: str + self, *, requestContext: RequestContextTypeDef, deletionAcknowledgementToken: str ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.acknowledge_deletion( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'work... + API used by agents to acknowledge they have completed the data cleanup for the + corresponding job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/AcknowledgeDeletion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.acknowledge_deletion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#acknowledge_deletion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.acknowledge_deletion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#acknowledge_deletion) """ def can_paginate(self, operation_name: str) -> bool: """ Check if an operation can be paginated. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.can_paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#can_paginate) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.can_paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#can_paginate) """ def close(self) -> None: """ Closes underlying endpoint connections. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.close) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#close) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.close) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#close) """ def close_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, hitlTaskId: str, - closureType: ClosureTypeType = None, - idempotencyToken: str = None + closureType: ClosureTypeType = ..., + idempotencyToken: str = ..., ) -> CloseHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.close_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CloseHitlTask). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.close_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#close_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.close_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#close_hitl_task) """ def complete_artifact_upload( - self, *, requestContext: "RequestContextTypeDef", artifactId: str + self, *, requestContext: RequestContextTypeDef, artifactId: str ) -> CompleteArtifactUploadResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.complete_artifact_upload( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + API used by agents to let ATX Foundation know that upload is complete. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.complete_artifact_upload) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#complete_artifact_upload) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.complete_artifact_upload) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#complete_artifact_upload) """ def copy_artifact( - self, - *, - requestContext: "RequestContextTypeDef", - artifactId: str, - idempotencyToken: str = None + self, *, requestContext: RequestContextTypeDef, artifactId: str, idempotencyToken: str = ... ) -> CopyArtifactResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.copy_artifact( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... + API used by agents to copy artifacts from artifact store bucket to public + bucket See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CopyArtifact). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.copy_artifact) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#copy_artifact) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.copy_artifact) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#copy_artifact) """ def create_artifact_download_url( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, - visibility: VisibilityType = None + visibility: VisibilityType = ..., ) -> CreateArtifactDownloadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.create_artifact_download_url( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to generate an S3 presigned URL for downloading an artifact. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_artifact_download_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_artifact_download_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_artifact_download_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_artifact_download_url) """ def create_artifact_upload_url( self, *, - requestContext: "RequestContextTypeDef", - contentDigest: "ContentDigestTypeDef", - artifactReference: "ArtifactReferenceTypeDef", - label: str = None, - planStepId: str = None, - visibility: VisibilityType = None, - metadata: "MetadataContextTypeDef" = None, - fileMetadata: "FileMetadataTypeDef" = None + requestContext: RequestContextTypeDef, + contentDigest: ContentDigestTypeDef, + artifactReference: ArtifactReferenceTypeDef, + label: str = ..., + planStepId: str = ..., + visibility: VisibilityType = ..., + fileMetadata: FileMetadataTypeDef = ..., ) -> CreateArtifactUploadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response - = client.create_artifact_upload_url( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + API used by agents to generate an S3 presigned URL for uploading an artifact. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_artifact_upload_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_artifact_upload_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_artifact_upload_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_artifact_upload_url) """ def create_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, uxComponentId: str, description: str, title: str, - severity: SeverityType = None, - hitlTaskType: HitlTaskTypeType = None, - stepId: str = None, - blockingType: BlockingTypeType = None, - hitlRequestArtifact: "HitlTaskArtifactTypeDef" = None, - expiredAt: Union[datetime, str] = None, - tag: str = None, - idempotencyToken: str = None, - category: CategoryType = None + severity: SeverityType = ..., + hitlTaskType: HitlTaskTypeType = ..., + stepId: str = ..., + blockingType: BlockingTypeType = ..., + hitlRequestArtifact: HitlTaskArtifactTypeDef = ..., + expiredAt: TimestampTypeDef = ..., + tag: str = ..., + idempotencyToken: str = ..., + category: CategoryType = ..., ) -> CreateHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId':... + API used by agents to trigger a Human-In-The-Loop request. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_hitl_task) """ def create_skill_download_url( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, skillName: str, - idempotencyToken: str = None, - version: str = None + idempotencyToken: str = ..., + version: str = ..., ) -> CreateSkillDownloadUrlResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_skill_download_url( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CreateSkillDownloadUrl). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_skill_download_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_skill_download_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_skill_download_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_skill_download_url) """ def create_worklog( self, *, - requestContext: "RequestContextTypeDef", - worklog: "WorklogTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + worklog: WorklogUnionTypeDef, + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.create_worklog( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + API to allow ingestion of agent/ HITL/ job level worklogs See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/CreateWorklog). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.create_worklog) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#create_worklog) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.create_worklog) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#create_worklog) """ def delete_job_plan_step( - self, *, requestContext: "RequestContextTypeDef", stepId: str, idempotencyToken: str = None + self, *, requestContext: RequestContextTypeDef, stepId: str, idempotencyToken: str = ... ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.delete_job_plan_step( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'worksp... + API used by agents to delete an existing step of the job plan. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.delete_job_plan_step) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#delete_job_plan_step) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.delete_job_plan_step) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#delete_job_plan_step) """ def deregister_knowledge_base_document( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, - knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"] + knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.deregister_knowledge_base_document( requestContext={ - 'jobMetadata': { 'jobId': 'st... + API used by agents to deregister a document from knowledge base See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/DeregisterKnowledgeBaseDocument). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.deregister_knowledge_base_document) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#deregister_knowledge_base_document) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.deregister_knowledge_base_document) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#deregister_knowledge_base_document) """ def generate_presigned_url( self, ClientMethod: str, - Params: Dict[str, Any] = None, + Params: Mapping[str, Any] = ..., ExpiresIn: int = 3600, - HttpMethod: str = None, + HttpMethod: str = ..., ) -> str: """ Generate a presigned url given a client, its method, and arguments. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.generate_presigned_url) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#generate_presigned_url) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.generate_presigned_url) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#generate_presigned_url) """ def get_agent_instance( - self, *, requestContext: "RequestContextTypeDef", agentInstanceId: str + self, *, requestContext: RequestContextTypeDef, agentInstanceId: str ) -> GetAgentInstanceResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_agent_instance( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspace... + API used to Get details about a specific agent's invocation See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetAgentInstance). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_agent_instance) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_agent_instance) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_agent_instance) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_agent_instance) """ def get_agent_version( - self, *, requestContext: "RequestContextTypeDef", name: str, version: str = None + self, *, requestContext: RequestContextTypeDef, name: str, version: str = ... ) -> GetAgentVersionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_agent_version( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetAgentVersion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_agent_version) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_agent_version) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_agent_version) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_agent_version) """ def get_artifact_metadata( - self, *, requestContext: "RequestContextTypeDef", artifactId: str + self, *, requestContext: RequestContextTypeDef, artifactId: str ) -> GetArtifactMetadataResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_artifact_metadata( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'wor... + This API is used to retrieve metadata about an artifact See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetArtifactMetadata). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_artifact_metadata) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_artifact_metadata) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_artifact_metadata) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_artifact_metadata) """ def get_connector( - self, *, requestContext: "RequestContextTypeDef", connectorId: str + self, *, requestContext: RequestContextTypeDef, connectorId: str ) -> GetConnectorResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_connector( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... + API used by agents to get resource level details of connector by connectorId + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetConnector). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_connector) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_connector) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_connector) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_connector) """ def get_hitl_task( - self, *, requestContext: "RequestContextTypeDef", hitlTaskId: str + self, *, requestContext: RequestContextTypeDef, hitlTaskId: str ) -> GetHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'stri... + API used by agents to Get the status for a Human-In-The-Loop request. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_hitl_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_hitl_task) """ def get_job( - self, *, requestContext: "RequestContextTypeDef", includeObjective: bool = None + self, *, requestContext: RequestContextTypeDef, includeObjective: bool = ... ) -> GetJobResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = client.get_job( - requestContext={ 'jobMetadata': { 'jobId': 'string', 'workspaceId': 'string' ... + API used by agents to Get details about a Transformation Job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetJob). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_job) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_job) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_job) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_job) """ def get_knowledge_base_ingestion( - self, *, requestContext: "RequestContextTypeDef", ingestionId: str + self, *, requestContext: RequestContextTypeDef, ingestionId: str ) -> GetKnowledgeBaseIngestionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.get_knowledge_base_ingestion( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to get ingestion details See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetKnowledgeBaseIngestion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_knowledge_base_ingestion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_knowledge_base_ingestion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_knowledge_base_ingestion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_knowledge_base_ingestion) """ def get_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - params: Dict[str, Any] = None + params: Mapping[str, Any] = ..., ) -> GetTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... + This API is modeled similarly to the corresponding A2A protocol method + (https://a2a-protocol.org/latest/specification/#73-tasksget). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_task) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_task) """ def get_temporary_credentials_for_connector( - self, *, requestContext: "RequestContextTypeDef", connectorId: str, targetRegion: str = None + self, *, requestContext: RequestContextTypeDef, connectorId: str, targetRegion: str = ... ) -> GetTemporaryCredentialsForConnectorResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request - Syntax** response = client.get_temporary_credentials_for_connector( - requestContext={ 'jobMetadata': { 'jo... + API used by agents to get temporary credentials and details related to data + source See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetTemporaryCredentialsForConnector). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_temporary_credentials_for_connector) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_temporary_credentials_for_connector) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_temporary_credentials_for_connector) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_temporary_credentials_for_connector) """ def get_temporary_credentials_for_role( - self, *, requestContext: "RequestContextTypeDef", hitlTaskId: str + self, *, requestContext: RequestContextTypeDef, hitlTaskId: str ) -> GetTemporaryCredentialsForRoleResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.get_temporary_credentials_for_role( requestContext={ - 'jobMetadata': { 'jobId': 'str... + API used by agents to get temporary credentials for a given IAM role See also: + [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetTemporaryCredentialsForRole). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_temporary_credentials_for_role) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_temporary_credentials_for_role) + """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_temporary_credentials_for_role) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_temporary_credentials_for_role) + def get_umr(self, *, requestContext: RequestContextTypeDef) -> GetUMRResponseTypeDef: + """ + Retrieves the full UMR record for an engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_umr) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_umr) """ def get_usage( - self, *, requestContext: "RequestContextTypeDef", resourceTypes: List[ResourceTypeType] + self, *, requestContext: RequestContextTypeDef, resourceTypes: Sequence[ResourceTypeType] ) -> GetUsageResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.get_usage( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... + API used to get a customers usage of a resource type See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/GetUsage). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.get_usage) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#get_usage) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_usage) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_usage) """ def invoke_agent( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentId: str, - inputPayload: "AgentInputPayloadTypeDef" = None, - idempotencyToken: str = None, - agentVersion: str = None, - agentInstanceId: str = None, - agentType: AgentTypeType = None + inputPayload: AgentInputPayloadTypeDef = ..., + idempotencyToken: str = ..., + agentVersion: str = ..., + agentInstanceId: str = ..., + agentType: AgentTypeType = ..., ) -> InvokeAgentResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.invoke_agent( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'strin... + API used to Invoke Agents See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/InvokeAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.invoke_agent) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#invoke_agent) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.invoke_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#invoke_agent) """ def list_agent_instances( self, *, - requestContext: "RequestContextTypeDef", - nextToken: str = None, - agentFilter: "ListAgentFilterTypeDef" = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + nextToken: str = ..., + agentFilter: ListAgentFilterTypeDef = ..., + maxResults: int = ..., ) -> ListAgentInstancesResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_agent_instances( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'works... + API used to List all agent invocations for a specific transformation job See + also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListAgentInstances). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_agent_instances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_agent_instances) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_agent_instances) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_agent_instances) """ def list_agents( self, *, - requestContext: "RequestContextTypeDef", - agentFilter: "ListAgentsFilterTypeDef" = None, - nextToken: str = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + agentFilter: ListAgentsFilterTypeDef = ..., + nextToken: str = ..., + maxResults: int = ..., ) -> ListAgentsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_agents( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string'... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListAgents). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_agents) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_agents) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_agents) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_agents) """ def list_artifacts( self, *, - requestContext: "RequestContextTypeDef", - artifactFilter: "ArtifactFilterTypeDef" = None, - nextToken: str = None, - pathPrefix: str = None, - maxResults: int = None + requestContext: RequestContextTypeDef, + artifactFilter: ArtifactFilterTypeDef = ..., + nextToken: str = ..., + pathPrefix: str = ..., + maxResults: int = ..., ) -> ListArtifactsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_artifacts( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + API used by agents to list artifacts for a transformation job See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListArtifacts). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_artifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_artifacts) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_artifacts) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_artifacts) """ def list_connectors( - self, - *, - requestContext: "RequestContextTypeDef", - maxResults: int = None, - nextToken: str = None + self, *, requestContext: RequestContextTypeDef, maxResults: int = ..., nextToken: str = ... ) -> ListConnectorsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_connectors( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': ... + API used by agents to get list of all the connectors available based on the + agent Type See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListConnectors). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_connectors) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_connectors) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_connectors) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_connectors) """ def list_hitl_tasks( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, taskType: HitlTaskTypeType, - taskFilter: "HitlTaskFilterTypeDef" = None, - nextToken: str = None, - maxResults: int = None + taskFilter: HitlTaskFilterTypeDef = ..., + nextToken: str = ..., + maxResults: int = ..., ) -> ListHitlTasksResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_hitl_tasks( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListHitlTasks). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_hitl_tasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_hitl_tasks) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_hitl_tasks) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_hitl_tasks) """ def list_job_plan_steps( self, *, - requestContext: "RequestContextTypeDef", - parentStepId: str = None, - maxResults: int = None, - nextToken: str = None + requestContext: RequestContextTypeDef, + parentStepId: str = ..., + maxResults: int = ..., + nextToken: str = ..., ) -> ListJobPlanStepsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_job_plan_steps( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspac... + API used by agents to list the plan steps for a job See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/ListJobPlanSteps). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_job_plan_steps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_job_plan_steps) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_job_plan_steps) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_job_plan_steps) """ def list_worklogs( self, *, - requestContext: "RequestContextTypeDef", - worklogFilter: "WorklogFilterTypeDef" = None, - nextToken: str = None + requestContext: RequestContextTypeDef, + worklogFilter: WorklogFilterTypeDef = ..., + nextToken: str = ..., ) -> ListWorklogsResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.list_worklogs( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'str... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.list_worklogs) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#list_worklogs) - """ - - def pre_prod_test_operation(self, *, requestContext: "RequestContextTypeDef") -> Dict[str, Any]: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.pre_prod_test_operation( requestContext={ 'jobMetadata': { 'jobId': - 'string', '... + API to allow retrieval of worklogs for a specific job. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.pre_prod_test_operation) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#pre_prod_test_operation) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.list_worklogs) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#list_worklogs) """ def publish_metering_event( self, *, - requestContext: "RequestContextTypeDef", - entity: "EntityTypeDef", + requestContext: RequestContextTypeDef, + entity: EntityTypeDef, resourceType: ResourceTypeType, resourceId: str, - startTime: Union[datetime, str], - amount: "MeteredAmountTypeDef" = None, - idempotencyToken: str = None, - attributes: List["MeteringAttributeTypeDef"] = None + startTime: TimestampTypeDef, + amount: MeteredAmountTypeDef = ..., + idempotencyToken: str = ..., + attributes: Sequence[MeteringAttributeTypeDef] = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.publish_metering_event( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'w... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/PublishMeteringEvent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.publish_metering_event) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#publish_metering_event) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.publish_metering_event) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#publish_metering_event) + """ + + def put_agreement( + self, + *, + requestContext: RequestContextTypeDef, + agreementId: str, + agreementStatus: UmrAgreementStatusType, + agreementType: UmrIncentiveTypeType = ..., + executedTimestamp: TimestampTypeDef = ..., + amendmentVersion: int = ..., + agreementUrl: str = ..., + signedBy: str = ..., + awsSignatory: str = ..., + idempotencyToken: str = ..., + ) -> PutAgreementResponseTypeDef: + """ + Creates or updates agreement details for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_agreement) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_agreement) + """ + + def put_eligibility( + self, + *, + requestContext: RequestContextTypeDef, + outcome: UmrEligibilityOutcomeType, + assessmentDate: TimestampTypeDef, + assessmentScore: int = ..., + riskLevel: UmrRiskLevelType = ..., + qualificationCriteria: Mapping[str, bool] = ..., + idempotencyToken: str = ..., + ) -> PutEligibilityResponseTypeDef: + """ + Creates or updates eligibility assessment for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_eligibility) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_eligibility) """ def put_job_plan( self, *, - requestContext: "RequestContextTypeDef", - plan: "JobPlanTreeTypeDef", - mode: "PutJobPlanModeTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + plan: JobPlanTreeTypeDef, + mode: PutJobPlanModeTypeDef, + idempotencyToken: str = ..., ) -> PutJobPlanResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.put_job_plan( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string... + API used by agents to put a job plan See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/PutJobPlan). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_job_plan) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_job_plan) + """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.put_job_plan) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#put_job_plan) + def put_migration_plan( + self, + *, + requestContext: RequestContextTypeDef, + incentiveType: UmrIncentiveTypeType, + startDate: TimestampTypeDef, + endDate: TimestampTypeDef, + creditCap: float, + creditPercentage: float = ..., + linkedAccountDisbursement: bool = ..., + baselineSpend: Mapping[str, float] = ..., + programFlags: Mapping[str, bool] = ..., + partnerSpmsId: str = ..., + idempotencyToken: str = ..., + ) -> PutMigrationPlanResponseTypeDef: + """ + Creates or updates a migration plan for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_migration_plan) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_migration_plan) + """ + + def put_partner_details( + self, + *, + requestContext: RequestContextTypeDef, + partnerAccountId: str, + partnerName: str, + partnerType: UmrPartnerTypeType = ..., + migrationPhase: UmrMigrationPhaseType = ..., + prmId: str = ..., + workspaceId: str = ..., + resources: Sequence[UmrResourceUnionTypeDef] = ..., + idempotencyToken: str = ..., + ) -> PutPartnerDetailsResponseTypeDef: + """ + Creates or updates partner details for a UMR engagement. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.put_partner_details) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#put_partner_details) """ def refresh_auth_token( - self, *, requestContext: "RequestContextTypeDef", sessionDuration: int + self, *, requestContext: RequestContextTypeDef, sessionDuration: int ) -> RefreshAuthTokenResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.refresh_auth_token( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspace... + API used to generate a new agent authorization token with a later expiration + time See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RefreshAuthToken). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.refresh_auth_token) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#refresh_auth_token) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.refresh_auth_token) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#refresh_auth_token) """ def register_knowledge_base_document( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, artifactId: str, knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], - indexingMetadata: Dict[str, str] = None + indexingMetadata: Mapping[str, str] = ..., + ) -> Dict[str, Any]: + """ + API used by agents to register a document to knowledge base See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RegisterKnowledgeBaseDocument). + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.register_knowledge_base_document) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#register_knowledge_base_document) + """ + + def restore_agent( + self, + *, + requestContext: RequestContextTypeDef, + agentId: str, + agentInstanceId: str, + agentType: AgentTypeType, + agentVersion: str = ..., + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.register_knowledge_base_document( requestContext={ - 'jobMetadata': { 'jobId': 'string... + API used to restore an agent instance, supporting session chaining when an + agent is approaching the max session lifetime See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RestoreAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.register_knowledge_base_document) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#register_knowledge_base_document) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.restore_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#restore_agent) """ def retrieve_from_knowledge_base( self, *, - requestContext: "RequestContextTypeDef", - retrievalQuery: "RetrievalQueryTypeDef", + requestContext: RequestContextTypeDef, + retrievalQuery: RetrievalQueryTypeDef, retrievalScope: RetrievalScopeType, - retrievalConfiguration: "RetrievalConfigurationTypeDef" = None, - nextToken: str = None + retrievalConfiguration: RetrievalConfigurationTypeDef = ..., + nextToken: str = ..., ) -> RetrieveFromKnowledgeBaseResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.retrieve_from_knowledge_base( requestContext={ 'jobMetadata': - { 'jobId': 'string', ... + API used by agents to retrieve information from knowledge base See also: [AWS + API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RetrieveFromKnowledgeBase). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.retrieve_from_knowledge_base) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#retrieve_from_knowledge_base) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.retrieve_from_knowledge_base) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#retrieve_from_knowledge_base) """ def rollback_metering_event( self, *, - requestContext: "RequestContextTypeDef", - entity: "EntityTypeDef", + requestContext: RequestContextTypeDef, + entity: EntityTypeDef, resourceType: ResourceTypeType, resourceId: str, - amendTime: Union[datetime, str] + amendTime: TimestampTypeDef, ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.rollback_metering_event( requestContext={ 'jobMetadata': { 'jobId': - 'string', ... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/RollbackMeteringEvent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.rollback_metering_event) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#rollback_metering_event) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.rollback_metering_event) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#rollback_metering_event) """ def send_message( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - params: Dict[str, Any] = None + params: Mapping[str, Any] = ..., ) -> SendMessageResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.send_message( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'strin... + This API is modeled similarly to the corresponding A2A protocol method + https://google-a2a.github.io/A2A/specification/#71-messagesend. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.send_message) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#send_message) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.send_message) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#send_message) """ def start_hitl_task( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, hitlTaskId: str, - firstInChain: bool = None, - idempotencyToken: str = None + firstInChain: bool = ..., + idempotencyToken: str = ..., ) -> StartHitlTaskResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.start_hitl_task( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': '... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StartHitlTask). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_hitl_task) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_hitl_task) - """ - - def start_job( - self, *, requestContext: "RequestContextTypeDef", idempotencyToken: str = None - ) -> StartJobResponseTypeDef: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.start_job( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_job) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_job) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.start_hitl_task) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#start_hitl_task) """ def start_knowledge_base_ingestion( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, knowledgeBaseConfigType: Literal["TEXT_TITAN_CONFIG"], - ingestionScopeMetadata: "IngestionScopeMetadataTypeDef", - ingestionConfiguration: "IngestionConfigurationTypeDef" = None + ingestionScopeMetadata: IngestionScopeMetadataTypeDef, + ingestionConfiguration: IngestionConfigurationTypeDef = ..., ) -> StartKnowledgeBaseIngestionResponseTypeDef: """ - See also: `AWS API Documentation `_ **Request Syntax** - response = client.start_knowledge_base_ingestion( requestContext={ - 'jobMetadata': { 'jobId': 'string', ... + API used by agents to start ingestion to knowledge base See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StartKnowledgeBaseIngestion). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.start_knowledge_base_ingestion) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#start_knowledge_base_ingestion) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.start_knowledge_base_ingestion) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#start_knowledge_base_ingestion) """ def stop_agent( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, - idempotencyToken: str = None + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.stop_agent( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 'string' ... - - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.stop_agent) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#stop_agent) - """ - - def test_operation(self, *, requestContext: "RequestContextTypeDef") -> Dict[str, Any]: - """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.test_operation( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId': 's... + See also: [AWS API + Documentation](https://docs.aws.amazon.com/goto/WebAPI/transformagents-2018-05-10/StopAgent). - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.test_operation) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#test_operation) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.stop_agent) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#stop_agent) """ def update_agent_instance( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, agentInstanceId: str, agentInstanceStatus: UpdateAgentInstanceStatusType, - agentInstanceStatusReason: str = None, - agentOutput: "AgentOutputPayloadTypeDef" = None + agentInstanceStatusReason: str = ..., + agentOutput: AgentOutputPayloadTypeDef = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_agent_instance( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'wor... + API used to Update details like status, output artifact, etc. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_agent_instance) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_agent_instance) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_agent_instance) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_agent_instance) """ def update_job_plan_step( self, *, - requestContext: "RequestContextTypeDef", - planStep: "PlanStepUpdateTypeDef", - idempotencyToken: str = None + requestContext: RequestContextTypeDef, + planStep: PlanStepUpdateTypeDef, + idempotencyToken: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_job_plan_step( requestContext={ 'jobMetadata': { 'jobId': - 'string', 'worksp... + API used by agents to update fields of an existing step of the job plan. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_job_plan_step) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_job_plan_step) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_job_plan_step) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_job_plan_step) """ def update_job_status( self, *, - requestContext: "RequestContextTypeDef", - status: JobStatusType = None, - statusInfo: "StatusInfoTypeDef" = None, - idempotencyToken: str = None, - notificationArtifactId: str = None + requestContext: RequestContextTypeDef, + status: JobStatusType = ..., + statusInfo: StatusInfoTypeDef = ..., + idempotencyToken: str = ..., + notificationArtifactId: str = ..., ) -> Dict[str, Any]: """ - See also: `AWS API Documentation `_ **Request Syntax** response = - client.update_job_status( requestContext={ 'jobMetadata': { 'jobId': 'string', - 'workspaceId... + API used by agents to update the status of a job they are operating on. + + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_job_status) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_job_status) + """ + + def update_umr_status( + self, + *, + requestContext: RequestContextTypeDef, + status: UmrStatusType, + idempotencyToken: str = ..., + ) -> UpdateUMRStatusResponseTypeDef: + """ + Updates the status of a UMR engagement. - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Client.update_job_status) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/client.html#update_job_status) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.update_umr_status) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#update_umr_status) """ @overload @@ -931,22 +943,22 @@ class TransformAgenticServiceClient(BaseClient): self, operation_name: Literal["list_agent_instances"] ) -> ListAgentInstancesPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload def get_paginator(self, operation_name: Literal["list_artifacts"]) -> ListArtifactsPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload def get_paginator(self, operation_name: Literal["list_hitl_tasks"]) -> ListHitlTasksPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ @overload @@ -954,6 +966,6 @@ class TransformAgenticServiceClient(BaseClient): self, operation_name: Literal["list_job_plan_steps"] ) -> ListJobPlanStepsPaginator: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Client.get_paginator) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/client/#get_paginator) """ diff --git a/packages/types/src/agent_builder_types/literals.py b/packages/types/src/agent_builder_types/literals.py index 3031e53..f709976 100644 --- a/packages/types/src/agent_builder_types/literals.py +++ b/packages/types/src/agent_builder_types/literals.py @@ -1,9 +1,9 @@ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service literal definitions. +Type annotations for transformagenticservice service literal definitions. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/literals.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/literals/) Usage:: @@ -16,12 +16,11 @@ import sys -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal - __all__ = ( "AccessControlType", "AccountConnectionStatusType", @@ -48,6 +47,7 @@ "ListHitlTasksPaginatorName", "ListJobPlanStepsPaginatorName", "MeteredUnitType", + "MonitoringTypeType", "OwnerTypeType", "PlanStepStatusType", "PutJobPlanStatusType", @@ -55,12 +55,24 @@ "RetrievalResultLocationTypeType", "RetrievalScopeType", "SeverityType", + "UmrAgreementStatusType", + "UmrEligibilityOutcomeType", + "UmrIncentiveTypeType", + "UmrMigrationPhaseType", + "UmrPartnerTypeType", + "UmrResourceStatusType", + "UmrResourceTypeType", + "UmrRiskLevelType", + "UmrStatusType", "UpdateAgentInstanceStatusType", "VersionStatusType", "VisibilityType", + "TransformAgenticServiceServiceName", + "ServiceName", + "ResourceServiceName", + "PaginatorName", ) - AccessControlType = Literal["DISABLED", "ENABLED"] AccountConnectionStatusType = Literal["ACTIVE", "PENDING", "REJECTED"] ActionType = Literal["APPROVE", "REJECT"] @@ -128,6 +140,7 @@ ListHitlTasksPaginatorName = Literal["list_hitl_tasks"] ListJobPlanStepsPaginatorName = Literal["list_job_plan_steps"] MeteredUnitType = Literal["COUNT"] +MonitoringTypeType = Literal["HEALTHCHECK", "HEARTBEAT"] OwnerTypeType = Literal["DIRECT_AGENT", "INTERNAL_AGENT", "MARKETPLACE_AGENT"] PlanStepStatusType = Literal[ "FAILED", "IN_PROGRESS", "NOT_STARTED", "PENDING_HUMAN_INPUT", "STOPPED", "SUCCEEDED" @@ -167,6 +180,480 @@ RetrievalResultLocationTypeType = Literal["S3", "WEB"] RetrievalScopeType = Literal["AGENT_INGESTED", "AWS", "PRODUCT"] SeverityType = Literal["CRITICAL", "STANDARD"] +UmrAgreementStatusType = Literal["AMENDED", "EXECUTED", "PENDING", "TERMINATED"] +UmrEligibilityOutcomeType = Literal["APPROVED", "DENIED", "PENDING"] +UmrIncentiveTypeType = Literal["CASH", "CASH_AND_CREDIT", "CREDIT"] +UmrMigrationPhaseType = Literal["ASSESS", "MIGRATE", "MOBILIZE", "MODERNIZE"] +UmrPartnerTypeType = Literal[ + "CONSULTING_PARTNER", + "DISTRIBUTOR", + "MANAGED_SERVICE_PROVIDER", + "SOLUTION_PROVIDER", + "SYSTEM_INTEGRATOR", +] +UmrResourceStatusType = Literal["APPROVED", "DENIED", "PENDING", "SUBMITTED"] +UmrResourceTypeType = Literal[ + "BENEFIT_ALLOCATION", + "BENEFIT_APPLICATION", + "MIGRATION_ENGAGEMENT_RECORD", + "OPPORTUNITY", + "OTHER", +] +UmrRiskLevelType = Literal["HIGH", "LOW", "MEDIUM"] +UmrStatusType = Literal["ACTIVE", "CANCELLED", "COMPLETED"] UpdateAgentInstanceStatusType = Literal["COMPLETED", "FAILED", "RUNNING", "STOPPED"] VersionStatusType = Literal["ACTIVE", "CREATED", "IN_VERIFICATION", "VERIFICATION_FAILED"] VisibilityType = Literal["EXTERNAL", "INTERNAL"] +TransformAgenticServiceServiceName = Literal["transformagenticservice"] +ServiceName = Literal[ + "accessanalyzer", + "account", + "acm", + "acm-pca", + "aiops", + "amp", + "amplify", + "amplifybackend", + "amplifyuibuilder", + "apigateway", + "apigatewaymanagementapi", + "apigatewayv2", + "appconfig", + "appconfigdata", + "appfabric", + "appflow", + "appintegrations", + "application-autoscaling", + "application-insights", + "application-signals", + "applicationcostprofiler", + "appmesh", + "apprunner", + "appstream", + "appsync", + "apptest", + "arc-region-switch", + "arc-zonal-shift", + "artifact", + "athena", + "atx-agent-registry-ext", + "atx-agent-registry-int", + "atxagentregistryexternal", + "auditmanager", + "authz", + "autoscaling", + "autoscaling-plans", + "awstransformagenticservice", + "awstransformagentregistryexternal", + "b2bi", + "backup", + "backup-gateway", + "backupsearch", + "batch", + "bcm-dashboards", + "bcm-data-exports", + "bcm-pricing-calculator", + "bcm-recommended-actions", + "bedrock", + "bedrock-agent", + "bedrock-agent-runtime", + "bedrock-agentcore", + "bedrock-agentcore-control", + "bedrock-data-automation", + "bedrock-data-automation-runtime", + "bedrock-runtime", + "billing", + "billingconductor", + "braket", + "budgets", + "ce", + "chat", + "chatbot", + "chime", + "chime-sdk-identity", + "chime-sdk-media-pipelines", + "chime-sdk-meetings", + "chime-sdk-messaging", + "chime-sdk-voice", + "cleanrooms", + "cleanroomsml", + "cloud9", + "cloudcontrol", + "clouddirectory", + "cloudformation", + "cloudfront", + "cloudfront-keyvaluestore", + "cloudhsm", + "cloudhsmv2", + "cloudsearch", + "cloudsearchdomain", + "cloudtrail", + "cloudtrail-data", + "cloudwatch", + "codeartifact", + "codebuild", + "codecatalyst", + "codecommit", + "codeconnections", + "codedeploy", + "codeguru-reviewer", + "codeguru-security", + "codeguruprofiler", + "codepipeline", + "codestar-connections", + "codestar-notifications", + "cognito-identity", + "cognito-idp", + "cognito-sync", + "comprehend", + "comprehendmedical", + "compute-optimizer", + "config", + "connect", + "connect-contact-lens", + "connectcampaigns", + "connectcampaignsv2", + "connectcases", + "connectparticipant", + "consolas", + "controlcatalog", + "controltower", + "cost-optimization-hub", + "cur", + "customer-profiles", + "databrew", + "dataexchange", + "datapipeline", + "datasync", + "datazone", + "dax", + "deadline", + "detective", + "devicefarm", + "devops-guru", + "directconnect", + "discovery", + "dlm", + "dms", + "docdb", + "docdb-elastic", + "drs", + "ds", + "ds-data", + "dsql", + "dynamodb", + "dynamodbstreams", + "ebs", + "ec2", + "ec2-instance-connect", + "ecr", + "ecr-public", + "ecs", + "efs", + "egartifact", + "eks", + "eks-auth", + "elasticache", + "elasticbeanstalk", + "elasticgumbyagenticservice", + "elastictranscoder", + "elb", + "elbv2", + "emr", + "emr-containers", + "emr-serverless", + "entityresolution", + "es", + "events", + "evidently", + "evs", + "external-registry", + "finspace", + "finspace-data", + "firehose", + "fis", + "fms", + "forecast", + "forecastquery", + "frauddetector", + "freetier", + "fsx", + "gamelift", + "gameliftstreams", + "geo-maps", + "geo-places", + "geo-routes", + "glacier", + "globalaccelerator", + "glue", + "grafana", + "greengrass", + "greengrassv2", + "groundstation", + "guardduty", + "health", + "healthlake", + "iam", + "identitystore", + "imagebuilder", + "importexport", + "inspector", + "inspector-scan", + "inspector2", + "internetmonitor", + "invoicing", + "iot", + "iot-data", + "iot-jobs-data", + "iot-managed-integrations", + "iotanalytics", + "iotdeviceadvisor", + "iotevents", + "iotevents-data", + "iotfleethub", + "iotfleetwise", + "iotsecuretunneling", + "iotsitewise", + "iotthingsgraph", + "iottwinmaker", + "iotwireless", + "ivs", + "ivs-realtime", + "ivschat", + "kafka", + "kafkaconnect", + "kendra", + "kendra-ranking", + "keyspaces", + "keyspacesstreams", + "kinesis", + "kinesis-video-archived-media", + "kinesis-video-media", + "kinesis-video-signaling", + "kinesis-video-webrtc-storage", + "kinesisanalytics", + "kinesisanalyticsv2", + "kinesisvideo", + "kms", + "lakeformation", + "lambda", + "launch-wizard", + "lex-models", + "lex-runtime", + "lexv2-models", + "lexv2-runtime", + "license-manager", + "license-manager-linux-subscriptions", + "license-manager-user-subscriptions", + "lightsail", + "location", + "logs", + "lookoutequipment", + "lookoutmetrics", + "lookoutvision", + "m2", + "machinelearning", + "macie2", + "mailmanager", + "managedblockchain", + "managedblockchain-query", + "marketplace-agreement", + "marketplace-catalog", + "marketplace-deployment", + "marketplace-entitlement", + "marketplace-reporting", + "marketplacecommerceanalytics", + "mde", + "mediaconnect", + "mediaconvert", + "medialive", + "mediapackage", + "mediapackage-vod", + "mediapackagev2", + "mediastore", + "mediastore-data", + "mediatailor", + "medical-imaging", + "memorydb", + "meteringmarketplace", + "mgh", + "mgn", + "migration-hub-refactor-spaces", + "migrationhub-config", + "migrationhuborchestrator", + "migrationhubstrategy", + "mpa", + "mq", + "mturk", + "mwaa", + "neptune", + "neptune-graph", + "neptunedata", + "network-firewall", + "networkflowmonitor", + "networkmanager", + "networkmonitor", + "notifications", + "notificationscontacts", + "oam", + "observabilityadmin", + "odb", + "om", + "omics", + "opensearch", + "opensearchserverless", + "opsworks", + "opsworkscm", + "orchestration", + "organizations", + "osis", + "outposts", + "panorama", + "partnercentral-selling", + "payment-cryptography", + "payment-cryptography-data", + "pca-connector-ad", + "pca-connector-scep", + "pcs", + "personalize", + "personalize-events", + "personalize-runtime", + "pi", + "pinpoint", + "pinpoint-email", + "pinpoint-sms-voice", + "pinpoint-sms-voice-v2", + "pipes", + "polly", + "pricing", + "proton", + "qapps", + "qbusiness", + "qconnect", + "qldb", + "qldb-session", + "quicksight", + "ram", + "rbin", + "rds", + "rds-data", + "redshift", + "redshift-data", + "redshift-serverless", + "rekognition", + "repostspace", + "resiliencehub", + "resource-explorer-2", + "resource-groups", + "resourcegroupstaggingapi", + "robomaker", + "rolesanywhere", + "route53", + "route53-recovery-cluster", + "route53-recovery-control-config", + "route53-recovery-readiness", + "route53domains", + "route53profiles", + "route53resolver", + "rum", + "s3", + "s3control", + "s3outposts", + "s3tables", + "s3vectors", + "sagemaker", + "sagemaker-a2i-runtime", + "sagemaker-edge", + "sagemaker-featurestore-runtime", + "sagemaker-geospatial", + "sagemaker-metrics", + "sagemaker-runtime", + "savingsplans", + "scheduler", + "schemas", + "sdb", + "secretsmanager", + "security-ir", + "securityhub", + "securitylake", + "segst", + "segst-as", + "segst-cl", + "serverlessrepo", + "service-quotas", + "servicecatalog", + "servicecatalog-appregistry", + "servicediscovery", + "ses", + "sesv2", + "shield", + "signer", + "simspaceweaver", + "sms", + "sms-voice", + "snow-device-management", + "snowball", + "sns", + "socialmessaging", + "sqs", + "ssm", + "ssm-contacts", + "ssm-guiconnect", + "ssm-incidents", + "ssm-quicksetup", + "ssm-sap", + "sso", + "sso-admin", + "sso-oidc", + "stepfunctions", + "storagegateway", + "sts", + "supplychain", + "support", + "support-app", + "swf", + "synthetics", + "taxsettings", + "tcpexternal", + "textract", + "timestream-influxdb", + "timestream-query", + "timestream-write", + "tnb", + "transcribe", + "transfer", + "transformagenticservice", + "translate", + "trustedadvisor", + "verifiedpermissions", + "voice-id", + "vpc-lattice", + "waf", + "waf-regional", + "wafv2", + "wellarchitected", + "wisdom", + "workdocs", + "workmail", + "workmailmessageflow", + "workspaces", + "workspaces-instances", + "workspaces-thin-client", + "workspaces-web", + "xray", +] +ResourceServiceName = Literal[ + "cloudformation", + "cloudwatch", + "dynamodb", + "ec2", + "glacier", + "iam", + "opsworks", + "s3", + "sns", + "sqs", +] +PaginatorName = Literal[ + "list_agent_instances", "list_artifacts", "list_hitl_tasks", "list_job_plan_steps" +] diff --git a/packages/types/src/agent_builder_types/literals.pyi b/packages/types/src/agent_builder_types/literals.pyi index e83473c..f709976 100644 --- a/packages/types/src/agent_builder_types/literals.pyi +++ b/packages/types/src/agent_builder_types/literals.pyi @@ -1,7 +1,9 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service literal definitions. +Type annotations for transformagenticservice service literal definitions. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/literals.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/literals/) Usage:: @@ -14,7 +16,7 @@ Usage:: import sys -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal @@ -45,6 +47,7 @@ __all__ = ( "ListHitlTasksPaginatorName", "ListJobPlanStepsPaginatorName", "MeteredUnitType", + "MonitoringTypeType", "OwnerTypeType", "PlanStepStatusType", "PutJobPlanStatusType", @@ -52,9 +55,22 @@ __all__ = ( "RetrievalResultLocationTypeType", "RetrievalScopeType", "SeverityType", + "UmrAgreementStatusType", + "UmrEligibilityOutcomeType", + "UmrIncentiveTypeType", + "UmrMigrationPhaseType", + "UmrPartnerTypeType", + "UmrResourceStatusType", + "UmrResourceTypeType", + "UmrRiskLevelType", + "UmrStatusType", "UpdateAgentInstanceStatusType", "VersionStatusType", "VisibilityType", + "TransformAgenticServiceServiceName", + "ServiceName", + "ResourceServiceName", + "PaginatorName", ) AccessControlType = Literal["DISABLED", "ENABLED"] @@ -124,6 +140,7 @@ ListArtifactsPaginatorName = Literal["list_artifacts"] ListHitlTasksPaginatorName = Literal["list_hitl_tasks"] ListJobPlanStepsPaginatorName = Literal["list_job_plan_steps"] MeteredUnitType = Literal["COUNT"] +MonitoringTypeType = Literal["HEALTHCHECK", "HEARTBEAT"] OwnerTypeType = Literal["DIRECT_AGENT", "INTERNAL_AGENT", "MARKETPLACE_AGENT"] PlanStepStatusType = Literal[ "FAILED", "IN_PROGRESS", "NOT_STARTED", "PENDING_HUMAN_INPUT", "STOPPED", "SUCCEEDED" @@ -163,6 +180,480 @@ ResourceTypeType = Literal[ RetrievalResultLocationTypeType = Literal["S3", "WEB"] RetrievalScopeType = Literal["AGENT_INGESTED", "AWS", "PRODUCT"] SeverityType = Literal["CRITICAL", "STANDARD"] +UmrAgreementStatusType = Literal["AMENDED", "EXECUTED", "PENDING", "TERMINATED"] +UmrEligibilityOutcomeType = Literal["APPROVED", "DENIED", "PENDING"] +UmrIncentiveTypeType = Literal["CASH", "CASH_AND_CREDIT", "CREDIT"] +UmrMigrationPhaseType = Literal["ASSESS", "MIGRATE", "MOBILIZE", "MODERNIZE"] +UmrPartnerTypeType = Literal[ + "CONSULTING_PARTNER", + "DISTRIBUTOR", + "MANAGED_SERVICE_PROVIDER", + "SOLUTION_PROVIDER", + "SYSTEM_INTEGRATOR", +] +UmrResourceStatusType = Literal["APPROVED", "DENIED", "PENDING", "SUBMITTED"] +UmrResourceTypeType = Literal[ + "BENEFIT_ALLOCATION", + "BENEFIT_APPLICATION", + "MIGRATION_ENGAGEMENT_RECORD", + "OPPORTUNITY", + "OTHER", +] +UmrRiskLevelType = Literal["HIGH", "LOW", "MEDIUM"] +UmrStatusType = Literal["ACTIVE", "CANCELLED", "COMPLETED"] UpdateAgentInstanceStatusType = Literal["COMPLETED", "FAILED", "RUNNING", "STOPPED"] VersionStatusType = Literal["ACTIVE", "CREATED", "IN_VERIFICATION", "VERIFICATION_FAILED"] VisibilityType = Literal["EXTERNAL", "INTERNAL"] +TransformAgenticServiceServiceName = Literal["transformagenticservice"] +ServiceName = Literal[ + "accessanalyzer", + "account", + "acm", + "acm-pca", + "aiops", + "amp", + "amplify", + "amplifybackend", + "amplifyuibuilder", + "apigateway", + "apigatewaymanagementapi", + "apigatewayv2", + "appconfig", + "appconfigdata", + "appfabric", + "appflow", + "appintegrations", + "application-autoscaling", + "application-insights", + "application-signals", + "applicationcostprofiler", + "appmesh", + "apprunner", + "appstream", + "appsync", + "apptest", + "arc-region-switch", + "arc-zonal-shift", + "artifact", + "athena", + "atx-agent-registry-ext", + "atx-agent-registry-int", + "atxagentregistryexternal", + "auditmanager", + "authz", + "autoscaling", + "autoscaling-plans", + "awstransformagenticservice", + "awstransformagentregistryexternal", + "b2bi", + "backup", + "backup-gateway", + "backupsearch", + "batch", + "bcm-dashboards", + "bcm-data-exports", + "bcm-pricing-calculator", + "bcm-recommended-actions", + "bedrock", + "bedrock-agent", + "bedrock-agent-runtime", + "bedrock-agentcore", + "bedrock-agentcore-control", + "bedrock-data-automation", + "bedrock-data-automation-runtime", + "bedrock-runtime", + "billing", + "billingconductor", + "braket", + "budgets", + "ce", + "chat", + "chatbot", + "chime", + "chime-sdk-identity", + "chime-sdk-media-pipelines", + "chime-sdk-meetings", + "chime-sdk-messaging", + "chime-sdk-voice", + "cleanrooms", + "cleanroomsml", + "cloud9", + "cloudcontrol", + "clouddirectory", + "cloudformation", + "cloudfront", + "cloudfront-keyvaluestore", + "cloudhsm", + "cloudhsmv2", + "cloudsearch", + "cloudsearchdomain", + "cloudtrail", + "cloudtrail-data", + "cloudwatch", + "codeartifact", + "codebuild", + "codecatalyst", + "codecommit", + "codeconnections", + "codedeploy", + "codeguru-reviewer", + "codeguru-security", + "codeguruprofiler", + "codepipeline", + "codestar-connections", + "codestar-notifications", + "cognito-identity", + "cognito-idp", + "cognito-sync", + "comprehend", + "comprehendmedical", + "compute-optimizer", + "config", + "connect", + "connect-contact-lens", + "connectcampaigns", + "connectcampaignsv2", + "connectcases", + "connectparticipant", + "consolas", + "controlcatalog", + "controltower", + "cost-optimization-hub", + "cur", + "customer-profiles", + "databrew", + "dataexchange", + "datapipeline", + "datasync", + "datazone", + "dax", + "deadline", + "detective", + "devicefarm", + "devops-guru", + "directconnect", + "discovery", + "dlm", + "dms", + "docdb", + "docdb-elastic", + "drs", + "ds", + "ds-data", + "dsql", + "dynamodb", + "dynamodbstreams", + "ebs", + "ec2", + "ec2-instance-connect", + "ecr", + "ecr-public", + "ecs", + "efs", + "egartifact", + "eks", + "eks-auth", + "elasticache", + "elasticbeanstalk", + "elasticgumbyagenticservice", + "elastictranscoder", + "elb", + "elbv2", + "emr", + "emr-containers", + "emr-serverless", + "entityresolution", + "es", + "events", + "evidently", + "evs", + "external-registry", + "finspace", + "finspace-data", + "firehose", + "fis", + "fms", + "forecast", + "forecastquery", + "frauddetector", + "freetier", + "fsx", + "gamelift", + "gameliftstreams", + "geo-maps", + "geo-places", + "geo-routes", + "glacier", + "globalaccelerator", + "glue", + "grafana", + "greengrass", + "greengrassv2", + "groundstation", + "guardduty", + "health", + "healthlake", + "iam", + "identitystore", + "imagebuilder", + "importexport", + "inspector", + "inspector-scan", + "inspector2", + "internetmonitor", + "invoicing", + "iot", + "iot-data", + "iot-jobs-data", + "iot-managed-integrations", + "iotanalytics", + "iotdeviceadvisor", + "iotevents", + "iotevents-data", + "iotfleethub", + "iotfleetwise", + "iotsecuretunneling", + "iotsitewise", + "iotthingsgraph", + "iottwinmaker", + "iotwireless", + "ivs", + "ivs-realtime", + "ivschat", + "kafka", + "kafkaconnect", + "kendra", + "kendra-ranking", + "keyspaces", + "keyspacesstreams", + "kinesis", + "kinesis-video-archived-media", + "kinesis-video-media", + "kinesis-video-signaling", + "kinesis-video-webrtc-storage", + "kinesisanalytics", + "kinesisanalyticsv2", + "kinesisvideo", + "kms", + "lakeformation", + "lambda", + "launch-wizard", + "lex-models", + "lex-runtime", + "lexv2-models", + "lexv2-runtime", + "license-manager", + "license-manager-linux-subscriptions", + "license-manager-user-subscriptions", + "lightsail", + "location", + "logs", + "lookoutequipment", + "lookoutmetrics", + "lookoutvision", + "m2", + "machinelearning", + "macie2", + "mailmanager", + "managedblockchain", + "managedblockchain-query", + "marketplace-agreement", + "marketplace-catalog", + "marketplace-deployment", + "marketplace-entitlement", + "marketplace-reporting", + "marketplacecommerceanalytics", + "mde", + "mediaconnect", + "mediaconvert", + "medialive", + "mediapackage", + "mediapackage-vod", + "mediapackagev2", + "mediastore", + "mediastore-data", + "mediatailor", + "medical-imaging", + "memorydb", + "meteringmarketplace", + "mgh", + "mgn", + "migration-hub-refactor-spaces", + "migrationhub-config", + "migrationhuborchestrator", + "migrationhubstrategy", + "mpa", + "mq", + "mturk", + "mwaa", + "neptune", + "neptune-graph", + "neptunedata", + "network-firewall", + "networkflowmonitor", + "networkmanager", + "networkmonitor", + "notifications", + "notificationscontacts", + "oam", + "observabilityadmin", + "odb", + "om", + "omics", + "opensearch", + "opensearchserverless", + "opsworks", + "opsworkscm", + "orchestration", + "organizations", + "osis", + "outposts", + "panorama", + "partnercentral-selling", + "payment-cryptography", + "payment-cryptography-data", + "pca-connector-ad", + "pca-connector-scep", + "pcs", + "personalize", + "personalize-events", + "personalize-runtime", + "pi", + "pinpoint", + "pinpoint-email", + "pinpoint-sms-voice", + "pinpoint-sms-voice-v2", + "pipes", + "polly", + "pricing", + "proton", + "qapps", + "qbusiness", + "qconnect", + "qldb", + "qldb-session", + "quicksight", + "ram", + "rbin", + "rds", + "rds-data", + "redshift", + "redshift-data", + "redshift-serverless", + "rekognition", + "repostspace", + "resiliencehub", + "resource-explorer-2", + "resource-groups", + "resourcegroupstaggingapi", + "robomaker", + "rolesanywhere", + "route53", + "route53-recovery-cluster", + "route53-recovery-control-config", + "route53-recovery-readiness", + "route53domains", + "route53profiles", + "route53resolver", + "rum", + "s3", + "s3control", + "s3outposts", + "s3tables", + "s3vectors", + "sagemaker", + "sagemaker-a2i-runtime", + "sagemaker-edge", + "sagemaker-featurestore-runtime", + "sagemaker-geospatial", + "sagemaker-metrics", + "sagemaker-runtime", + "savingsplans", + "scheduler", + "schemas", + "sdb", + "secretsmanager", + "security-ir", + "securityhub", + "securitylake", + "segst", + "segst-as", + "segst-cl", + "serverlessrepo", + "service-quotas", + "servicecatalog", + "servicecatalog-appregistry", + "servicediscovery", + "ses", + "sesv2", + "shield", + "signer", + "simspaceweaver", + "sms", + "sms-voice", + "snow-device-management", + "snowball", + "sns", + "socialmessaging", + "sqs", + "ssm", + "ssm-contacts", + "ssm-guiconnect", + "ssm-incidents", + "ssm-quicksetup", + "ssm-sap", + "sso", + "sso-admin", + "sso-oidc", + "stepfunctions", + "storagegateway", + "sts", + "supplychain", + "support", + "support-app", + "swf", + "synthetics", + "taxsettings", + "tcpexternal", + "textract", + "timestream-influxdb", + "timestream-query", + "timestream-write", + "tnb", + "transcribe", + "transfer", + "transformagenticservice", + "translate", + "trustedadvisor", + "verifiedpermissions", + "voice-id", + "vpc-lattice", + "waf", + "waf-regional", + "wafv2", + "wellarchitected", + "wisdom", + "workdocs", + "workmail", + "workmailmessageflow", + "workspaces", + "workspaces-instances", + "workspaces-thin-client", + "workspaces-web", + "xray", +] +ResourceServiceName = Literal[ + "cloudformation", + "cloudwatch", + "dynamodb", + "ec2", + "glacier", + "iam", + "opsworks", + "s3", + "sns", + "sqs", +] +PaginatorName = Literal[ + "list_agent_instances", "list_artifacts", "list_hitl_tasks", "list_job_plan_steps" +] diff --git a/packages/types/src/agent_builder_types/paginator.py b/packages/types/src/agent_builder_types/paginator.py index bd21421..e022cff 100644 --- a/packages/types/src/agent_builder_types/paginator.py +++ b/packages/types/src/agent_builder_types/paginator.py @@ -1,16 +1,16 @@ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service client paginators. +Type annotations for transformagenticservice service client paginators. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/) Usage:: ```python - import boto3 + from boto3.session import Session - from agent_builder_types import TransformAgenticServiceClient + from agent_builder_types.client import TransformAgenticServiceClient from agent_builder_types.paginator import ( ListAgentInstancesPaginator, ListArtifactsPaginator, @@ -18,7 +18,8 @@ ListJobPlanStepsPaginator, ) - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") list_agent_instances_paginator: ListAgentInstancesPaginator = client.get_paginator("list_agent_instances") list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts") @@ -27,9 +28,9 @@ ``` """ -from typing import Iterator +from typing import Generic, Iterator, TypeVar -from botocore.paginate import Paginator as Boto3Paginator +from botocore.paginate import PageIterator, Paginator from .literals import HitlTaskTypeType from .type_defs import ( @@ -51,80 +52,89 @@ "ListJobPlanStepsPaginator", ) +_ItemTypeDef = TypeVar("_ItemTypeDef") -class ListAgentInstancesPaginator(Boto3Paginator): + +class _PageIterator(Generic[_ItemTypeDef], PageIterator): + def __iter__(self) -> Iterator[_ItemTypeDef]: + """ + Proxy method to specify iterator item type. + """ + + +class ListAgentInstancesPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListAgentInstances) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listagentinstancespaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - agentFilter: "ListAgentFilterTypeDef" = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListAgentInstancesResponseTypeDef]: + requestContext: RequestContextTypeDef, + agentFilter: ListAgentFilterTypeDef = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListAgentInstancesResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListAgentInstances.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listagentinstancespaginator) """ -class ListArtifactsPaginator(Boto3Paginator): +class ListArtifactsPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListArtifacts) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listartifactspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - artifactFilter: "ArtifactFilterTypeDef" = None, - pathPrefix: str = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListArtifactsResponseTypeDef]: + requestContext: RequestContextTypeDef, + artifactFilter: ArtifactFilterTypeDef = ..., + pathPrefix: str = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListArtifactsResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListArtifacts.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listartifactspaginator) """ -class ListHitlTasksPaginator(Boto3Paginator): +class ListHitlTasksPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListHitlTasks) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listhitltaskspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, taskType: HitlTaskTypeType, - taskFilter: "HitlTaskFilterTypeDef" = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListHitlTasksResponseTypeDef]: + taskFilter: HitlTaskFilterTypeDef = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListHitlTasksResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListHitlTasks.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listhitltaskspaginator) """ -class ListJobPlanStepsPaginator(Boto3Paginator): +class ListJobPlanStepsPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListJobPlanSteps) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listjobplanstepspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - parentStepId: str = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListJobPlanStepsResponseTypeDef]: + requestContext: RequestContextTypeDef, + parentStepId: str = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListJobPlanStepsResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListJobPlanSteps.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listjobplanstepspaginator) """ diff --git a/packages/types/src/agent_builder_types/paginator.pyi b/packages/types/src/agent_builder_types/paginator.pyi index 5300749..e32ebb3 100644 --- a/packages/types/src/agent_builder_types/paginator.pyi +++ b/packages/types/src/agent_builder_types/paginator.pyi @@ -1,14 +1,16 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service client paginators. +Type annotations for transformagenticservice service client paginators. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/) Usage:: ```python - import boto3 + from boto3.session import Session - from agent_builder_types import TransformAgenticServiceClient + from agent_builder_types.client import TransformAgenticServiceClient from agent_builder_types.paginator import ( ListAgentInstancesPaginator, ListArtifactsPaginator, @@ -16,7 +18,8 @@ Usage:: ListJobPlanStepsPaginator, ) - client: TransformAgenticServiceClient = boto3.client("elasticgumbyagenticservice") + session = Session() + client: TransformAgenticServiceClient = session.client("transformagenticservice") list_agent_instances_paginator: ListAgentInstancesPaginator = client.get_paginator("list_agent_instances") list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts") @@ -25,9 +28,9 @@ Usage:: ``` """ -from typing import Iterator +from typing import Generic, Iterator, TypeVar -from botocore.paginate import Paginator as Boto3Paginator +from botocore.paginate import PageIterator, Paginator from .literals import HitlTaskTypeType from .type_defs import ( @@ -49,76 +52,84 @@ __all__ = ( "ListJobPlanStepsPaginator", ) -class ListAgentInstancesPaginator(Boto3Paginator): +_ItemTypeDef = TypeVar("_ItemTypeDef") + +class _PageIterator(Generic[_ItemTypeDef], PageIterator): + def __iter__(self) -> Iterator[_ItemTypeDef]: + """ + Proxy method to specify iterator item type. + """ + +class ListAgentInstancesPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListAgentInstances) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listagentinstancespaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - agentFilter: "ListAgentFilterTypeDef" = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListAgentInstancesResponseTypeDef]: + requestContext: RequestContextTypeDef, + agentFilter: ListAgentFilterTypeDef = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListAgentInstancesResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListAgentInstances.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listagentinstancespaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListAgentInstances.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listagentinstancespaginator) """ -class ListArtifactsPaginator(Boto3Paginator): +class ListArtifactsPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListArtifacts) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listartifactspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - artifactFilter: "ArtifactFilterTypeDef" = None, - pathPrefix: str = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListArtifactsResponseTypeDef]: + requestContext: RequestContextTypeDef, + artifactFilter: ArtifactFilterTypeDef = ..., + pathPrefix: str = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListArtifactsResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListArtifacts.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listartifactspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListArtifacts.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listartifactspaginator) """ -class ListHitlTasksPaginator(Boto3Paginator): +class ListHitlTasksPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListHitlTasks) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listhitltaskspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", + requestContext: RequestContextTypeDef, taskType: HitlTaskTypeType, - taskFilter: "HitlTaskFilterTypeDef" = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListHitlTasksResponseTypeDef]: + taskFilter: HitlTaskFilterTypeDef = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListHitlTasksResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListHitlTasks.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listhitltaskspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListHitlTasks.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listhitltaskspaginator) """ -class ListJobPlanStepsPaginator(Boto3Paginator): +class ListJobPlanStepsPaginator(Paginator): """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListJobPlanSteps) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listjobplanstepspaginator) """ def paginate( self, *, - requestContext: "RequestContextTypeDef", - parentStepId: str = None, - PaginationConfig: PaginatorConfigTypeDef = None - ) -> Iterator[ListJobPlanStepsResponseTypeDef]: + requestContext: RequestContextTypeDef, + parentStepId: str = ..., + PaginationConfig: PaginatorConfigTypeDef = ..., + ) -> _PageIterator[ListJobPlanStepsResponseTypeDef]: """ - [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/1.42.95/reference/services/elasticgumbyagenticservice.html#Elasticgumbyagenticservice.Paginator.ListJobPlanSteps.paginate) - [Show boto3-stubs documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/paginators.html#listjobplanstepspaginator) + [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transformagenticservice.html#TransformAgenticService.Paginator.ListJobPlanSteps.paginate) + [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/paginators/#listjobplanstepspaginator) """ diff --git a/packages/types/src/agent_builder_types/type_defs.py b/packages/types/src/agent_builder_types/type_defs.py index 6c6c0a5..29fef37 100644 --- a/packages/types/src/agent_builder_types/type_defs.py +++ b/packages/types/src/agent_builder_types/type_defs.py @@ -1,22 +1,22 @@ # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. # SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service type definitions. +Type annotations for transformagenticservice service type definitions. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/type_defs.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/type_defs/) Usage:: ```python - from agent_builder_types.type_defs import AccountConnectionTypeDef + from agent_builder_types.type_defs import AwsAccountConnectionTypeDef - data: AccountConnectionTypeDef = {...} + data: AwsAccountConnectionTypeDef = ... ``` """ import sys from datetime import datetime -from typing import Any, Dict, List, Union +from typing import Any, Dict, List, Mapping, Sequence, Union from .literals import ( AccessControlType, @@ -38,6 +38,7 @@ HitlTaskTypeType, IngestionStatusType, JobStatusType, + MonitoringTypeType, OwnerTypeType, PlanStepStatusType, PutJobPlanStatusType, @@ -45,24 +46,35 @@ RetrievalResultLocationTypeType, RetrievalScopeType, SeverityType, + UmrAgreementStatusType, + UmrEligibilityOutcomeType, + UmrIncentiveTypeType, + UmrMigrationPhaseType, + UmrPartnerTypeType, + UmrResourceStatusType, + UmrResourceTypeType, + UmrRiskLevelType, + UmrStatusType, UpdateAgentInstanceStatusType, VersionStatusType, VisibilityType, ) -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): + from typing import NotRequired +else: + from typing_extensions import NotRequired +if sys.version_info >= (3, 12): from typing import TypedDict else: from typing_extensions import TypedDict - __all__ = ( - "AccountConnectionTypeDef", - "AcknowledgeDeletionRequestRequestTypeDef", + "AwsAccountConnectionTypeDef", "AgentConfigurationTypeDef", "AgentInputPayloadTypeDef", "AgentInstanceSummaryTypeDef", @@ -73,220 +85,220 @@ "AppendModeTypeDef", "ArtifactAgentFilterTypeDef", "ArtifactCategoryFilterTypeDef", - "ArtifactFilterTypeDef", "ArtifactPlanStepFilterTypeDef", - "ArtifactReferenceTypeDef", - "ArtifactTypeDef", - "ArtifactTypeTypeDef", "ArtifactWorkspaceFilterTypeDef", - "AwsAccountConnectionTypeDef", + "ArtifactTypeTypeDef", + "FileMetadataTypeDef", "AwsTemporaryCredentialsTypeDef", + "FixedSizeChunkingConfigurationTypeDef", + "SemanticChunkingConfigurationTypeDef", + "ResponseMetadataTypeDef", + "ConnectorSummaryDataTypeDef", + "ContentDigestTypeDef", + "HitlTaskArtifactTypeDef", + "TimestampTypeDef", + "EntityTypeDef", + "FilterAttributeTypeDef", + "IsS3ObjectPresentTypeDef", + "UmrAgreementTypeDef", + "UmrEligibilityTypeDef", + "UmrMigrationPlanTypeDef", + "HierarchicalChunkingLevelConfigurationTypeDef", + "HitlTaskFilterTypeDef", + "JobMetadataTypeDef", + "StatusDetailsTypeDef", + "JobPlanStepNodeTypeDef", + "JobPlanStepTypeDef", + "JobPlanTreeTypeDef", + "LimitDefinitionTypeDef", + "ListAgentFilterTypeDef", + "PaginatorConfigTypeDef", + "WorklogOutputTypeDef", + "MeteredAmountTypeDef", + "MeteringAttributeTypeDef", + "PlanStepMappingTypeDef", + "VectorSearchConfigurationTypeDef", + "RetrievalQueryTypeDef", + "RetrievalResultContentTypeDef", + "RetrievalResultS3LocationTypeDef", + "RetrievalResultWebLocationTypeDef", + "StatusInfoTypeDef", + "UmrResourceOutputTypeDef", + "AccountConnectionTypeDef", + "ListAgentsFilterTypeDef", + "PutJobPlanModeTypeDef", + "ArtifactFilterTypeDef", + "ArtifactReferenceTypeDef", + "ArtifactTypeDef", + "TemporaryCredentialsTypeDef", + "CloseHitlTaskResponseTypeDef", + "CopyArtifactResponseTypeDef", + "CreateArtifactUploadUrlResponseTypeDef", + "CreateHitlTaskResponseTypeDef", + "CreateSkillDownloadUrlResponseTypeDef", + "GetAgentInstanceResponseTypeDef", + "GetAgentVersionResponseTypeDef", + "GetTaskResponseTypeDef", + "InvokeAgentResponseTypeDef", + "ListAgentInstancesResponseTypeDef", + "ListAgentsResponseTypeDef", + "PutAgreementResponseTypeDef", + "PutEligibilityResponseTypeDef", + "PutMigrationPlanResponseTypeDef", + "PutPartnerDetailsResponseTypeDef", + "RefreshAuthTokenResponseTypeDef", + "SendMessageResponseTypeDef", + "StartHitlTaskResponseTypeDef", + "StartKnowledgeBaseIngestionResponseTypeDef", + "UpdateUMRStatusResponseTypeDef", + "ListConnectorsResponseTypeDef", + "HitlTaskTypeDef", + "PlanStepUpdateTypeDef", + "TimeFilterTypeDef", + "UmrResourceTypeDef", + "WorklogTypeDef", + "RetrievalFilterTypeDef", + "HierarchicalChunkingConfigurationTypeDef", + "IngestionScopeMetadataTypeDef", + "RequestContextTypeDef", + "JobInfoTypeDef", + "ListJobPlanStepsResponseTypeDef", + "MeteringUsageTypeDef", + "ListWorklogsResponseTypeDef", + "PutJobPlanResponseTypeDef", + "RetrievalConfigurationTypeDef", + "RetrievalResultLocationTypeDef", + "UmrPartnerDetailsTypeDef", + "GetConnectorResponseTypeDef", + "CompleteArtifactUploadResponseTypeDef", + "CreateArtifactDownloadUrlResponseTypeDef", + "GetArtifactMetadataResponseTypeDef", + "ListArtifactsResponseTypeDef", + "GetTemporaryCredentialsForConnectorResponseTypeDef", + "GetTemporaryCredentialsForRoleResponseTypeDef", + "GetHitlTaskResponseTypeDef", + "ListHitlTasksResponseTypeDef", + "StepIdFilterTypeDef", + "UmrResourceUnionTypeDef", + "WorklogUnionTypeDef", "ChunkingConfigurationTypeDef", + "IngestionTypeDef", + "AcknowledgeDeletionRequestRequestTypeDef", "CloseHitlTaskRequestRequestTypeDef", - "CloseHitlTaskResponseTypeDef", "CompleteArtifactUploadRequestRequestTypeDef", - "CompleteArtifactUploadResponseTypeDef", - "ConnectorSummaryDataTypeDef", - "ContentDigestTypeDef", "CopyArtifactRequestRequestTypeDef", - "CopyArtifactResponseTypeDef", "CreateArtifactDownloadUrlRequestRequestTypeDef", - "CreateArtifactDownloadUrlResponseTypeDef", "CreateArtifactUploadUrlRequestRequestTypeDef", - "CreateArtifactUploadUrlResponseTypeDef", "CreateHitlTaskRequestRequestTypeDef", - "CreateHitlTaskResponseTypeDef", "CreateSkillDownloadUrlRequestRequestTypeDef", - "CreateSkillDownloadUrlResponseTypeDef", "CreateWorklogRequestRequestTypeDef", "DeleteJobPlanStepRequestRequestTypeDef", "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", - "EntityTypeDef", - "FileMetadataTypeDef", - "FilterAttributeTypeDef", - "FixedSizeChunkingConfigurationTypeDef", "GetAgentInstanceRequestRequestTypeDef", - "GetAgentInstanceResponseTypeDef", "GetAgentVersionRequestRequestTypeDef", - "GetAgentVersionResponseTypeDef", "GetArtifactMetadataRequestRequestTypeDef", - "GetArtifactMetadataResponseTypeDef", "GetConnectorRequestRequestTypeDef", - "GetConnectorResponseTypeDef", "GetHitlTaskRequestRequestTypeDef", - "GetHitlTaskResponseTypeDef", "GetJobRequestRequestTypeDef", - "GetJobResponseTypeDef", "GetKnowledgeBaseIngestionRequestRequestTypeDef", - "GetKnowledgeBaseIngestionResponseTypeDef", "GetTaskRequestRequestTypeDef", - "GetTaskResponseTypeDef", "GetTemporaryCredentialsForConnectorRequestRequestTypeDef", - "GetTemporaryCredentialsForConnectorResponseTypeDef", "GetTemporaryCredentialsForRoleRequestRequestTypeDef", - "GetTemporaryCredentialsForRoleResponseTypeDef", + "GetUMRRequestRequestTypeDef", "GetUsageRequestRequestTypeDef", - "GetUsageResponseTypeDef", - "HierarchicalChunkingConfigurationTypeDef", - "HierarchicalChunkingLevelConfigurationTypeDef", - "HitlTaskArtifactTypeDef", - "HitlTaskFilterTypeDef", - "HitlTaskTypeDef", - "IngestionConfigurationTypeDef", - "IngestionScopeMetadataTypeDef", - "IngestionTypeDef", "InvokeAgentRequestRequestTypeDef", - "InvokeAgentResponseTypeDef", - "IsS3ObjectPresentTypeDef", - "JobInfoTypeDef", - "JobMetadataTypeDef", - "JobPlanStepNodeTypeDef", - "JobPlanStepTypeDef", - "JobPlanTreeTypeDef", - "LimitDefinitionTypeDef", - "ListAgentFilterTypeDef", + "ListAgentInstancesRequestListAgentInstancesPaginateTypeDef", "ListAgentInstancesRequestRequestTypeDef", - "ListAgentInstancesResponseTypeDef", - "ListAgentsFilterTypeDef", "ListAgentsRequestRequestTypeDef", - "ListAgentsResponseTypeDef", + "ListArtifactsRequestListArtifactsPaginateTypeDef", "ListArtifactsRequestRequestTypeDef", - "ListArtifactsResponseTypeDef", "ListConnectorsRequestRequestTypeDef", - "ListConnectorsResponseTypeDef", + "ListHitlTasksRequestListHitlTasksPaginateTypeDef", "ListHitlTasksRequestRequestTypeDef", - "ListHitlTasksResponseTypeDef", + "ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef", "ListJobPlanStepsRequestRequestTypeDef", - "ListJobPlanStepsResponseTypeDef", - "ListWorklogsRequestRequestTypeDef", - "ListWorklogsResponseTypeDef", - "MetadataContextTypeDef", - "MeteredAmountTypeDef", - "MeteringAttributeTypeDef", - "MeteringUsageTypeDef", - "PaginatorConfigTypeDef", - "PlanStepMappingTypeDef", - "PlanStepUpdateTypeDef", - "PreProdTestOperationRequestRequestTypeDef", "PublishMeteringEventRequestRequestTypeDef", - "PutJobPlanModeTypeDef", + "PutAgreementRequestRequestTypeDef", + "PutEligibilityRequestRequestTypeDef", "PutJobPlanRequestRequestTypeDef", - "PutJobPlanResponseTypeDef", + "PutMigrationPlanRequestRequestTypeDef", "RefreshAuthTokenRequestRequestTypeDef", - "RefreshAuthTokenResponseTypeDef", "RegisterKnowledgeBaseDocumentRequestRequestTypeDef", - "RequestContextTypeDef", - "ResponseMetadataTypeDef", - "RetrievalConfigurationTypeDef", - "RetrievalFilterTypeDef", - "RetrievalQueryTypeDef", - "RetrievalResultContentTypeDef", - "RetrievalResultLocationTypeDef", - "RetrievalResultS3LocationTypeDef", - "RetrievalResultTypeDef", - "RetrievalResultWebLocationTypeDef", - "RetrieveFromKnowledgeBaseRequestRequestTypeDef", - "RetrieveFromKnowledgeBaseResponseTypeDef", + "RestoreAgentRequestRequestTypeDef", "RollbackMeteringEventRequestRequestTypeDef", - "SemanticChunkingConfigurationTypeDef", "SendMessageRequestRequestTypeDef", - "SendMessageResponseTypeDef", "StartHitlTaskRequestRequestTypeDef", - "StartHitlTaskResponseTypeDef", - "StartJobRequestRequestTypeDef", - "StartJobResponseTypeDef", - "StartKnowledgeBaseIngestionRequestRequestTypeDef", - "StartKnowledgeBaseIngestionResponseTypeDef", - "StatusDetailsTypeDef", - "StatusInfoTypeDef", - "StepIdFilterTypeDef", "StopAgentRequestRequestTypeDef", - "TemporaryCredentialsTypeDef", - "TestOperationRequestRequestTypeDef", - "TimeFilterTypeDef", "UpdateAgentInstanceRequestRequestTypeDef", "UpdateJobPlanStepRequestRequestTypeDef", "UpdateJobStatusRequestRequestTypeDef", - "VectorIngestionConfigurationTypeDef", - "VectorSearchConfigurationTypeDef", + "UpdateUMRStatusRequestRequestTypeDef", + "GetJobResponseTypeDef", + "GetUsageResponseTypeDef", + "RetrieveFromKnowledgeBaseRequestRequestTypeDef", + "RetrievalResultTypeDef", + "GetUMRResponseTypeDef", "WorklogFilterTypeDef", - "WorklogTypeDef", -) - -AccountConnectionTypeDef = TypedDict( - "AccountConnectionTypeDef", - { - "awsAccountConnection": "AwsAccountConnectionTypeDef", - }, - total=False, + "PutPartnerDetailsRequestRequestTypeDef", + "VectorIngestionConfigurationTypeDef", + "GetKnowledgeBaseIngestionResponseTypeDef", + "RetrieveFromKnowledgeBaseResponseTypeDef", + "ListWorklogsRequestRequestTypeDef", + "IngestionConfigurationTypeDef", + "StartKnowledgeBaseIngestionRequestRequestTypeDef", ) -AcknowledgeDeletionRequestRequestTypeDef = TypedDict( - "AcknowledgeDeletionRequestRequestTypeDef", +AwsAccountConnectionTypeDef = TypedDict( + "AwsAccountConnectionTypeDef", { - "requestContext": "RequestContextTypeDef", - "deletionAcknowledgementToken": str, + "status": NotRequired[AccountConnectionStatusType], + "createdDate": NotRequired[datetime], + "expirationDate": NotRequired[datetime], + "accountId": NotRequired[str], + "roleArn": NotRequired[str], + "connectionToken": NotRequired[str], }, ) - AgentConfigurationTypeDef = TypedDict( "AgentConfigurationTypeDef", { "shortDescription": str, "agentCard": Dict[str, Any], + "monitoringType": NotRequired[MonitoringTypeType], }, ) - AgentInputPayloadTypeDef = TypedDict( "AgentInputPayloadTypeDef", { - "serializedPayload": str, + "serializedPayload": NotRequired[str], }, - total=False, ) - -_RequiredAgentInstanceSummaryTypeDef = TypedDict( - "_RequiredAgentInstanceSummaryTypeDef", +AgentInstanceSummaryTypeDef = TypedDict( + "AgentInstanceSummaryTypeDef", { "agentInstanceId": str, "agentType": AgentTypeType, "agentInstanceStatus": AgentInstanceStatusType, + "agentId": NotRequired[str], + "agentVersion": NotRequired[str], }, ) -_OptionalAgentInstanceSummaryTypeDef = TypedDict( - "_OptionalAgentInstanceSummaryTypeDef", - { - "agentId": str, - "agentVersion": str, - }, - total=False, -) - - -class AgentInstanceSummaryTypeDef( - _RequiredAgentInstanceSummaryTypeDef, _OptionalAgentInstanceSummaryTypeDef -): - pass - - AgentMetadataSummaryTypeDef = TypedDict( "AgentMetadataSummaryTypeDef", { - "name": str, - "type": AgentTypeType, - "description": str, - "accountAccess": AccessControlType, - "visibility": AgentVisibilityType, - "ownerType": OwnerTypeType, - "customerConfigurationRequired": bool, - "agentConfigurationAvailability": AgentConfigurationAvailabilityType, - "customerConfiguredAgentDependencies": List[str], + "name": NotRequired[str], + "type": NotRequired[AgentTypeType], + "description": NotRequired[str], + "accountAccess": NotRequired[AccessControlType], + "visibility": NotRequired[AgentVisibilityType], + "ownerType": NotRequired[OwnerTypeType], + "customerConfigurationRequired": NotRequired[bool], + "agentConfigurationAvailability": NotRequired[AgentConfigurationAvailabilityType], + "customerConfiguredAgentDependencies": NotRequired[List[str]], }, - total=False, ) - -_RequiredAgentMetadataTypeDef = TypedDict( - "_RequiredAgentMetadataTypeDef", +AgentMetadataTypeDef = TypedDict( + "AgentMetadataTypeDef", { "type": AgentTypeType, "description": str, @@ -295,602 +307,445 @@ class AgentInstanceSummaryTypeDef( "ownerContactInfo": str, "ownerType": OwnerTypeType, "customerConfigurationRequired": bool, + "customerConfiguredAgentDependencies": NotRequired[List[str]], }, ) -_OptionalAgentMetadataTypeDef = TypedDict( - "_OptionalAgentMetadataTypeDef", - { - "customerConfiguredAgentDependencies": List[str], - }, - total=False, -) - - -class AgentMetadataTypeDef(_RequiredAgentMetadataTypeDef, _OptionalAgentMetadataTypeDef): - pass - - AgentOutputPayloadTypeDef = TypedDict( "AgentOutputPayloadTypeDef", { - "serializedPayload": str, + "serializedPayload": NotRequired[str], }, - total=False, ) - AgentTypeFilterTypeDef = TypedDict( "AgentTypeFilterTypeDef", { - "agentType": AgentTypeType, + "agentType": NotRequired[AgentTypeType], }, - total=False, ) - -_RequiredAppendModeTypeDef = TypedDict( - "_RequiredAppendModeTypeDef", +AppendModeTypeDef = TypedDict( + "AppendModeTypeDef", { "parentStepId": str, + "afterStepId": NotRequired[str], }, ) -_OptionalAppendModeTypeDef = TypedDict( - "_OptionalAppendModeTypeDef", +ArtifactAgentFilterTypeDef = TypedDict( + "ArtifactAgentFilterTypeDef", { - "afterStepId": str, + "agentInstanceId": str, + "category": NotRequired[CategoryTypeType], }, - total=False, ) - - -class AppendModeTypeDef(_RequiredAppendModeTypeDef, _OptionalAppendModeTypeDef): - pass - - -_RequiredArtifactAgentFilterTypeDef = TypedDict( - "_RequiredArtifactAgentFilterTypeDef", +ArtifactCategoryFilterTypeDef = TypedDict( + "ArtifactCategoryFilterTypeDef", { - "agentInstanceId": str, + "category": CategoryTypeType, + "artifactLabel": NotRequired[str], }, ) -_OptionalArtifactAgentFilterTypeDef = TypedDict( - "_OptionalArtifactAgentFilterTypeDef", +ArtifactPlanStepFilterTypeDef = TypedDict( + "ArtifactPlanStepFilterTypeDef", { + "planStepId": str, "category": CategoryTypeType, }, - total=False, ) - - -class ArtifactAgentFilterTypeDef( - _RequiredArtifactAgentFilterTypeDef, _OptionalArtifactAgentFilterTypeDef -): - pass - - -_RequiredArtifactCategoryFilterTypeDef = TypedDict( - "_RequiredArtifactCategoryFilterTypeDef", +ArtifactWorkspaceFilterTypeDef = TypedDict( + "ArtifactWorkspaceFilterTypeDef", { "category": CategoryTypeType, + "artifactLabel": NotRequired[str], }, ) -_OptionalArtifactCategoryFilterTypeDef = TypedDict( - "_OptionalArtifactCategoryFilterTypeDef", +ArtifactTypeTypeDef = TypedDict( + "ArtifactTypeTypeDef", { - "artifactLabel": str, + "categoryType": CategoryTypeType, + "fileType": FileTypeType, + "schemaType": NotRequired[str], }, - total=False, ) - - -class ArtifactCategoryFilterTypeDef( - _RequiredArtifactCategoryFilterTypeDef, _OptionalArtifactCategoryFilterTypeDef -): - pass - - -ArtifactFilterTypeDef = TypedDict( - "ArtifactFilterTypeDef", +FileMetadataTypeDef = TypedDict( + "FileMetadataTypeDef", { - "agentFilter": "ArtifactAgentFilterTypeDef", - "categoryFilter": "ArtifactCategoryFilterTypeDef", - "workspaceFilter": "ArtifactWorkspaceFilterTypeDef", - "planStepFilter": "ArtifactPlanStepFilterTypeDef", + "path": str, + "description": NotRequired[str], }, - total=False, ) - -ArtifactPlanStepFilterTypeDef = TypedDict( - "ArtifactPlanStepFilterTypeDef", +AwsTemporaryCredentialsTypeDef = TypedDict( + "AwsTemporaryCredentialsTypeDef", { - "planStepId": str, - "category": CategoryTypeType, + "accessKey": NotRequired[str], + "secretKey": NotRequired[str], + "accessToken": NotRequired[str], + "expirationTime": NotRequired[datetime], }, ) - -ArtifactReferenceTypeDef = TypedDict( - "ArtifactReferenceTypeDef", +FixedSizeChunkingConfigurationTypeDef = TypedDict( + "FixedSizeChunkingConfigurationTypeDef", { - "artifactType": "ArtifactTypeTypeDef", - "artifactId": str, + "maxTokens": int, + "overlapPercentage": int, }, - total=False, ) - -_RequiredArtifactTypeDef = TypedDict( - "_RequiredArtifactTypeDef", +SemanticChunkingConfigurationTypeDef = TypedDict( + "SemanticChunkingConfigurationTypeDef", { - "artifactId": str, - "artifactType": "ArtifactTypeTypeDef", - "artifactCreatedTimestamp": datetime, - "artifactExpiryTimestamp": datetime, + "breakpointPercentileThreshold": int, + "bufferSize": int, + "maxTokens": int, }, ) -_OptionalArtifactTypeDef = TypedDict( - "_OptionalArtifactTypeDef", +ResponseMetadataTypeDef = TypedDict( + "ResponseMetadataTypeDef", { - "artifactLabel": str, - "fileMetadata": "FileMetadataTypeDef", - "sizeInBytes": int, - "storedInAtxBucket": bool, + "RequestId": str, + "HTTPStatusCode": int, + "HTTPHeaders": Dict[str, str], + "RetryAttempts": int, + "HostId": NotRequired[str], }, - total=False, ) - - -class ArtifactTypeDef(_RequiredArtifactTypeDef, _OptionalArtifactTypeDef): - pass - - -_RequiredArtifactTypeTypeDef = TypedDict( - "_RequiredArtifactTypeTypeDef", +ConnectorSummaryDataTypeDef = TypedDict( + "ConnectorSummaryDataTypeDef", { - "categoryType": CategoryTypeType, - "fileType": FileTypeType, + "connectorId": str, + "connectorName": NotRequired[str], + "description": NotRequired[str], + "connectorType": NotRequired[str], + "targetRegions": NotRequired[List[str]], }, ) -_OptionalArtifactTypeTypeDef = TypedDict( - "_OptionalArtifactTypeTypeDef", +ContentDigestTypeDef = TypedDict( + "ContentDigestTypeDef", { - "schemaType": str, + "sha256": NotRequired[str], }, - total=False, ) - - -class ArtifactTypeTypeDef(_RequiredArtifactTypeTypeDef, _OptionalArtifactTypeTypeDef): - pass - - -_RequiredArtifactWorkspaceFilterTypeDef = TypedDict( - "_RequiredArtifactWorkspaceFilterTypeDef", +HitlTaskArtifactTypeDef = TypedDict( + "HitlTaskArtifactTypeDef", { - "category": CategoryTypeType, + "artifactId": NotRequired[str], }, ) -_OptionalArtifactWorkspaceFilterTypeDef = TypedDict( - "_OptionalArtifactWorkspaceFilterTypeDef", +TimestampTypeDef = Union[datetime, str] +EntityTypeDef = TypedDict( + "EntityTypeDef", { - "artifactLabel": str, + "accountIdEntity": NotRequired[Mapping[str, Any]], }, - total=False, ) - - -class ArtifactWorkspaceFilterTypeDef( - _RequiredArtifactWorkspaceFilterTypeDef, _OptionalArtifactWorkspaceFilterTypeDef -): - pass - - -AwsAccountConnectionTypeDef = TypedDict( - "AwsAccountConnectionTypeDef", +FilterAttributeTypeDef = TypedDict( + "FilterAttributeTypeDef", { - "status": AccountConnectionStatusType, - "createdDate": datetime, - "expirationDate": datetime, - "accountId": str, - "roleArn": str, - "connectionToken": str, + "key": str, + "value": Mapping[str, Any], }, - total=False, ) - -AwsTemporaryCredentialsTypeDef = TypedDict( - "AwsTemporaryCredentialsTypeDef", +IsS3ObjectPresentTypeDef = TypedDict( + "IsS3ObjectPresentTypeDef", { - "accessKey": str, - "secretKey": str, - "accessToken": str, - "expirationTime": datetime, + "publicBucket": NotRequired[bool], + "privateBucket": NotRequired[bool], }, - total=False, ) - -_RequiredChunkingConfigurationTypeDef = TypedDict( - "_RequiredChunkingConfigurationTypeDef", +UmrAgreementTypeDef = TypedDict( + "UmrAgreementTypeDef", { - "chunkingStrategy": ChunkingStrategyType, + "agreementId": str, + "agreementStatus": UmrAgreementStatusType, + "agreementType": NotRequired[UmrIncentiveTypeType], + "executedTimestamp": NotRequired[datetime], + "amendmentVersion": NotRequired[int], + "agreementUrl": NotRequired[str], + "signedBy": NotRequired[str], + "awsSignatory": NotRequired[str], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, ) -_OptionalChunkingConfigurationTypeDef = TypedDict( - "_OptionalChunkingConfigurationTypeDef", +UmrEligibilityTypeDef = TypedDict( + "UmrEligibilityTypeDef", { - "fixedSizeChunkingConfiguration": "FixedSizeChunkingConfigurationTypeDef", - "hierarchicalChunkingConfiguration": "HierarchicalChunkingConfigurationTypeDef", - "semanticChunkingConfiguration": "SemanticChunkingConfigurationTypeDef", + "outcome": UmrEligibilityOutcomeType, + "assessmentDate": datetime, + "assessmentScore": NotRequired[int], + "riskLevel": NotRequired[UmrRiskLevelType], + "qualificationCriteria": NotRequired[Dict[str, bool]], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, - total=False, ) - - -class ChunkingConfigurationTypeDef( - _RequiredChunkingConfigurationTypeDef, _OptionalChunkingConfigurationTypeDef -): - pass - - -_RequiredCloseHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredCloseHitlTaskRequestRequestTypeDef", +UmrMigrationPlanTypeDef = TypedDict( + "UmrMigrationPlanTypeDef", { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, + "incentiveType": UmrIncentiveTypeType, + "startDate": datetime, + "endDate": datetime, + "creditCap": float, + "creditPercentage": NotRequired[float], + "linkedAccountDisbursement": NotRequired[bool], + "baselineSpend": NotRequired[Dict[str, float]], + "programFlags": NotRequired[Dict[str, bool]], + "partnerSpmsId": NotRequired[str], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, ) -_OptionalCloseHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalCloseHitlTaskRequestRequestTypeDef", +HierarchicalChunkingLevelConfigurationTypeDef = TypedDict( + "HierarchicalChunkingLevelConfigurationTypeDef", { - "closureType": ClosureTypeType, - "idempotencyToken": str, + "maxTokens": int, }, - total=False, ) - - -class CloseHitlTaskRequestRequestTypeDef( - _RequiredCloseHitlTaskRequestRequestTypeDef, _OptionalCloseHitlTaskRequestRequestTypeDef -): - pass - - -CloseHitlTaskResponseTypeDef = TypedDict( - "CloseHitlTaskResponseTypeDef", +HitlTaskFilterTypeDef = TypedDict( + "HitlTaskFilterTypeDef", { - "hitlTaskStatus": HitlTaskStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "taskStatus": NotRequired[HitlTaskStatusType], + "agentInstanceId": NotRequired[str], + "stepId": NotRequired[str], + "tag": NotRequired[str], + "blockingType": NotRequired[BlockingTypeType], + "categories": NotRequired[Sequence[CategoryType]], }, ) - -CompleteArtifactUploadRequestRequestTypeDef = TypedDict( - "CompleteArtifactUploadRequestRequestTypeDef", +JobMetadataTypeDef = TypedDict( + "JobMetadataTypeDef", { - "requestContext": "RequestContextTypeDef", - "artifactId": str, + "jobId": str, + "workspaceId": str, }, ) - -CompleteArtifactUploadResponseTypeDef = TypedDict( - "CompleteArtifactUploadResponseTypeDef", +StatusDetailsTypeDef = TypedDict( + "StatusDetailsTypeDef", { - "artifact": "ArtifactTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "status": JobStatusType, + "failureReason": NotRequired[str], }, ) - -_RequiredConnectorSummaryDataTypeDef = TypedDict( - "_RequiredConnectorSummaryDataTypeDef", +JobPlanStepNodeTypeDef = TypedDict( + "JobPlanStepNodeTypeDef", { - "connectorId": str, + "stepLabel": str, + "stepName": str, + "description": str, + "subSteps": NotRequired[Sequence[Dict[str, Any]]], }, ) -_OptionalConnectorSummaryDataTypeDef = TypedDict( - "_OptionalConnectorSummaryDataTypeDef", +JobPlanStepTypeDef = TypedDict( + "JobPlanStepTypeDef", { - "connectorName": str, + "stepId": str, + "parentStepId": str, + "stepLabel": str, + "stepName": str, "description": str, - "connectorType": str, - "targetRegions": List[str], + "score": NotRequired[float], + "startTime": NotRequired[datetime], + "endTime": NotRequired[datetime], + "status": NotRequired[PlanStepStatusType], }, - total=False, ) - - -class ConnectorSummaryDataTypeDef( - _RequiredConnectorSummaryDataTypeDef, _OptionalConnectorSummaryDataTypeDef -): - pass - - -ContentDigestTypeDef = TypedDict( - "ContentDigestTypeDef", +JobPlanTreeTypeDef = TypedDict( + "JobPlanTreeTypeDef", { - "sha256": str, + "nodes": NotRequired[Sequence["JobPlanStepNodeTypeDef"]], }, - total=False, ) - -_RequiredCopyArtifactRequestRequestTypeDef = TypedDict( - "_RequiredCopyArtifactRequestRequestTypeDef", +LimitDefinitionTypeDef = TypedDict( + "LimitDefinitionTypeDef", { - "requestContext": "RequestContextTypeDef", - "artifactId": str, + "limit": float, + "unit": Literal["COUNT"], }, ) -_OptionalCopyArtifactRequestRequestTypeDef = TypedDict( - "_OptionalCopyArtifactRequestRequestTypeDef", +ListAgentFilterTypeDef = TypedDict( + "ListAgentFilterTypeDef", { - "idempotencyToken": str, + "requesterAgentInstanceId": NotRequired[str], }, - total=False, ) - - -class CopyArtifactRequestRequestTypeDef( - _RequiredCopyArtifactRequestRequestTypeDef, _OptionalCopyArtifactRequestRequestTypeDef -): - pass - - -CopyArtifactResponseTypeDef = TypedDict( - "CopyArtifactResponseTypeDef", +PaginatorConfigTypeDef = TypedDict( + "PaginatorConfigTypeDef", { - "copyStatus": CopyStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "MaxItems": NotRequired[int], + "PageSize": NotRequired[int], + "StartingToken": NotRequired[str], }, ) - -_RequiredCreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateArtifactDownloadUrlRequestRequestTypeDef", +WorklogOutputTypeDef = TypedDict( + "WorklogOutputTypeDef", { - "requestContext": "RequestContextTypeDef", - "artifactId": str, + "timestamp": datetime, + "attributeMap": Dict[str, str], + "description": NotRequired[str], }, ) -_OptionalCreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateArtifactDownloadUrlRequestRequestTypeDef", +MeteredAmountTypeDef = TypedDict( + "MeteredAmountTypeDef", { - "visibility": VisibilityType, + "amount": NotRequired[int], + "unit": NotRequired[Literal["COUNT"]], }, - total=False, ) - - -class CreateArtifactDownloadUrlRequestRequestTypeDef( - _RequiredCreateArtifactDownloadUrlRequestRequestTypeDef, - _OptionalCreateArtifactDownloadUrlRequestRequestTypeDef, -): - pass - - -CreateArtifactDownloadUrlResponseTypeDef = TypedDict( - "CreateArtifactDownloadUrlResponseTypeDef", +MeteringAttributeTypeDef = TypedDict( + "MeteringAttributeTypeDef", { - "s3preSignedUrl": str, - "s3UrlExpiryTimestamp": datetime, - "artifactType": "ArtifactTypeTypeDef", - "artifactLabel": str, - "requestHeaders": Dict[str, List[str]], - "artifact": "ArtifactTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "name": str, + "value": str, }, ) - -_RequiredCreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateArtifactUploadUrlRequestRequestTypeDef", +PlanStepMappingTypeDef = TypedDict( + "PlanStepMappingTypeDef", { - "requestContext": "RequestContextTypeDef", - "contentDigest": "ContentDigestTypeDef", - "artifactReference": "ArtifactReferenceTypeDef", + "stepLabel": str, + "stepId": str, }, ) -_OptionalCreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateArtifactUploadUrlRequestRequestTypeDef", +VectorSearchConfigurationTypeDef = TypedDict( + "VectorSearchConfigurationTypeDef", { - "label": str, - "planStepId": str, - "visibility": VisibilityType, - "metadata": "MetadataContextTypeDef", - "fileMetadata": "FileMetadataTypeDef", + "numberOfResults": NotRequired[int], + "filter": NotRequired["RetrievalFilterTypeDef"], }, - total=False, ) - - -class CreateArtifactUploadUrlRequestRequestTypeDef( - _RequiredCreateArtifactUploadUrlRequestRequestTypeDef, - _OptionalCreateArtifactUploadUrlRequestRequestTypeDef, -): - pass - - -CreateArtifactUploadUrlResponseTypeDef = TypedDict( - "CreateArtifactUploadUrlResponseTypeDef", +RetrievalQueryTypeDef = TypedDict( + "RetrievalQueryTypeDef", { - "artifactId": str, - "s3preSignedUrl": str, - "s3UrlExpiryTimestamp": datetime, - "requestHeaders": Dict[str, List[str]], - "ResponseMetadata": "ResponseMetadataTypeDef", + "text": str, }, ) - -_RequiredCreateHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredCreateHitlTaskRequestRequestTypeDef", +RetrievalResultContentTypeDef = TypedDict( + "RetrievalResultContentTypeDef", { - "requestContext": "RequestContextTypeDef", - "uxComponentId": str, - "description": str, - "title": str, + "text": NotRequired[str], }, ) -_OptionalCreateHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalCreateHitlTaskRequestRequestTypeDef", +RetrievalResultS3LocationTypeDef = TypedDict( + "RetrievalResultS3LocationTypeDef", { - "severity": SeverityType, - "hitlTaskType": HitlTaskTypeType, - "stepId": str, - "blockingType": BlockingTypeType, - "hitlRequestArtifact": "HitlTaskArtifactTypeDef", - "expiredAt": Union[datetime, str], - "tag": str, - "idempotencyToken": str, - "category": CategoryType, + "uri": NotRequired[str], }, - total=False, ) - - -class CreateHitlTaskRequestRequestTypeDef( - _RequiredCreateHitlTaskRequestRequestTypeDef, _OptionalCreateHitlTaskRequestRequestTypeDef -): - pass - - -CreateHitlTaskResponseTypeDef = TypedDict( - "CreateHitlTaskResponseTypeDef", +RetrievalResultWebLocationTypeDef = TypedDict( + "RetrievalResultWebLocationTypeDef", { - "hitlTaskId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "url": NotRequired[str], }, ) - -_RequiredCreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateSkillDownloadUrlRequestRequestTypeDef", +StatusInfoTypeDef = TypedDict( + "StatusInfoTypeDef", { - "requestContext": "RequestContextTypeDef", - "skillName": str, + "status": JobStatusType, + "failureCategory": NotRequired[FailureCategoryType], + "failureType": NotRequired[str], }, ) -_OptionalCreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateSkillDownloadUrlRequestRequestTypeDef", +UmrResourceOutputTypeDef = TypedDict( + "UmrResourceOutputTypeDef", { - "idempotencyToken": str, - "version": str, + "resourceType": UmrResourceTypeType, + "resourceId": str, + "status": UmrResourceStatusType, + "metadata": NotRequired[Dict[str, str]], + "createdAt": NotRequired[datetime], }, - total=False, ) - - -class CreateSkillDownloadUrlRequestRequestTypeDef( - _RequiredCreateSkillDownloadUrlRequestRequestTypeDef, - _OptionalCreateSkillDownloadUrlRequestRequestTypeDef, -): - pass - - -CreateSkillDownloadUrlResponseTypeDef = TypedDict( - "CreateSkillDownloadUrlResponseTypeDef", +AccountConnectionTypeDef = TypedDict( + "AccountConnectionTypeDef", { - "s3PreSignedUrl": str, - "s3UrlExpiryTimestamp": int, - "requestHeaders": Dict[str, List[str]], - "version": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "awsAccountConnection": NotRequired[AwsAccountConnectionTypeDef], }, ) - -_RequiredCreateWorklogRequestRequestTypeDef = TypedDict( - "_RequiredCreateWorklogRequestRequestTypeDef", +ListAgentsFilterTypeDef = TypedDict( + "ListAgentsFilterTypeDef", { - "requestContext": "RequestContextTypeDef", - "worklog": "WorklogTypeDef", + "agentTypeFilter": NotRequired[AgentTypeFilterTypeDef], }, ) -_OptionalCreateWorklogRequestRequestTypeDef = TypedDict( - "_OptionalCreateWorklogRequestRequestTypeDef", +PutJobPlanModeTypeDef = TypedDict( + "PutJobPlanModeTypeDef", { - "idempotencyToken": str, + "override": NotRequired[Mapping[str, Any]], + "append": NotRequired[AppendModeTypeDef], }, - total=False, ) - - -class CreateWorklogRequestRequestTypeDef( - _RequiredCreateWorklogRequestRequestTypeDef, _OptionalCreateWorklogRequestRequestTypeDef -): - pass - - -_RequiredDeleteJobPlanStepRequestRequestTypeDef = TypedDict( - "_RequiredDeleteJobPlanStepRequestRequestTypeDef", +ArtifactFilterTypeDef = TypedDict( + "ArtifactFilterTypeDef", { - "requestContext": "RequestContextTypeDef", - "stepId": str, + "agentFilter": NotRequired[ArtifactAgentFilterTypeDef], + "categoryFilter": NotRequired[ArtifactCategoryFilterTypeDef], + "workspaceFilter": NotRequired[ArtifactWorkspaceFilterTypeDef], + "planStepFilter": NotRequired[ArtifactPlanStepFilterTypeDef], }, ) -_OptionalDeleteJobPlanStepRequestRequestTypeDef = TypedDict( - "_OptionalDeleteJobPlanStepRequestRequestTypeDef", +ArtifactReferenceTypeDef = TypedDict( + "ArtifactReferenceTypeDef", { - "idempotencyToken": str, + "artifactType": NotRequired[ArtifactTypeTypeDef], + "artifactId": NotRequired[str], }, - total=False, ) - - -class DeleteJobPlanStepRequestRequestTypeDef( - _RequiredDeleteJobPlanStepRequestRequestTypeDef, _OptionalDeleteJobPlanStepRequestRequestTypeDef -): - pass - - -DeregisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", +ArtifactTypeDef = TypedDict( + "ArtifactTypeDef", { - "requestContext": "RequestContextTypeDef", "artifactId": str, - "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "artifactType": ArtifactTypeTypeDef, + "artifactCreatedTimestamp": datetime, + "artifactExpiryTimestamp": datetime, + "artifactLabel": NotRequired[str], + "fileMetadata": NotRequired[FileMetadataTypeDef], + "sizeInBytes": NotRequired[int], + "storedInAtxBucket": NotRequired[bool], }, ) - -EntityTypeDef = TypedDict( - "EntityTypeDef", +TemporaryCredentialsTypeDef = TypedDict( + "TemporaryCredentialsTypeDef", { - "accountIdEntity": Dict[str, Any], + "awsTemporaryCredentials": NotRequired[AwsTemporaryCredentialsTypeDef], }, - total=False, ) - -_RequiredFileMetadataTypeDef = TypedDict( - "_RequiredFileMetadataTypeDef", +CloseHitlTaskResponseTypeDef = TypedDict( + "CloseHitlTaskResponseTypeDef", { - "path": str, + "hitlTaskStatus": HitlTaskStatusType, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalFileMetadataTypeDef = TypedDict( - "_OptionalFileMetadataTypeDef", +CopyArtifactResponseTypeDef = TypedDict( + "CopyArtifactResponseTypeDef", { - "description": str, + "copyStatus": CopyStatusType, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class FileMetadataTypeDef(_RequiredFileMetadataTypeDef, _OptionalFileMetadataTypeDef): - pass - - -FilterAttributeTypeDef = TypedDict( - "FilterAttributeTypeDef", +CreateArtifactUploadUrlResponseTypeDef = TypedDict( + "CreateArtifactUploadUrlResponseTypeDef", { - "key": str, - "value": Dict[str, Any], + "artifactId": str, + "s3preSignedUrl": str, + "s3UrlExpiryTimestamp": datetime, + "requestHeaders": Dict[str, List[str]], + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -FixedSizeChunkingConfigurationTypeDef = TypedDict( - "FixedSizeChunkingConfigurationTypeDef", +CreateHitlTaskResponseTypeDef = TypedDict( + "CreateHitlTaskResponseTypeDef", { - "maxTokens": int, - "overlapPercentage": int, + "hitlTaskId": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -GetAgentInstanceRequestRequestTypeDef = TypedDict( - "GetAgentInstanceRequestRequestTypeDef", +CreateSkillDownloadUrlResponseTypeDef = TypedDict( + "CreateSkillDownloadUrlResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, + "s3PreSignedUrl": str, + "s3UrlExpiryTimestamp": int, + "requestHeaders": Dict[str, List[str]], + "version": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - GetAgentInstanceResponseTypeDef = TypedDict( "GetAgentInstanceResponseTypeDef", { @@ -899,1435 +754,971 @@ class FileMetadataTypeDef(_RequiredFileMetadataTypeDef, _OptionalFileMetadataTyp "agentId": str, "agentVersion": str, "agentInstanceStatus": AgentInstanceStatusType, - "agentInput": "AgentInputPayloadTypeDef", - "agentOutput": "AgentOutputPayloadTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredGetAgentVersionRequestRequestTypeDef = TypedDict( - "_RequiredGetAgentVersionRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "name": str, - }, -) -_OptionalGetAgentVersionRequestRequestTypeDef = TypedDict( - "_OptionalGetAgentVersionRequestRequestTypeDef", - { - "version": str, + "agentInput": AgentInputPayloadTypeDef, + "agentOutput": AgentOutputPayloadTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class GetAgentVersionRequestRequestTypeDef( - _RequiredGetAgentVersionRequestRequestTypeDef, _OptionalGetAgentVersionRequestRequestTypeDef -): - pass - - GetAgentVersionResponseTypeDef = TypedDict( "GetAgentVersionResponseTypeDef", { "version": str, - "metadata": "AgentMetadataTypeDef", + "metadata": AgentMetadataTypeDef, "visibility": AgentVisibilityType, - "configuration": "AgentConfigurationTypeDef", + "configuration": AgentConfigurationTypeDef, "status": VersionStatusType, "statusMessage": str, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetArtifactMetadataRequestRequestTypeDef = TypedDict( - "GetArtifactMetadataRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "artifactId": str, - }, -) - -GetArtifactMetadataResponseTypeDef = TypedDict( - "GetArtifactMetadataResponseTypeDef", - { - "artifact": "ArtifactTypeDef", - "isS3ObjectPresent": "IsS3ObjectPresentTypeDef", - "metadata": "MetadataContextTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetConnectorRequestRequestTypeDef = TypedDict( - "GetConnectorRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "connectorId": str, - }, -) - -GetConnectorResponseTypeDef = TypedDict( - "GetConnectorResponseTypeDef", - { - "connectorName": str, - "description": str, - "connectorType": str, - "configuration": Dict[str, str], - "accountConnection": "AccountConnectionTypeDef", - "targetRegions": List[str], - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetHitlTaskRequestRequestTypeDef = TypedDict( - "GetHitlTaskRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, - }, -) - -GetHitlTaskResponseTypeDef = TypedDict( - "GetHitlTaskResponseTypeDef", - { - "hitlTask": "HitlTaskTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredGetJobRequestRequestTypeDef = TypedDict( - "_RequiredGetJobRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - }, -) -_OptionalGetJobRequestRequestTypeDef = TypedDict( - "_OptionalGetJobRequestRequestTypeDef", - { - "includeObjective": bool, - }, - total=False, -) - - -class GetJobRequestRequestTypeDef( - _RequiredGetJobRequestRequestTypeDef, _OptionalGetJobRequestRequestTypeDef -): - pass - - -GetJobResponseTypeDef = TypedDict( - "GetJobResponseTypeDef", - { - "job": "JobInfoTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "GetKnowledgeBaseIngestionRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "ingestionId": str, - }, -) - -GetKnowledgeBaseIngestionResponseTypeDef = TypedDict( - "GetKnowledgeBaseIngestionResponseTypeDef", - { - "ingestion": "IngestionTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredGetTaskRequestRequestTypeDef = TypedDict( - "_RequiredGetTaskRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, - }, -) -_OptionalGetTaskRequestRequestTypeDef = TypedDict( - "_OptionalGetTaskRequestRequestTypeDef", - { - "params": Dict[str, Any], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class GetTaskRequestRequestTypeDef( - _RequiredGetTaskRequestRequestTypeDef, _OptionalGetTaskRequestRequestTypeDef -): - pass - - GetTaskResponseTypeDef = TypedDict( "GetTaskResponseTypeDef", { "result": Dict[str, Any], "error": Dict[str, Any], - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( - "_RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "connectorId": str, - }, -) -_OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( - "_OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef", - { - "targetRegion": str, - }, - total=False, -) - - -class GetTemporaryCredentialsForConnectorRequestRequestTypeDef( - _RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef, - _OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef, -): - pass - - -GetTemporaryCredentialsForConnectorResponseTypeDef = TypedDict( - "GetTemporaryCredentialsForConnectorResponseTypeDef", - { - "temporaryCredentials": "TemporaryCredentialsTypeDef", - "connectorConfiguration": Dict[str, str], - "targetRegion": str, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetTemporaryCredentialsForRoleRequestRequestTypeDef = TypedDict( - "GetTemporaryCredentialsForRoleRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, - }, -) - -GetTemporaryCredentialsForRoleResponseTypeDef = TypedDict( - "GetTemporaryCredentialsForRoleResponseTypeDef", - { - "temporaryCredentials": "TemporaryCredentialsTypeDef", - "roleArn": str, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -GetUsageRequestRequestTypeDef = TypedDict( - "GetUsageRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "resourceTypes": List[ResourceTypeType], - }, -) - -GetUsageResponseTypeDef = TypedDict( - "GetUsageResponseTypeDef", - { - "usageResults": List["MeteringUsageTypeDef"], - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -HierarchicalChunkingConfigurationTypeDef = TypedDict( - "HierarchicalChunkingConfigurationTypeDef", - { - "levelConfigurations": List["HierarchicalChunkingLevelConfigurationTypeDef"], - "overlapTokens": int, - }, -) - -HierarchicalChunkingLevelConfigurationTypeDef = TypedDict( - "HierarchicalChunkingLevelConfigurationTypeDef", - { - "maxTokens": int, - }, -) - -HitlTaskArtifactTypeDef = TypedDict( - "HitlTaskArtifactTypeDef", - { - "artifactId": str, - }, - total=False, -) - -HitlTaskFilterTypeDef = TypedDict( - "HitlTaskFilterTypeDef", - { - "taskStatus": HitlTaskStatusType, - "agentInstanceId": str, - "stepId": str, - "tag": str, - "blockingType": BlockingTypeType, - "categories": List[CategoryType], - }, - total=False, -) - -_RequiredHitlTaskTypeDef = TypedDict( - "_RequiredHitlTaskTypeDef", - { - "hitlTaskId": str, - "hitlTaskStatus": HitlTaskStatusType, - "uxComponentId": str, - "blockingType": BlockingTypeType, - "severity": SeverityType, - "hitlTaskType": HitlTaskTypeType, - }, -) -_OptionalHitlTaskTypeDef = TypedDict( - "_OptionalHitlTaskTypeDef", - { - "createdAt": datetime, - "updatedAt": datetime, - "completedAt": datetime, - "tag": str, - "stepId": str, - "agentArtifact": "HitlTaskArtifactTypeDef", - "humanArtifact": "HitlTaskArtifactTypeDef", - "description": str, - "action": ActionType, - "category": CategoryType, - }, - total=False, -) - - -class HitlTaskTypeDef(_RequiredHitlTaskTypeDef, _OptionalHitlTaskTypeDef): - pass - - -IngestionConfigurationTypeDef = TypedDict( - "IngestionConfigurationTypeDef", - { - "vectorIngestionConfiguration": "VectorIngestionConfigurationTypeDef", - }, - total=False, -) - -IngestionScopeMetadataTypeDef = TypedDict( - "IngestionScopeMetadataTypeDef", - { - "jobScope": "JobMetadataTypeDef", - }, - total=False, -) - -_RequiredIngestionTypeDef = TypedDict( - "_RequiredIngestionTypeDef", - { - "ingestionId": str, - "status": IngestionStatusType, - "ingestionScopeMetadata": "IngestionScopeMetadataTypeDef", - }, -) -_OptionalIngestionTypeDef = TypedDict( - "_OptionalIngestionTypeDef", - { - "createdAt": datetime, - "updatedAt": datetime, - "failureReason": str, - }, - total=False, -) - - -class IngestionTypeDef(_RequiredIngestionTypeDef, _OptionalIngestionTypeDef): - pass - - -_RequiredInvokeAgentRequestRequestTypeDef = TypedDict( - "_RequiredInvokeAgentRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "agentId": str, - }, -) -_OptionalInvokeAgentRequestRequestTypeDef = TypedDict( - "_OptionalInvokeAgentRequestRequestTypeDef", - { - "inputPayload": "AgentInputPayloadTypeDef", - "idempotencyToken": str, - "agentVersion": str, - "agentInstanceId": str, - "agentType": AgentTypeType, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class InvokeAgentRequestRequestTypeDef( - _RequiredInvokeAgentRequestRequestTypeDef, _OptionalInvokeAgentRequestRequestTypeDef -): - pass - - InvokeAgentResponseTypeDef = TypedDict( "InvokeAgentResponseTypeDef", { "agentInstanceId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -IsS3ObjectPresentTypeDef = TypedDict( - "IsS3ObjectPresentTypeDef", +ListAgentInstancesResponseTypeDef = TypedDict( + "ListAgentInstancesResponseTypeDef", { - "publicBucket": bool, - "privateBucket": bool, + "agentInstanceSummaries": List[AgentInstanceSummaryTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -JobInfoTypeDef = TypedDict( - "JobInfoTypeDef", +ListAgentsResponseTypeDef = TypedDict( + "ListAgentsResponseTypeDef", { - "jobId": str, - "workspaceId": str, - "statusDetails": "StatusDetailsTypeDef", - "creationTime": datetime, - "startExecutionTime": datetime, - "endExecutionTime": datetime, - "objective": str, - "jobName": str, - "intent": str, - "runCountId": int, - "latestPlanVersion": int, - "clientSource": str, - "clientAppId": str, - "softDeleted": bool, - }, - total=False, + "items": List[AgentMetadataSummaryTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, + }, ) - -JobMetadataTypeDef = TypedDict( - "JobMetadataTypeDef", +PutAgreementResponseTypeDef = TypedDict( + "PutAgreementResponseTypeDef", { - "jobId": str, - "workspaceId": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -_RequiredJobPlanStepNodeTypeDef = TypedDict( - "_RequiredJobPlanStepNodeTypeDef", +PutEligibilityResponseTypeDef = TypedDict( + "PutEligibilityResponseTypeDef", { - "stepLabel": str, - "stepName": str, - "description": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalJobPlanStepNodeTypeDef = TypedDict( - "_OptionalJobPlanStepNodeTypeDef", +PutMigrationPlanResponseTypeDef = TypedDict( + "PutMigrationPlanResponseTypeDef", { - "subSteps": List[Dict[str, Any]], + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class JobPlanStepNodeTypeDef(_RequiredJobPlanStepNodeTypeDef, _OptionalJobPlanStepNodeTypeDef): - pass - - -_RequiredJobPlanStepTypeDef = TypedDict( - "_RequiredJobPlanStepTypeDef", +PutPartnerDetailsResponseTypeDef = TypedDict( + "PutPartnerDetailsResponseTypeDef", { - "stepId": str, - "parentStepId": str, - "stepLabel": str, - "stepName": str, - "description": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalJobPlanStepTypeDef = TypedDict( - "_OptionalJobPlanStepTypeDef", +RefreshAuthTokenResponseTypeDef = TypedDict( + "RefreshAuthTokenResponseTypeDef", { - "score": float, - "startTime": datetime, - "endTime": datetime, - "status": PlanStepStatusType, + "authorizationToken": str, + "authorizationExpiration": datetime, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class JobPlanStepTypeDef(_RequiredJobPlanStepTypeDef, _OptionalJobPlanStepTypeDef): - pass - - -JobPlanTreeTypeDef = TypedDict( - "JobPlanTreeTypeDef", +SendMessageResponseTypeDef = TypedDict( + "SendMessageResponseTypeDef", { - "nodes": List["JobPlanStepNodeTypeDef"], + "result": Dict[str, Any], + "error": Dict[str, Any], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -LimitDefinitionTypeDef = TypedDict( - "LimitDefinitionTypeDef", +StartHitlTaskResponseTypeDef = TypedDict( + "StartHitlTaskResponseTypeDef", { - "limit": float, - "unit": Literal["COUNT"], + "hitlTaskStatus": HitlTaskStatusType, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -ListAgentFilterTypeDef = TypedDict( - "ListAgentFilterTypeDef", +StartKnowledgeBaseIngestionResponseTypeDef = TypedDict( + "StartKnowledgeBaseIngestionResponseTypeDef", { - "requesterAgentInstanceId": str, + "ingestionId": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredListAgentInstancesRequestRequestTypeDef = TypedDict( - "_RequiredListAgentInstancesRequestRequestTypeDef", +UpdateUMRStatusResponseTypeDef = TypedDict( + "UpdateUMRStatusResponseTypeDef", { - "requestContext": "RequestContextTypeDef", + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListAgentInstancesRequestRequestTypeDef = TypedDict( - "_OptionalListAgentInstancesRequestRequestTypeDef", +ListConnectorsResponseTypeDef = TypedDict( + "ListConnectorsResponseTypeDef", { + "connectorsList": List[ConnectorSummaryDataTypeDef], "nextToken": str, - "agentFilter": "ListAgentFilterTypeDef", - "maxResults": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class ListAgentInstancesRequestRequestTypeDef( - _RequiredListAgentInstancesRequestRequestTypeDef, - _OptionalListAgentInstancesRequestRequestTypeDef, -): - pass - - -ListAgentInstancesResponseTypeDef = TypedDict( - "ListAgentInstancesResponseTypeDef", +HitlTaskTypeDef = TypedDict( + "HitlTaskTypeDef", { - "agentInstanceSummaries": List["AgentInstanceSummaryTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "hitlTaskId": str, + "hitlTaskStatus": HitlTaskStatusType, + "uxComponentId": str, + "blockingType": BlockingTypeType, + "severity": SeverityType, + "hitlTaskType": HitlTaskTypeType, + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], + "completedAt": NotRequired[datetime], + "tag": NotRequired[str], + "stepId": NotRequired[str], + "agentArtifact": NotRequired[HitlTaskArtifactTypeDef], + "humanArtifact": NotRequired[HitlTaskArtifactTypeDef], + "description": NotRequired[str], + "action": NotRequired[ActionType], + "category": NotRequired[CategoryType], + }, +) +PlanStepUpdateTypeDef = TypedDict( + "PlanStepUpdateTypeDef", + { + "stepId": str, + "startTime": NotRequired[TimestampTypeDef], + "endTime": NotRequired[TimestampTypeDef], + "status": NotRequired[PlanStepStatusType], + "description": NotRequired[str], }, ) - -ListAgentsFilterTypeDef = TypedDict( - "ListAgentsFilterTypeDef", +TimeFilterTypeDef = TypedDict( + "TimeFilterTypeDef", { - "agentTypeFilter": "AgentTypeFilterTypeDef", + "startTime": NotRequired[TimestampTypeDef], + "endTime": NotRequired[TimestampTypeDef], }, - total=False, ) - -_RequiredListAgentsRequestRequestTypeDef = TypedDict( - "_RequiredListAgentsRequestRequestTypeDef", +UmrResourceTypeDef = TypedDict( + "UmrResourceTypeDef", { - "requestContext": "RequestContextTypeDef", + "resourceType": UmrResourceTypeType, + "resourceId": str, + "status": UmrResourceStatusType, + "metadata": NotRequired[Mapping[str, str]], + "createdAt": NotRequired[TimestampTypeDef], }, ) -_OptionalListAgentsRequestRequestTypeDef = TypedDict( - "_OptionalListAgentsRequestRequestTypeDef", +WorklogTypeDef = TypedDict( + "WorklogTypeDef", { - "agentFilter": "ListAgentsFilterTypeDef", - "nextToken": str, - "maxResults": int, + "timestamp": TimestampTypeDef, + "attributeMap": Mapping[str, str], + "description": NotRequired[str], }, - total=False, ) - - -class ListAgentsRequestRequestTypeDef( - _RequiredListAgentsRequestRequestTypeDef, _OptionalListAgentsRequestRequestTypeDef -): - pass - - -ListAgentsResponseTypeDef = TypedDict( - "ListAgentsResponseTypeDef", +RetrievalFilterTypeDef = TypedDict( + "RetrievalFilterTypeDef", { - "items": List["AgentMetadataSummaryTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "equals": NotRequired[FilterAttributeTypeDef], + "notEquals": NotRequired[FilterAttributeTypeDef], + "greaterThan": NotRequired[FilterAttributeTypeDef], + "greaterThanOrEquals": NotRequired[FilterAttributeTypeDef], + "lessThan": NotRequired[FilterAttributeTypeDef], + "lessThanOrEquals": NotRequired[FilterAttributeTypeDef], + "in": NotRequired[FilterAttributeTypeDef], + "notIn": NotRequired[FilterAttributeTypeDef], + "startsWith": NotRequired[FilterAttributeTypeDef], + "listContains": NotRequired[FilterAttributeTypeDef], + "stringContains": NotRequired[FilterAttributeTypeDef], + "andAll": NotRequired[Sequence[Dict[str, Any]]], + "orAll": NotRequired[Sequence[Dict[str, Any]]], }, ) - -_RequiredListArtifactsRequestRequestTypeDef = TypedDict( - "_RequiredListArtifactsRequestRequestTypeDef", +HierarchicalChunkingConfigurationTypeDef = TypedDict( + "HierarchicalChunkingConfigurationTypeDef", { - "requestContext": "RequestContextTypeDef", + "levelConfigurations": Sequence[HierarchicalChunkingLevelConfigurationTypeDef], + "overlapTokens": int, }, ) -_OptionalListArtifactsRequestRequestTypeDef = TypedDict( - "_OptionalListArtifactsRequestRequestTypeDef", +IngestionScopeMetadataTypeDef = TypedDict( + "IngestionScopeMetadataTypeDef", { - "artifactFilter": "ArtifactFilterTypeDef", - "nextToken": str, - "pathPrefix": str, - "maxResults": int, + "jobScope": NotRequired[JobMetadataTypeDef], }, - total=False, ) - - -class ListArtifactsRequestRequestTypeDef( - _RequiredListArtifactsRequestRequestTypeDef, _OptionalListArtifactsRequestRequestTypeDef -): - pass - - -ListArtifactsResponseTypeDef = TypedDict( - "ListArtifactsResponseTypeDef", +RequestContextTypeDef = TypedDict( + "RequestContextTypeDef", { - "artifacts": List["ArtifactTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "jobMetadata": JobMetadataTypeDef, + "agentInstanceId": str, + "authorizationToken": str, }, ) - -_RequiredListConnectorsRequestRequestTypeDef = TypedDict( - "_RequiredListConnectorsRequestRequestTypeDef", +JobInfoTypeDef = TypedDict( + "JobInfoTypeDef", { - "requestContext": "RequestContextTypeDef", + "jobId": NotRequired[str], + "workspaceId": NotRequired[str], + "statusDetails": NotRequired[StatusDetailsTypeDef], + "creationTime": NotRequired[datetime], + "startExecutionTime": NotRequired[datetime], + "endExecutionTime": NotRequired[datetime], + "objective": NotRequired[str], + "jobName": NotRequired[str], + "intent": NotRequired[str], + "runCountId": NotRequired[int], + "latestPlanVersion": NotRequired[int], + "clientSource": NotRequired[str], + "clientAppId": NotRequired[str], + "softDeleted": NotRequired[bool], }, ) -_OptionalListConnectorsRequestRequestTypeDef = TypedDict( - "_OptionalListConnectorsRequestRequestTypeDef", +ListJobPlanStepsResponseTypeDef = TypedDict( + "ListJobPlanStepsResponseTypeDef", { - "maxResults": int, + "steps": List[JobPlanStepTypeDef], "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class ListConnectorsRequestRequestTypeDef( - _RequiredListConnectorsRequestRequestTypeDef, _OptionalListConnectorsRequestRequestTypeDef -): - pass - - -ListConnectorsResponseTypeDef = TypedDict( - "ListConnectorsResponseTypeDef", +MeteringUsageTypeDef = TypedDict( + "MeteringUsageTypeDef", { - "connectorsList": List["ConnectorSummaryDataTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "resourceType": ResourceTypeType, + "amount": float, + "unit": Literal["COUNT"], + "limits": LimitDefinitionTypeDef, }, ) - -_RequiredListHitlTasksRequestRequestTypeDef = TypedDict( - "_RequiredListHitlTasksRequestRequestTypeDef", +ListWorklogsResponseTypeDef = TypedDict( + "ListWorklogsResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "taskType": HitlTaskTypeType, + "worklogs": List[WorklogOutputTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListHitlTasksRequestRequestTypeDef = TypedDict( - "_OptionalListHitlTasksRequestRequestTypeDef", +PutJobPlanResponseTypeDef = TypedDict( + "PutJobPlanResponseTypeDef", { - "taskFilter": "HitlTaskFilterTypeDef", - "nextToken": str, - "maxResults": int, + "status": PutJobPlanStatusType, + "mappings": List[PlanStepMappingTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class ListHitlTasksRequestRequestTypeDef( - _RequiredListHitlTasksRequestRequestTypeDef, _OptionalListHitlTasksRequestRequestTypeDef -): - pass - - -ListHitlTasksResponseTypeDef = TypedDict( - "ListHitlTasksResponseTypeDef", +RetrievalConfigurationTypeDef = TypedDict( + "RetrievalConfigurationTypeDef", { - "hitlTasks": List["HitlTaskTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "vectorSearchConfiguration": VectorSearchConfigurationTypeDef, }, ) - -_RequiredListJobPlanStepsRequestRequestTypeDef = TypedDict( - "_RequiredListJobPlanStepsRequestRequestTypeDef", +RetrievalResultLocationTypeDef = TypedDict( + "RetrievalResultLocationTypeDef", { - "requestContext": "RequestContextTypeDef", + "type": RetrievalResultLocationTypeType, + "s3Location": NotRequired[RetrievalResultS3LocationTypeDef], + "webLocation": NotRequired[RetrievalResultWebLocationTypeDef], }, ) -_OptionalListJobPlanStepsRequestRequestTypeDef = TypedDict( - "_OptionalListJobPlanStepsRequestRequestTypeDef", +UmrPartnerDetailsTypeDef = TypedDict( + "UmrPartnerDetailsTypeDef", { - "parentStepId": str, - "maxResults": int, - "nextToken": str, + "partnerAccountId": str, + "partnerName": str, + "partnerType": NotRequired[UmrPartnerTypeType], + "migrationPhase": NotRequired[UmrMigrationPhaseType], + "prmId": NotRequired[str], + "workspaceId": NotRequired[str], + "resources": NotRequired[List[UmrResourceOutputTypeDef]], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, - total=False, ) - - -class ListJobPlanStepsRequestRequestTypeDef( - _RequiredListJobPlanStepsRequestRequestTypeDef, _OptionalListJobPlanStepsRequestRequestTypeDef -): - pass - - -ListJobPlanStepsResponseTypeDef = TypedDict( - "ListJobPlanStepsResponseTypeDef", +GetConnectorResponseTypeDef = TypedDict( + "GetConnectorResponseTypeDef", { - "steps": List["JobPlanStepTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "connectorName": str, + "description": str, + "connectorType": str, + "configuration": Dict[str, str], + "accountConnection": AccountConnectionTypeDef, + "targetRegions": List[str], + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -_RequiredListWorklogsRequestRequestTypeDef = TypedDict( - "_RequiredListWorklogsRequestRequestTypeDef", +CompleteArtifactUploadResponseTypeDef = TypedDict( + "CompleteArtifactUploadResponseTypeDef", { - "requestContext": "RequestContextTypeDef", + "artifact": ArtifactTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListWorklogsRequestRequestTypeDef = TypedDict( - "_OptionalListWorklogsRequestRequestTypeDef", +CreateArtifactDownloadUrlResponseTypeDef = TypedDict( + "CreateArtifactDownloadUrlResponseTypeDef", { - "worklogFilter": "WorklogFilterTypeDef", - "nextToken": str, + "s3preSignedUrl": str, + "s3UrlExpiryTimestamp": datetime, + "artifactType": ArtifactTypeTypeDef, + "artifactLabel": str, + "requestHeaders": Dict[str, List[str]], + "artifact": ArtifactTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class ListWorklogsRequestRequestTypeDef( - _RequiredListWorklogsRequestRequestTypeDef, _OptionalListWorklogsRequestRequestTypeDef -): - pass - - -ListWorklogsResponseTypeDef = TypedDict( - "ListWorklogsResponseTypeDef", +GetArtifactMetadataResponseTypeDef = TypedDict( + "GetArtifactMetadataResponseTypeDef", { - "worklogs": List["WorklogTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "artifact": ArtifactTypeDef, + "isS3ObjectPresent": IsS3ObjectPresentTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -MetadataContextTypeDef = TypedDict( - "MetadataContextTypeDef", +ListArtifactsResponseTypeDef = TypedDict( + "ListArtifactsResponseTypeDef", { - "schemaVersion": str, - "content": Dict[str, Any], + "artifacts": List[ArtifactTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -MeteredAmountTypeDef = TypedDict( - "MeteredAmountTypeDef", +GetTemporaryCredentialsForConnectorResponseTypeDef = TypedDict( + "GetTemporaryCredentialsForConnectorResponseTypeDef", { - "amount": int, - "unit": Literal["COUNT"], + "temporaryCredentials": TemporaryCredentialsTypeDef, + "connectorConfiguration": Dict[str, str], + "targetRegion": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -MeteringAttributeTypeDef = TypedDict( - "MeteringAttributeTypeDef", +GetTemporaryCredentialsForRoleResponseTypeDef = TypedDict( + "GetTemporaryCredentialsForRoleResponseTypeDef", { - "name": str, - "value": str, + "temporaryCredentials": TemporaryCredentialsTypeDef, + "roleArn": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -MeteringUsageTypeDef = TypedDict( - "MeteringUsageTypeDef", +GetHitlTaskResponseTypeDef = TypedDict( + "GetHitlTaskResponseTypeDef", { - "resourceType": ResourceTypeType, - "amount": float, - "unit": Literal["COUNT"], - "limits": "LimitDefinitionTypeDef", + "hitlTask": HitlTaskTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -PaginatorConfigTypeDef = TypedDict( - "PaginatorConfigTypeDef", +ListHitlTasksResponseTypeDef = TypedDict( + "ListHitlTasksResponseTypeDef", { - "MaxItems": int, - "PageSize": int, - "StartingToken": str, + "hitlTasks": List[HitlTaskTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -PlanStepMappingTypeDef = TypedDict( - "PlanStepMappingTypeDef", +StepIdFilterTypeDef = TypedDict( + "StepIdFilterTypeDef", { - "stepLabel": str, "stepId": str, + "timeFilter": NotRequired[TimeFilterTypeDef], }, ) - -_RequiredPlanStepUpdateTypeDef = TypedDict( - "_RequiredPlanStepUpdateTypeDef", +UmrResourceUnionTypeDef = Union[UmrResourceTypeDef, UmrResourceOutputTypeDef] +WorklogUnionTypeDef = Union[WorklogTypeDef, WorklogOutputTypeDef] +ChunkingConfigurationTypeDef = TypedDict( + "ChunkingConfigurationTypeDef", { - "stepId": str, + "chunkingStrategy": ChunkingStrategyType, + "fixedSizeChunkingConfiguration": NotRequired[FixedSizeChunkingConfigurationTypeDef], + "hierarchicalChunkingConfiguration": NotRequired[HierarchicalChunkingConfigurationTypeDef], + "semanticChunkingConfiguration": NotRequired[SemanticChunkingConfigurationTypeDef], }, ) -_OptionalPlanStepUpdateTypeDef = TypedDict( - "_OptionalPlanStepUpdateTypeDef", +IngestionTypeDef = TypedDict( + "IngestionTypeDef", { - "startTime": Union[datetime, str], - "endTime": Union[datetime, str], - "status": PlanStepStatusType, - "description": str, + "ingestionId": str, + "status": IngestionStatusType, + "ingestionScopeMetadata": IngestionScopeMetadataTypeDef, + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], + "failureReason": NotRequired[str], }, - total=False, ) - - -class PlanStepUpdateTypeDef(_RequiredPlanStepUpdateTypeDef, _OptionalPlanStepUpdateTypeDef): - pass - - -PreProdTestOperationRequestRequestTypeDef = TypedDict( - "PreProdTestOperationRequestRequestTypeDef", +AcknowledgeDeletionRequestRequestTypeDef = TypedDict( + "AcknowledgeDeletionRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "deletionAcknowledgementToken": str, }, ) - -_RequiredPublishMeteringEventRequestRequestTypeDef = TypedDict( - "_RequiredPublishMeteringEventRequestRequestTypeDef", +CloseHitlTaskRequestRequestTypeDef = TypedDict( + "CloseHitlTaskRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "entity": "EntityTypeDef", - "resourceType": ResourceTypeType, - "resourceId": str, - "startTime": Union[datetime, str], + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, + "closureType": NotRequired[ClosureTypeType], + "idempotencyToken": NotRequired[str], }, ) -_OptionalPublishMeteringEventRequestRequestTypeDef = TypedDict( - "_OptionalPublishMeteringEventRequestRequestTypeDef", +CompleteArtifactUploadRequestRequestTypeDef = TypedDict( + "CompleteArtifactUploadRequestRequestTypeDef", { - "amount": "MeteredAmountTypeDef", - "idempotencyToken": str, - "attributes": List["MeteringAttributeTypeDef"], + "requestContext": RequestContextTypeDef, + "artifactId": str, }, - total=False, ) - - -class PublishMeteringEventRequestRequestTypeDef( - _RequiredPublishMeteringEventRequestRequestTypeDef, - _OptionalPublishMeteringEventRequestRequestTypeDef, -): - pass - - -PutJobPlanModeTypeDef = TypedDict( - "PutJobPlanModeTypeDef", +CopyArtifactRequestRequestTypeDef = TypedDict( + "CopyArtifactRequestRequestTypeDef", { - "override": Dict[str, Any], - "append": "AppendModeTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, + "idempotencyToken": NotRequired[str], }, - total=False, ) - -_RequiredPutJobPlanRequestRequestTypeDef = TypedDict( - "_RequiredPutJobPlanRequestRequestTypeDef", +CreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( + "CreateArtifactDownloadUrlRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "plan": "JobPlanTreeTypeDef", - "mode": "PutJobPlanModeTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, + "visibility": NotRequired[VisibilityType], }, ) -_OptionalPutJobPlanRequestRequestTypeDef = TypedDict( - "_OptionalPutJobPlanRequestRequestTypeDef", +CreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( + "CreateArtifactUploadUrlRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "contentDigest": ContentDigestTypeDef, + "artifactReference": ArtifactReferenceTypeDef, + "label": NotRequired[str], + "planStepId": NotRequired[str], + "visibility": NotRequired[VisibilityType], + "fileMetadata": NotRequired[FileMetadataTypeDef], }, - total=False, ) - - -class PutJobPlanRequestRequestTypeDef( - _RequiredPutJobPlanRequestRequestTypeDef, _OptionalPutJobPlanRequestRequestTypeDef -): - pass - - -PutJobPlanResponseTypeDef = TypedDict( - "PutJobPlanResponseTypeDef", +CreateHitlTaskRequestRequestTypeDef = TypedDict( + "CreateHitlTaskRequestRequestTypeDef", + { + "requestContext": RequestContextTypeDef, + "uxComponentId": str, + "description": str, + "title": str, + "severity": NotRequired[SeverityType], + "hitlTaskType": NotRequired[HitlTaskTypeType], + "stepId": NotRequired[str], + "blockingType": NotRequired[BlockingTypeType], + "hitlRequestArtifact": NotRequired[HitlTaskArtifactTypeDef], + "expiredAt": NotRequired[TimestampTypeDef], + "tag": NotRequired[str], + "idempotencyToken": NotRequired[str], + "category": NotRequired[CategoryType], + }, +) +CreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( + "CreateSkillDownloadUrlRequestRequestTypeDef", { - "status": PutJobPlanStatusType, - "mappings": List["PlanStepMappingTypeDef"], - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "skillName": str, + "idempotencyToken": NotRequired[str], + "version": NotRequired[str], }, ) - -RefreshAuthTokenRequestRequestTypeDef = TypedDict( - "RefreshAuthTokenRequestRequestTypeDef", +CreateWorklogRequestRequestTypeDef = TypedDict( + "CreateWorklogRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "sessionDuration": int, + "requestContext": RequestContextTypeDef, + "worklog": WorklogTypeDef, + "idempotencyToken": NotRequired[str], }, ) - -RefreshAuthTokenResponseTypeDef = TypedDict( - "RefreshAuthTokenResponseTypeDef", +DeleteJobPlanStepRequestRequestTypeDef = TypedDict( + "DeleteJobPlanStepRequestRequestTypeDef", { - "authorizationToken": str, - "authorizationExpiration": datetime, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "stepId": str, + "idempotencyToken": NotRequired[str], }, ) - -_RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "_RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef", +DeregisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( + "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, "artifactId": str, "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], }, ) -_OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "_OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef", - { - "indexingMetadata": Dict[str, str], - }, - total=False, -) - - -class RegisterKnowledgeBaseDocumentRequestRequestTypeDef( - _RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef, - _OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef, -): - pass - - -RequestContextTypeDef = TypedDict( - "RequestContextTypeDef", +GetAgentInstanceRequestRequestTypeDef = TypedDict( + "GetAgentInstanceRequestRequestTypeDef", { - "jobMetadata": "JobMetadataTypeDef", + "requestContext": RequestContextTypeDef, "agentInstanceId": str, - "authorizationToken": str, }, ) - -ResponseMetadataTypeDef = TypedDict( - "ResponseMetadataTypeDef", +GetAgentVersionRequestRequestTypeDef = TypedDict( + "GetAgentVersionRequestRequestTypeDef", { - "RequestId": str, - "HostId": str, - "HTTPStatusCode": int, - "HTTPHeaders": Dict[str, Any], - "RetryAttempts": int, + "requestContext": RequestContextTypeDef, + "name": str, + "version": NotRequired[str], }, ) - -RetrievalConfigurationTypeDef = TypedDict( - "RetrievalConfigurationTypeDef", +GetArtifactMetadataRequestRequestTypeDef = TypedDict( + "GetArtifactMetadataRequestRequestTypeDef", { - "vectorSearchConfiguration": "VectorSearchConfigurationTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, }, ) - -RetrievalFilterTypeDef = TypedDict( - "RetrievalFilterTypeDef", +GetConnectorRequestRequestTypeDef = TypedDict( + "GetConnectorRequestRequestTypeDef", { - "equals": "FilterAttributeTypeDef", - "notEquals": "FilterAttributeTypeDef", - "greaterThan": "FilterAttributeTypeDef", - "greaterThanOrEquals": "FilterAttributeTypeDef", - "lessThan": "FilterAttributeTypeDef", - "lessThanOrEquals": "FilterAttributeTypeDef", - "in": "FilterAttributeTypeDef", - "notIn": "FilterAttributeTypeDef", - "startsWith": "FilterAttributeTypeDef", - "listContains": "FilterAttributeTypeDef", - "stringContains": "FilterAttributeTypeDef", - "andAll": List[Dict[str, Any]], - "orAll": List[Dict[str, Any]], - }, - total=False, + "requestContext": RequestContextTypeDef, + "connectorId": str, + }, ) - -RetrievalQueryTypeDef = TypedDict( - "RetrievalQueryTypeDef", +GetHitlTaskRequestRequestTypeDef = TypedDict( + "GetHitlTaskRequestRequestTypeDef", { - "text": str, + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, }, ) - -RetrievalResultContentTypeDef = TypedDict( - "RetrievalResultContentTypeDef", +GetJobRequestRequestTypeDef = TypedDict( + "GetJobRequestRequestTypeDef", { - "text": str, + "requestContext": RequestContextTypeDef, + "includeObjective": NotRequired[bool], }, - total=False, ) - -_RequiredRetrievalResultLocationTypeDef = TypedDict( - "_RequiredRetrievalResultLocationTypeDef", +GetKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( + "GetKnowledgeBaseIngestionRequestRequestTypeDef", { - "type": RetrievalResultLocationTypeType, + "requestContext": RequestContextTypeDef, + "ingestionId": str, }, ) -_OptionalRetrievalResultLocationTypeDef = TypedDict( - "_OptionalRetrievalResultLocationTypeDef", +GetTaskRequestRequestTypeDef = TypedDict( + "GetTaskRequestRequestTypeDef", { - "s3Location": "RetrievalResultS3LocationTypeDef", - "webLocation": "RetrievalResultWebLocationTypeDef", + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "params": NotRequired[Mapping[str, Any]], }, - total=False, ) - - -class RetrievalResultLocationTypeDef( - _RequiredRetrievalResultLocationTypeDef, _OptionalRetrievalResultLocationTypeDef -): - pass - - -RetrievalResultS3LocationTypeDef = TypedDict( - "RetrievalResultS3LocationTypeDef", +GetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( + "GetTemporaryCredentialsForConnectorRequestRequestTypeDef", { - "uri": str, + "requestContext": RequestContextTypeDef, + "connectorId": str, + "targetRegion": NotRequired[str], }, - total=False, ) - -_RequiredRetrievalResultTypeDef = TypedDict( - "_RequiredRetrievalResultTypeDef", +GetTemporaryCredentialsForRoleRequestRequestTypeDef = TypedDict( + "GetTemporaryCredentialsForRoleRequestRequestTypeDef", { - "content": "RetrievalResultContentTypeDef", + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, }, ) -_OptionalRetrievalResultTypeDef = TypedDict( - "_OptionalRetrievalResultTypeDef", +GetUMRRequestRequestTypeDef = TypedDict( + "GetUMRRequestRequestTypeDef", { - "location": "RetrievalResultLocationTypeDef", - "score": float, - "metadata": Dict[str, Dict[str, Any]], + "requestContext": RequestContextTypeDef, }, - total=False, ) - - -class RetrievalResultTypeDef(_RequiredRetrievalResultTypeDef, _OptionalRetrievalResultTypeDef): - pass - - -RetrievalResultWebLocationTypeDef = TypedDict( - "RetrievalResultWebLocationTypeDef", +GetUsageRequestRequestTypeDef = TypedDict( + "GetUsageRequestRequestTypeDef", { - "url": str, + "requestContext": RequestContextTypeDef, + "resourceTypes": Sequence[ResourceTypeType], }, - total=False, ) - -_RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( - "_RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef", +InvokeAgentRequestRequestTypeDef = TypedDict( + "InvokeAgentRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "retrievalQuery": "RetrievalQueryTypeDef", - "retrievalScope": RetrievalScopeType, + "requestContext": RequestContextTypeDef, + "agentId": str, + "inputPayload": NotRequired[AgentInputPayloadTypeDef], + "idempotencyToken": NotRequired[str], + "agentVersion": NotRequired[str], + "agentInstanceId": NotRequired[str], + "agentType": NotRequired[AgentTypeType], }, ) -_OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( - "_OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef", +ListAgentInstancesRequestListAgentInstancesPaginateTypeDef = TypedDict( + "ListAgentInstancesRequestListAgentInstancesPaginateTypeDef", { - "retrievalConfiguration": "RetrievalConfigurationTypeDef", - "nextToken": str, + "requestContext": RequestContextTypeDef, + "agentFilter": NotRequired[ListAgentFilterTypeDef], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, - total=False, ) - - -class RetrieveFromKnowledgeBaseRequestRequestTypeDef( - _RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef, - _OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef, -): - pass - - -RetrieveFromKnowledgeBaseResponseTypeDef = TypedDict( - "RetrieveFromKnowledgeBaseResponseTypeDef", +ListAgentInstancesRequestRequestTypeDef = TypedDict( + "ListAgentInstancesRequestRequestTypeDef", { - "retrievalResults": List["RetrievalResultTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "nextToken": NotRequired[str], + "agentFilter": NotRequired[ListAgentFilterTypeDef], + "maxResults": NotRequired[int], }, ) - -RollbackMeteringEventRequestRequestTypeDef = TypedDict( - "RollbackMeteringEventRequestRequestTypeDef", +ListAgentsRequestRequestTypeDef = TypedDict( + "ListAgentsRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "entity": "EntityTypeDef", - "resourceType": ResourceTypeType, - "resourceId": str, - "amendTime": Union[datetime, str], + "requestContext": RequestContextTypeDef, + "agentFilter": NotRequired[ListAgentsFilterTypeDef], + "nextToken": NotRequired[str], + "maxResults": NotRequired[int], }, ) - -SemanticChunkingConfigurationTypeDef = TypedDict( - "SemanticChunkingConfigurationTypeDef", +ListArtifactsRequestListArtifactsPaginateTypeDef = TypedDict( + "ListArtifactsRequestListArtifactsPaginateTypeDef", { - "breakpointPercentileThreshold": int, - "bufferSize": int, - "maxTokens": int, + "requestContext": RequestContextTypeDef, + "artifactFilter": NotRequired[ArtifactFilterTypeDef], + "pathPrefix": NotRequired[str], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, ) - -_RequiredSendMessageRequestRequestTypeDef = TypedDict( - "_RequiredSendMessageRequestRequestTypeDef", +ListArtifactsRequestRequestTypeDef = TypedDict( + "ListArtifactsRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, + "requestContext": RequestContextTypeDef, + "artifactFilter": NotRequired[ArtifactFilterTypeDef], + "nextToken": NotRequired[str], + "pathPrefix": NotRequired[str], + "maxResults": NotRequired[int], }, ) -_OptionalSendMessageRequestRequestTypeDef = TypedDict( - "_OptionalSendMessageRequestRequestTypeDef", +ListConnectorsRequestRequestTypeDef = TypedDict( + "ListConnectorsRequestRequestTypeDef", { - "params": Dict[str, Any], + "requestContext": RequestContextTypeDef, + "maxResults": NotRequired[int], + "nextToken": NotRequired[str], }, - total=False, ) - - -class SendMessageRequestRequestTypeDef( - _RequiredSendMessageRequestRequestTypeDef, _OptionalSendMessageRequestRequestTypeDef -): - pass - - -SendMessageResponseTypeDef = TypedDict( - "SendMessageResponseTypeDef", +ListHitlTasksRequestListHitlTasksPaginateTypeDef = TypedDict( + "ListHitlTasksRequestListHitlTasksPaginateTypeDef", { - "result": Dict[str, Any], - "error": Dict[str, Any], - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "taskType": HitlTaskTypeType, + "taskFilter": NotRequired[HitlTaskFilterTypeDef], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, ) - -_RequiredStartHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredStartHitlTaskRequestRequestTypeDef", +ListHitlTasksRequestRequestTypeDef = TypedDict( + "ListHitlTasksRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, + "requestContext": RequestContextTypeDef, + "taskType": HitlTaskTypeType, + "taskFilter": NotRequired[HitlTaskFilterTypeDef], + "nextToken": NotRequired[str], + "maxResults": NotRequired[int], }, ) -_OptionalStartHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalStartHitlTaskRequestRequestTypeDef", +ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef = TypedDict( + "ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef", { - "firstInChain": bool, - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "parentStepId": NotRequired[str], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, - total=False, ) - - -class StartHitlTaskRequestRequestTypeDef( - _RequiredStartHitlTaskRequestRequestTypeDef, _OptionalStartHitlTaskRequestRequestTypeDef -): - pass - - -StartHitlTaskResponseTypeDef = TypedDict( - "StartHitlTaskResponseTypeDef", +ListJobPlanStepsRequestRequestTypeDef = TypedDict( + "ListJobPlanStepsRequestRequestTypeDef", { - "hitlTaskStatus": HitlTaskStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "parentStepId": NotRequired[str], + "maxResults": NotRequired[int], + "nextToken": NotRequired[str], }, ) - -_RequiredStartJobRequestRequestTypeDef = TypedDict( - "_RequiredStartJobRequestRequestTypeDef", +PublishMeteringEventRequestRequestTypeDef = TypedDict( + "PublishMeteringEventRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "entity": EntityTypeDef, + "resourceType": ResourceTypeType, + "resourceId": str, + "startTime": TimestampTypeDef, + "amount": NotRequired[MeteredAmountTypeDef], + "idempotencyToken": NotRequired[str], + "attributes": NotRequired[Sequence[MeteringAttributeTypeDef]], }, ) -_OptionalStartJobRequestRequestTypeDef = TypedDict( - "_OptionalStartJobRequestRequestTypeDef", +PutAgreementRequestRequestTypeDef = TypedDict( + "PutAgreementRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "agreementId": str, + "agreementStatus": UmrAgreementStatusType, + "agreementType": NotRequired[UmrIncentiveTypeType], + "executedTimestamp": NotRequired[TimestampTypeDef], + "amendmentVersion": NotRequired[int], + "agreementUrl": NotRequired[str], + "signedBy": NotRequired[str], + "awsSignatory": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class StartJobRequestRequestTypeDef( - _RequiredStartJobRequestRequestTypeDef, _OptionalStartJobRequestRequestTypeDef -): - pass - - -StartJobResponseTypeDef = TypedDict( - "StartJobResponseTypeDef", +PutEligibilityRequestRequestTypeDef = TypedDict( + "PutEligibilityRequestRequestTypeDef", { - "status": JobStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "outcome": UmrEligibilityOutcomeType, + "assessmentDate": TimestampTypeDef, + "assessmentScore": NotRequired[int], + "riskLevel": NotRequired[UmrRiskLevelType], + "qualificationCriteria": NotRequired[Mapping[str, bool]], + "idempotencyToken": NotRequired[str], }, ) - -_RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "_RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef", +PutJobPlanRequestRequestTypeDef = TypedDict( + "PutJobPlanRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], - "ingestionScopeMetadata": "IngestionScopeMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "plan": JobPlanTreeTypeDef, + "mode": PutJobPlanModeTypeDef, + "idempotencyToken": NotRequired[str], }, ) -_OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "_OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef", +PutMigrationPlanRequestRequestTypeDef = TypedDict( + "PutMigrationPlanRequestRequestTypeDef", { - "ingestionConfiguration": "IngestionConfigurationTypeDef", + "requestContext": RequestContextTypeDef, + "incentiveType": UmrIncentiveTypeType, + "startDate": TimestampTypeDef, + "endDate": TimestampTypeDef, + "creditCap": float, + "creditPercentage": NotRequired[float], + "linkedAccountDisbursement": NotRequired[bool], + "baselineSpend": NotRequired[Mapping[str, float]], + "programFlags": NotRequired[Mapping[str, bool]], + "partnerSpmsId": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class StartKnowledgeBaseIngestionRequestRequestTypeDef( - _RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef, - _OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef, -): - pass - - -StartKnowledgeBaseIngestionResponseTypeDef = TypedDict( - "StartKnowledgeBaseIngestionResponseTypeDef", +RefreshAuthTokenRequestRequestTypeDef = TypedDict( + "RefreshAuthTokenRequestRequestTypeDef", { - "ingestionId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "sessionDuration": int, }, ) - -_RequiredStatusDetailsTypeDef = TypedDict( - "_RequiredStatusDetailsTypeDef", +RegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( + "RegisterKnowledgeBaseDocumentRequestRequestTypeDef", { - "status": JobStatusType, + "requestContext": RequestContextTypeDef, + "artifactId": str, + "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "indexingMetadata": NotRequired[Mapping[str, str]], }, ) -_OptionalStatusDetailsTypeDef = TypedDict( - "_OptionalStatusDetailsTypeDef", +RestoreAgentRequestRequestTypeDef = TypedDict( + "RestoreAgentRequestRequestTypeDef", { - "failureReason": str, + "requestContext": RequestContextTypeDef, + "agentId": str, + "agentInstanceId": str, + "agentType": AgentTypeType, + "agentVersion": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class StatusDetailsTypeDef(_RequiredStatusDetailsTypeDef, _OptionalStatusDetailsTypeDef): - pass - - -_RequiredStatusInfoTypeDef = TypedDict( - "_RequiredStatusInfoTypeDef", +RollbackMeteringEventRequestRequestTypeDef = TypedDict( + "RollbackMeteringEventRequestRequestTypeDef", { - "status": JobStatusType, + "requestContext": RequestContextTypeDef, + "entity": EntityTypeDef, + "resourceType": ResourceTypeType, + "resourceId": str, + "amendTime": TimestampTypeDef, }, ) -_OptionalStatusInfoTypeDef = TypedDict( - "_OptionalStatusInfoTypeDef", +SendMessageRequestRequestTypeDef = TypedDict( + "SendMessageRequestRequestTypeDef", { - "failureCategory": FailureCategoryType, - "failureType": str, + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "params": NotRequired[Mapping[str, Any]], }, - total=False, ) - - -class StatusInfoTypeDef(_RequiredStatusInfoTypeDef, _OptionalStatusInfoTypeDef): - pass - - -_RequiredStepIdFilterTypeDef = TypedDict( - "_RequiredStepIdFilterTypeDef", +StartHitlTaskRequestRequestTypeDef = TypedDict( + "StartHitlTaskRequestRequestTypeDef", { - "stepId": str, + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, + "firstInChain": NotRequired[bool], + "idempotencyToken": NotRequired[str], }, ) -_OptionalStepIdFilterTypeDef = TypedDict( - "_OptionalStepIdFilterTypeDef", +StopAgentRequestRequestTypeDef = TypedDict( + "StopAgentRequestRequestTypeDef", { - "timeFilter": "TimeFilterTypeDef", + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class StepIdFilterTypeDef(_RequiredStepIdFilterTypeDef, _OptionalStepIdFilterTypeDef): - pass - - -_RequiredStopAgentRequestRequestTypeDef = TypedDict( - "_RequiredStopAgentRequestRequestTypeDef", +UpdateAgentInstanceRequestRequestTypeDef = TypedDict( + "UpdateAgentInstanceRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, "agentInstanceId": str, + "agentInstanceStatus": UpdateAgentInstanceStatusType, + "agentInstanceStatusReason": NotRequired[str], + "agentOutput": NotRequired[AgentOutputPayloadTypeDef], }, ) -_OptionalStopAgentRequestRequestTypeDef = TypedDict( - "_OptionalStopAgentRequestRequestTypeDef", +UpdateJobPlanStepRequestRequestTypeDef = TypedDict( + "UpdateJobPlanStepRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "planStep": PlanStepUpdateTypeDef, + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class StopAgentRequestRequestTypeDef( - _RequiredStopAgentRequestRequestTypeDef, _OptionalStopAgentRequestRequestTypeDef -): - pass - - -TemporaryCredentialsTypeDef = TypedDict( - "TemporaryCredentialsTypeDef", +UpdateJobStatusRequestRequestTypeDef = TypedDict( + "UpdateJobStatusRequestRequestTypeDef", { - "awsTemporaryCredentials": "AwsTemporaryCredentialsTypeDef", + "requestContext": RequestContextTypeDef, + "status": NotRequired[JobStatusType], + "statusInfo": NotRequired[StatusInfoTypeDef], + "idempotencyToken": NotRequired[str], + "notificationArtifactId": NotRequired[str], }, - total=False, ) - -TestOperationRequestRequestTypeDef = TypedDict( - "TestOperationRequestRequestTypeDef", +UpdateUMRStatusRequestRequestTypeDef = TypedDict( + "UpdateUMRStatusRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "status": UmrStatusType, + "idempotencyToken": NotRequired[str], }, ) - -TimeFilterTypeDef = TypedDict( - "TimeFilterTypeDef", +GetJobResponseTypeDef = TypedDict( + "GetJobResponseTypeDef", { - "startTime": Union[datetime, str], - "endTime": Union[datetime, str], + "job": JobInfoTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredUpdateAgentInstanceRequestRequestTypeDef = TypedDict( - "_RequiredUpdateAgentInstanceRequestRequestTypeDef", +GetUsageResponseTypeDef = TypedDict( + "GetUsageResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, - "agentInstanceStatus": UpdateAgentInstanceStatusType, + "usageResults": List[MeteringUsageTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalUpdateAgentInstanceRequestRequestTypeDef = TypedDict( - "_OptionalUpdateAgentInstanceRequestRequestTypeDef", +RetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( + "RetrieveFromKnowledgeBaseRequestRequestTypeDef", { - "agentInstanceStatusReason": str, - "agentOutput": "AgentOutputPayloadTypeDef", + "requestContext": RequestContextTypeDef, + "retrievalQuery": RetrievalQueryTypeDef, + "retrievalScope": RetrievalScopeType, + "retrievalConfiguration": NotRequired[RetrievalConfigurationTypeDef], + "nextToken": NotRequired[str], }, - total=False, ) - - -class UpdateAgentInstanceRequestRequestTypeDef( - _RequiredUpdateAgentInstanceRequestRequestTypeDef, - _OptionalUpdateAgentInstanceRequestRequestTypeDef, -): - pass - - -_RequiredUpdateJobPlanStepRequestRequestTypeDef = TypedDict( - "_RequiredUpdateJobPlanStepRequestRequestTypeDef", +RetrievalResultTypeDef = TypedDict( + "RetrievalResultTypeDef", { - "requestContext": "RequestContextTypeDef", - "planStep": "PlanStepUpdateTypeDef", + "content": RetrievalResultContentTypeDef, + "location": NotRequired[RetrievalResultLocationTypeDef], + "score": NotRequired[float], + "metadata": NotRequired[Dict[str, Dict[str, Any]]], }, ) -_OptionalUpdateJobPlanStepRequestRequestTypeDef = TypedDict( - "_OptionalUpdateJobPlanStepRequestRequestTypeDef", +GetUMRResponseTypeDef = TypedDict( + "GetUMRResponseTypeDef", { - "idempotencyToken": str, + "customerAccountId": str, + "projectName": str, + "status": UmrStatusType, + "version": int, + "plan": UmrMigrationPlanTypeDef, + "eligibility": UmrEligibilityTypeDef, + "agreements": List[UmrAgreementTypeDef], + "partners": List[UmrPartnerDetailsTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - - -class UpdateJobPlanStepRequestRequestTypeDef( - _RequiredUpdateJobPlanStepRequestRequestTypeDef, _OptionalUpdateJobPlanStepRequestRequestTypeDef -): - pass - - -_RequiredUpdateJobStatusRequestRequestTypeDef = TypedDict( - "_RequiredUpdateJobStatusRequestRequestTypeDef", +WorklogFilterTypeDef = TypedDict( + "WorklogFilterTypeDef", { - "requestContext": "RequestContextTypeDef", + "stepIdFilter": NotRequired[StepIdFilterTypeDef], + "timeFilter": NotRequired[TimeFilterTypeDef], }, ) -_OptionalUpdateJobStatusRequestRequestTypeDef = TypedDict( - "_OptionalUpdateJobStatusRequestRequestTypeDef", +PutPartnerDetailsRequestRequestTypeDef = TypedDict( + "PutPartnerDetailsRequestRequestTypeDef", { - "status": JobStatusType, - "statusInfo": "StatusInfoTypeDef", - "idempotencyToken": str, - "notificationArtifactId": str, + "requestContext": RequestContextTypeDef, + "partnerAccountId": str, + "partnerName": str, + "partnerType": NotRequired[UmrPartnerTypeType], + "migrationPhase": NotRequired[UmrMigrationPhaseType], + "prmId": NotRequired[str], + "workspaceId": NotRequired[str], + "resources": NotRequired[Sequence[UmrResourceUnionTypeDef]], + "idempotencyToken": NotRequired[str], }, - total=False, ) - - -class UpdateJobStatusRequestRequestTypeDef( - _RequiredUpdateJobStatusRequestRequestTypeDef, _OptionalUpdateJobStatusRequestRequestTypeDef -): - pass - - VectorIngestionConfigurationTypeDef = TypedDict( "VectorIngestionConfigurationTypeDef", { - "chunkingConfiguration": "ChunkingConfigurationTypeDef", + "chunkingConfiguration": NotRequired[ChunkingConfigurationTypeDef], }, - total=False, ) - -VectorSearchConfigurationTypeDef = TypedDict( - "VectorSearchConfigurationTypeDef", +GetKnowledgeBaseIngestionResponseTypeDef = TypedDict( + "GetKnowledgeBaseIngestionResponseTypeDef", { - "numberOfResults": int, - "filter": "RetrievalFilterTypeDef", + "ingestion": IngestionTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -WorklogFilterTypeDef = TypedDict( - "WorklogFilterTypeDef", +RetrieveFromKnowledgeBaseResponseTypeDef = TypedDict( + "RetrieveFromKnowledgeBaseResponseTypeDef", { - "stepIdFilter": "StepIdFilterTypeDef", - "timeFilter": "TimeFilterTypeDef", + "retrievalResults": List[RetrievalResultTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredWorklogTypeDef = TypedDict( - "_RequiredWorklogTypeDef", +ListWorklogsRequestRequestTypeDef = TypedDict( + "ListWorklogsRequestRequestTypeDef", { - "timestamp": Union[datetime, str], - "attributeMap": Dict[str, str], + "requestContext": RequestContextTypeDef, + "worklogFilter": NotRequired[WorklogFilterTypeDef], + "nextToken": NotRequired[str], + }, +) +IngestionConfigurationTypeDef = TypedDict( + "IngestionConfigurationTypeDef", + { + "vectorIngestionConfiguration": NotRequired[VectorIngestionConfigurationTypeDef], }, ) -_OptionalWorklogTypeDef = TypedDict( - "_OptionalWorklogTypeDef", +StartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( + "StartKnowledgeBaseIngestionRequestRequestTypeDef", { - "description": str, + "requestContext": RequestContextTypeDef, + "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "ingestionScopeMetadata": IngestionScopeMetadataTypeDef, + "ingestionConfiguration": NotRequired[IngestionConfigurationTypeDef], }, - total=False, ) - - -class WorklogTypeDef(_RequiredWorklogTypeDef, _OptionalWorklogTypeDef): - pass diff --git a/packages/types/src/agent_builder_types/type_defs.pyi b/packages/types/src/agent_builder_types/type_defs.pyi index bd865ce..29fef37 100644 --- a/packages/types/src/agent_builder_types/type_defs.pyi +++ b/packages/types/src/agent_builder_types/type_defs.pyi @@ -1,20 +1,22 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 """ -Type annotations for AWS Transform Agentic service type definitions. +Type annotations for transformagenticservice service type definitions. -[Open documentation](https://vemel.github.io/boto3_stubs_docs/agent_builder_types/type_defs.html) +[Open documentation](https://youtype.github.io/boto3_stubs_docs/agent_builder_types/type_defs/) Usage:: ```python - from agent_builder_types.type_defs import AccountConnectionTypeDef + from agent_builder_types.type_defs import AwsAccountConnectionTypeDef - data: AccountConnectionTypeDef = {...} + data: AwsAccountConnectionTypeDef = ... ``` """ import sys from datetime import datetime -from typing import Any, Dict, List, Union +from typing import Any, Dict, List, Mapping, Sequence, Union from .literals import ( AccessControlType, @@ -36,6 +38,7 @@ from .literals import ( HitlTaskTypeType, IngestionStatusType, JobStatusType, + MonitoringTypeType, OwnerTypeType, PlanStepStatusType, PutJobPlanStatusType, @@ -43,23 +46,35 @@ from .literals import ( RetrievalResultLocationTypeType, RetrievalScopeType, SeverityType, + UmrAgreementStatusType, + UmrEligibilityOutcomeType, + UmrIncentiveTypeType, + UmrMigrationPhaseType, + UmrPartnerTypeType, + UmrResourceStatusType, + UmrResourceTypeType, + UmrRiskLevelType, + UmrStatusType, UpdateAgentInstanceStatusType, VersionStatusType, VisibilityType, ) -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): from typing import Literal else: from typing_extensions import Literal -if sys.version_info >= (3, 8): +if sys.version_info >= (3, 12): + from typing import NotRequired +else: + from typing_extensions import NotRequired +if sys.version_info >= (3, 12): from typing import TypedDict else: from typing_extensions import TypedDict __all__ = ( - "AccountConnectionTypeDef", - "AcknowledgeDeletionRequestRequestTypeDef", + "AwsAccountConnectionTypeDef", "AgentConfigurationTypeDef", "AgentInputPayloadTypeDef", "AgentInstanceSummaryTypeDef", @@ -70,218 +85,220 @@ __all__ = ( "AppendModeTypeDef", "ArtifactAgentFilterTypeDef", "ArtifactCategoryFilterTypeDef", - "ArtifactFilterTypeDef", "ArtifactPlanStepFilterTypeDef", - "ArtifactReferenceTypeDef", - "ArtifactTypeDef", - "ArtifactTypeTypeDef", "ArtifactWorkspaceFilterTypeDef", - "AwsAccountConnectionTypeDef", + "ArtifactTypeTypeDef", + "FileMetadataTypeDef", "AwsTemporaryCredentialsTypeDef", + "FixedSizeChunkingConfigurationTypeDef", + "SemanticChunkingConfigurationTypeDef", + "ResponseMetadataTypeDef", + "ConnectorSummaryDataTypeDef", + "ContentDigestTypeDef", + "HitlTaskArtifactTypeDef", + "TimestampTypeDef", + "EntityTypeDef", + "FilterAttributeTypeDef", + "IsS3ObjectPresentTypeDef", + "UmrAgreementTypeDef", + "UmrEligibilityTypeDef", + "UmrMigrationPlanTypeDef", + "HierarchicalChunkingLevelConfigurationTypeDef", + "HitlTaskFilterTypeDef", + "JobMetadataTypeDef", + "StatusDetailsTypeDef", + "JobPlanStepNodeTypeDef", + "JobPlanStepTypeDef", + "JobPlanTreeTypeDef", + "LimitDefinitionTypeDef", + "ListAgentFilterTypeDef", + "PaginatorConfigTypeDef", + "WorklogOutputTypeDef", + "MeteredAmountTypeDef", + "MeteringAttributeTypeDef", + "PlanStepMappingTypeDef", + "VectorSearchConfigurationTypeDef", + "RetrievalQueryTypeDef", + "RetrievalResultContentTypeDef", + "RetrievalResultS3LocationTypeDef", + "RetrievalResultWebLocationTypeDef", + "StatusInfoTypeDef", + "UmrResourceOutputTypeDef", + "AccountConnectionTypeDef", + "ListAgentsFilterTypeDef", + "PutJobPlanModeTypeDef", + "ArtifactFilterTypeDef", + "ArtifactReferenceTypeDef", + "ArtifactTypeDef", + "TemporaryCredentialsTypeDef", + "CloseHitlTaskResponseTypeDef", + "CopyArtifactResponseTypeDef", + "CreateArtifactUploadUrlResponseTypeDef", + "CreateHitlTaskResponseTypeDef", + "CreateSkillDownloadUrlResponseTypeDef", + "GetAgentInstanceResponseTypeDef", + "GetAgentVersionResponseTypeDef", + "GetTaskResponseTypeDef", + "InvokeAgentResponseTypeDef", + "ListAgentInstancesResponseTypeDef", + "ListAgentsResponseTypeDef", + "PutAgreementResponseTypeDef", + "PutEligibilityResponseTypeDef", + "PutMigrationPlanResponseTypeDef", + "PutPartnerDetailsResponseTypeDef", + "RefreshAuthTokenResponseTypeDef", + "SendMessageResponseTypeDef", + "StartHitlTaskResponseTypeDef", + "StartKnowledgeBaseIngestionResponseTypeDef", + "UpdateUMRStatusResponseTypeDef", + "ListConnectorsResponseTypeDef", + "HitlTaskTypeDef", + "PlanStepUpdateTypeDef", + "TimeFilterTypeDef", + "UmrResourceTypeDef", + "WorklogTypeDef", + "RetrievalFilterTypeDef", + "HierarchicalChunkingConfigurationTypeDef", + "IngestionScopeMetadataTypeDef", + "RequestContextTypeDef", + "JobInfoTypeDef", + "ListJobPlanStepsResponseTypeDef", + "MeteringUsageTypeDef", + "ListWorklogsResponseTypeDef", + "PutJobPlanResponseTypeDef", + "RetrievalConfigurationTypeDef", + "RetrievalResultLocationTypeDef", + "UmrPartnerDetailsTypeDef", + "GetConnectorResponseTypeDef", + "CompleteArtifactUploadResponseTypeDef", + "CreateArtifactDownloadUrlResponseTypeDef", + "GetArtifactMetadataResponseTypeDef", + "ListArtifactsResponseTypeDef", + "GetTemporaryCredentialsForConnectorResponseTypeDef", + "GetTemporaryCredentialsForRoleResponseTypeDef", + "GetHitlTaskResponseTypeDef", + "ListHitlTasksResponseTypeDef", + "StepIdFilterTypeDef", + "UmrResourceUnionTypeDef", + "WorklogUnionTypeDef", "ChunkingConfigurationTypeDef", + "IngestionTypeDef", + "AcknowledgeDeletionRequestRequestTypeDef", "CloseHitlTaskRequestRequestTypeDef", - "CloseHitlTaskResponseTypeDef", "CompleteArtifactUploadRequestRequestTypeDef", - "CompleteArtifactUploadResponseTypeDef", - "ConnectorSummaryDataTypeDef", - "ContentDigestTypeDef", "CopyArtifactRequestRequestTypeDef", - "CopyArtifactResponseTypeDef", "CreateArtifactDownloadUrlRequestRequestTypeDef", - "CreateArtifactDownloadUrlResponseTypeDef", "CreateArtifactUploadUrlRequestRequestTypeDef", - "CreateArtifactUploadUrlResponseTypeDef", "CreateHitlTaskRequestRequestTypeDef", - "CreateHitlTaskResponseTypeDef", "CreateSkillDownloadUrlRequestRequestTypeDef", - "CreateSkillDownloadUrlResponseTypeDef", "CreateWorklogRequestRequestTypeDef", "DeleteJobPlanStepRequestRequestTypeDef", "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", - "EntityTypeDef", - "FileMetadataTypeDef", - "FilterAttributeTypeDef", - "FixedSizeChunkingConfigurationTypeDef", "GetAgentInstanceRequestRequestTypeDef", - "GetAgentInstanceResponseTypeDef", "GetAgentVersionRequestRequestTypeDef", - "GetAgentVersionResponseTypeDef", "GetArtifactMetadataRequestRequestTypeDef", - "GetArtifactMetadataResponseTypeDef", "GetConnectorRequestRequestTypeDef", - "GetConnectorResponseTypeDef", "GetHitlTaskRequestRequestTypeDef", - "GetHitlTaskResponseTypeDef", "GetJobRequestRequestTypeDef", - "GetJobResponseTypeDef", "GetKnowledgeBaseIngestionRequestRequestTypeDef", - "GetKnowledgeBaseIngestionResponseTypeDef", "GetTaskRequestRequestTypeDef", - "GetTaskResponseTypeDef", "GetTemporaryCredentialsForConnectorRequestRequestTypeDef", - "GetTemporaryCredentialsForConnectorResponseTypeDef", "GetTemporaryCredentialsForRoleRequestRequestTypeDef", - "GetTemporaryCredentialsForRoleResponseTypeDef", + "GetUMRRequestRequestTypeDef", "GetUsageRequestRequestTypeDef", - "GetUsageResponseTypeDef", - "HierarchicalChunkingConfigurationTypeDef", - "HierarchicalChunkingLevelConfigurationTypeDef", - "HitlTaskArtifactTypeDef", - "HitlTaskFilterTypeDef", - "HitlTaskTypeDef", - "IngestionConfigurationTypeDef", - "IngestionScopeMetadataTypeDef", - "IngestionTypeDef", "InvokeAgentRequestRequestTypeDef", - "InvokeAgentResponseTypeDef", - "IsS3ObjectPresentTypeDef", - "JobInfoTypeDef", - "JobMetadataTypeDef", - "JobPlanStepNodeTypeDef", - "JobPlanStepTypeDef", - "JobPlanTreeTypeDef", - "LimitDefinitionTypeDef", - "ListAgentFilterTypeDef", + "ListAgentInstancesRequestListAgentInstancesPaginateTypeDef", "ListAgentInstancesRequestRequestTypeDef", - "ListAgentInstancesResponseTypeDef", - "ListAgentsFilterTypeDef", "ListAgentsRequestRequestTypeDef", - "ListAgentsResponseTypeDef", + "ListArtifactsRequestListArtifactsPaginateTypeDef", "ListArtifactsRequestRequestTypeDef", - "ListArtifactsResponseTypeDef", "ListConnectorsRequestRequestTypeDef", - "ListConnectorsResponseTypeDef", + "ListHitlTasksRequestListHitlTasksPaginateTypeDef", "ListHitlTasksRequestRequestTypeDef", - "ListHitlTasksResponseTypeDef", + "ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef", "ListJobPlanStepsRequestRequestTypeDef", - "ListJobPlanStepsResponseTypeDef", - "ListWorklogsRequestRequestTypeDef", - "ListWorklogsResponseTypeDef", - "MetadataContextTypeDef", - "MeteredAmountTypeDef", - "MeteringAttributeTypeDef", - "MeteringUsageTypeDef", - "PaginatorConfigTypeDef", - "PlanStepMappingTypeDef", - "PlanStepUpdateTypeDef", - "PreProdTestOperationRequestRequestTypeDef", "PublishMeteringEventRequestRequestTypeDef", - "PutJobPlanModeTypeDef", + "PutAgreementRequestRequestTypeDef", + "PutEligibilityRequestRequestTypeDef", "PutJobPlanRequestRequestTypeDef", - "PutJobPlanResponseTypeDef", + "PutMigrationPlanRequestRequestTypeDef", "RefreshAuthTokenRequestRequestTypeDef", - "RefreshAuthTokenResponseTypeDef", "RegisterKnowledgeBaseDocumentRequestRequestTypeDef", - "RequestContextTypeDef", - "ResponseMetadataTypeDef", - "RetrievalConfigurationTypeDef", - "RetrievalFilterTypeDef", - "RetrievalQueryTypeDef", - "RetrievalResultContentTypeDef", - "RetrievalResultLocationTypeDef", - "RetrievalResultS3LocationTypeDef", - "RetrievalResultTypeDef", - "RetrievalResultWebLocationTypeDef", - "RetrieveFromKnowledgeBaseRequestRequestTypeDef", - "RetrieveFromKnowledgeBaseResponseTypeDef", + "RestoreAgentRequestRequestTypeDef", "RollbackMeteringEventRequestRequestTypeDef", - "SemanticChunkingConfigurationTypeDef", "SendMessageRequestRequestTypeDef", - "SendMessageResponseTypeDef", "StartHitlTaskRequestRequestTypeDef", - "StartHitlTaskResponseTypeDef", - "StartJobRequestRequestTypeDef", - "StartJobResponseTypeDef", - "StartKnowledgeBaseIngestionRequestRequestTypeDef", - "StartKnowledgeBaseIngestionResponseTypeDef", - "StatusDetailsTypeDef", - "StatusInfoTypeDef", - "StepIdFilterTypeDef", "StopAgentRequestRequestTypeDef", - "TemporaryCredentialsTypeDef", - "TestOperationRequestRequestTypeDef", - "TimeFilterTypeDef", "UpdateAgentInstanceRequestRequestTypeDef", "UpdateJobPlanStepRequestRequestTypeDef", "UpdateJobStatusRequestRequestTypeDef", - "VectorIngestionConfigurationTypeDef", - "VectorSearchConfigurationTypeDef", + "UpdateUMRStatusRequestRequestTypeDef", + "GetJobResponseTypeDef", + "GetUsageResponseTypeDef", + "RetrieveFromKnowledgeBaseRequestRequestTypeDef", + "RetrievalResultTypeDef", + "GetUMRResponseTypeDef", "WorklogFilterTypeDef", - "WorklogTypeDef", -) - -AccountConnectionTypeDef = TypedDict( - "AccountConnectionTypeDef", - { - "awsAccountConnection": "AwsAccountConnectionTypeDef", - }, - total=False, + "PutPartnerDetailsRequestRequestTypeDef", + "VectorIngestionConfigurationTypeDef", + "GetKnowledgeBaseIngestionResponseTypeDef", + "RetrieveFromKnowledgeBaseResponseTypeDef", + "ListWorklogsRequestRequestTypeDef", + "IngestionConfigurationTypeDef", + "StartKnowledgeBaseIngestionRequestRequestTypeDef", ) -AcknowledgeDeletionRequestRequestTypeDef = TypedDict( - "AcknowledgeDeletionRequestRequestTypeDef", +AwsAccountConnectionTypeDef = TypedDict( + "AwsAccountConnectionTypeDef", { - "requestContext": "RequestContextTypeDef", - "deletionAcknowledgementToken": str, + "status": NotRequired[AccountConnectionStatusType], + "createdDate": NotRequired[datetime], + "expirationDate": NotRequired[datetime], + "accountId": NotRequired[str], + "roleArn": NotRequired[str], + "connectionToken": NotRequired[str], }, ) - AgentConfigurationTypeDef = TypedDict( "AgentConfigurationTypeDef", { "shortDescription": str, "agentCard": Dict[str, Any], + "monitoringType": NotRequired[MonitoringTypeType], }, ) - AgentInputPayloadTypeDef = TypedDict( "AgentInputPayloadTypeDef", { - "serializedPayload": str, + "serializedPayload": NotRequired[str], }, - total=False, ) - -_RequiredAgentInstanceSummaryTypeDef = TypedDict( - "_RequiredAgentInstanceSummaryTypeDef", +AgentInstanceSummaryTypeDef = TypedDict( + "AgentInstanceSummaryTypeDef", { "agentInstanceId": str, "agentType": AgentTypeType, "agentInstanceStatus": AgentInstanceStatusType, + "agentId": NotRequired[str], + "agentVersion": NotRequired[str], }, ) -_OptionalAgentInstanceSummaryTypeDef = TypedDict( - "_OptionalAgentInstanceSummaryTypeDef", - { - "agentId": str, - "agentVersion": str, - }, - total=False, -) - -class AgentInstanceSummaryTypeDef( - _RequiredAgentInstanceSummaryTypeDef, _OptionalAgentInstanceSummaryTypeDef -): - pass - AgentMetadataSummaryTypeDef = TypedDict( "AgentMetadataSummaryTypeDef", { - "name": str, - "type": AgentTypeType, - "description": str, - "accountAccess": AccessControlType, - "visibility": AgentVisibilityType, - "ownerType": OwnerTypeType, - "customerConfigurationRequired": bool, - "agentConfigurationAvailability": AgentConfigurationAvailabilityType, - "customerConfiguredAgentDependencies": List[str], + "name": NotRequired[str], + "type": NotRequired[AgentTypeType], + "description": NotRequired[str], + "accountAccess": NotRequired[AccessControlType], + "visibility": NotRequired[AgentVisibilityType], + "ownerType": NotRequired[OwnerTypeType], + "customerConfigurationRequired": NotRequired[bool], + "agentConfigurationAvailability": NotRequired[AgentConfigurationAvailabilityType], + "customerConfiguredAgentDependencies": NotRequired[List[str]], }, - total=False, ) - -_RequiredAgentMetadataTypeDef = TypedDict( - "_RequiredAgentMetadataTypeDef", +AgentMetadataTypeDef = TypedDict( + "AgentMetadataTypeDef", { "type": AgentTypeType, "description": str, @@ -290,101 +307,42 @@ _RequiredAgentMetadataTypeDef = TypedDict( "ownerContactInfo": str, "ownerType": OwnerTypeType, "customerConfigurationRequired": bool, + "customerConfiguredAgentDependencies": NotRequired[List[str]], }, ) -_OptionalAgentMetadataTypeDef = TypedDict( - "_OptionalAgentMetadataTypeDef", - { - "customerConfiguredAgentDependencies": List[str], - }, - total=False, -) - -class AgentMetadataTypeDef(_RequiredAgentMetadataTypeDef, _OptionalAgentMetadataTypeDef): - pass - AgentOutputPayloadTypeDef = TypedDict( "AgentOutputPayloadTypeDef", { - "serializedPayload": str, + "serializedPayload": NotRequired[str], }, - total=False, ) - AgentTypeFilterTypeDef = TypedDict( "AgentTypeFilterTypeDef", { - "agentType": AgentTypeType, + "agentType": NotRequired[AgentTypeType], }, - total=False, ) - -_RequiredAppendModeTypeDef = TypedDict( - "_RequiredAppendModeTypeDef", +AppendModeTypeDef = TypedDict( + "AppendModeTypeDef", { "parentStepId": str, + "afterStepId": NotRequired[str], }, ) -_OptionalAppendModeTypeDef = TypedDict( - "_OptionalAppendModeTypeDef", - { - "afterStepId": str, - }, - total=False, -) - -class AppendModeTypeDef(_RequiredAppendModeTypeDef, _OptionalAppendModeTypeDef): - pass - -_RequiredArtifactAgentFilterTypeDef = TypedDict( - "_RequiredArtifactAgentFilterTypeDef", +ArtifactAgentFilterTypeDef = TypedDict( + "ArtifactAgentFilterTypeDef", { "agentInstanceId": str, + "category": NotRequired[CategoryTypeType], }, ) -_OptionalArtifactAgentFilterTypeDef = TypedDict( - "_OptionalArtifactAgentFilterTypeDef", - { - "category": CategoryTypeType, - }, - total=False, -) - -class ArtifactAgentFilterTypeDef( - _RequiredArtifactAgentFilterTypeDef, _OptionalArtifactAgentFilterTypeDef -): - pass - -_RequiredArtifactCategoryFilterTypeDef = TypedDict( - "_RequiredArtifactCategoryFilterTypeDef", +ArtifactCategoryFilterTypeDef = TypedDict( + "ArtifactCategoryFilterTypeDef", { "category": CategoryTypeType, + "artifactLabel": NotRequired[str], }, ) -_OptionalArtifactCategoryFilterTypeDef = TypedDict( - "_OptionalArtifactCategoryFilterTypeDef", - { - "artifactLabel": str, - }, - total=False, -) - -class ArtifactCategoryFilterTypeDef( - _RequiredArtifactCategoryFilterTypeDef, _OptionalArtifactCategoryFilterTypeDef -): - pass - -ArtifactFilterTypeDef = TypedDict( - "ArtifactFilterTypeDef", - { - "agentFilter": "ArtifactAgentFilterTypeDef", - "categoryFilter": "ArtifactCategoryFilterTypeDef", - "workspaceFilter": "ArtifactWorkspaceFilterTypeDef", - "planStepFilter": "ArtifactPlanStepFilterTypeDef", - }, - total=False, -) - ArtifactPlanStepFilterTypeDef = TypedDict( "ArtifactPlanStepFilterTypeDef", { @@ -392,1832 +350,1375 @@ ArtifactPlanStepFilterTypeDef = TypedDict( "category": CategoryTypeType, }, ) - -ArtifactReferenceTypeDef = TypedDict( - "ArtifactReferenceTypeDef", - { - "artifactType": "ArtifactTypeTypeDef", - "artifactId": str, - }, - total=False, -) - -_RequiredArtifactTypeDef = TypedDict( - "_RequiredArtifactTypeDef", - { - "artifactId": str, - "artifactType": "ArtifactTypeTypeDef", - "artifactCreatedTimestamp": datetime, - "artifactExpiryTimestamp": datetime, - }, -) -_OptionalArtifactTypeDef = TypedDict( - "_OptionalArtifactTypeDef", +ArtifactWorkspaceFilterTypeDef = TypedDict( + "ArtifactWorkspaceFilterTypeDef", { - "artifactLabel": str, - "fileMetadata": "FileMetadataTypeDef", - "sizeInBytes": int, - "storedInAtxBucket": bool, + "category": CategoryTypeType, + "artifactLabel": NotRequired[str], }, - total=False, ) - -class ArtifactTypeDef(_RequiredArtifactTypeDef, _OptionalArtifactTypeDef): - pass - -_RequiredArtifactTypeTypeDef = TypedDict( - "_RequiredArtifactTypeTypeDef", +ArtifactTypeTypeDef = TypedDict( + "ArtifactTypeTypeDef", { "categoryType": CategoryTypeType, "fileType": FileTypeType, + "schemaType": NotRequired[str], }, ) -_OptionalArtifactTypeTypeDef = TypedDict( - "_OptionalArtifactTypeTypeDef", - { - "schemaType": str, - }, - total=False, -) - -class ArtifactTypeTypeDef(_RequiredArtifactTypeTypeDef, _OptionalArtifactTypeTypeDef): - pass - -_RequiredArtifactWorkspaceFilterTypeDef = TypedDict( - "_RequiredArtifactWorkspaceFilterTypeDef", - { - "category": CategoryTypeType, - }, -) -_OptionalArtifactWorkspaceFilterTypeDef = TypedDict( - "_OptionalArtifactWorkspaceFilterTypeDef", - { - "artifactLabel": str, - }, - total=False, -) - -class ArtifactWorkspaceFilterTypeDef( - _RequiredArtifactWorkspaceFilterTypeDef, _OptionalArtifactWorkspaceFilterTypeDef -): - pass - -AwsAccountConnectionTypeDef = TypedDict( - "AwsAccountConnectionTypeDef", +FileMetadataTypeDef = TypedDict( + "FileMetadataTypeDef", { - "status": AccountConnectionStatusType, - "createdDate": datetime, - "expirationDate": datetime, - "accountId": str, - "roleArn": str, - "connectionToken": str, + "path": str, + "description": NotRequired[str], }, - total=False, ) - AwsTemporaryCredentialsTypeDef = TypedDict( - "AwsTemporaryCredentialsTypeDef", - { - "accessKey": str, - "secretKey": str, - "accessToken": str, - "expirationTime": datetime, - }, - total=False, -) - -_RequiredChunkingConfigurationTypeDef = TypedDict( - "_RequiredChunkingConfigurationTypeDef", - { - "chunkingStrategy": ChunkingStrategyType, - }, -) -_OptionalChunkingConfigurationTypeDef = TypedDict( - "_OptionalChunkingConfigurationTypeDef", - { - "fixedSizeChunkingConfiguration": "FixedSizeChunkingConfigurationTypeDef", - "hierarchicalChunkingConfiguration": "HierarchicalChunkingConfigurationTypeDef", - "semanticChunkingConfiguration": "SemanticChunkingConfigurationTypeDef", - }, - total=False, -) - -class ChunkingConfigurationTypeDef( - _RequiredChunkingConfigurationTypeDef, _OptionalChunkingConfigurationTypeDef -): - pass - -_RequiredCloseHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredCloseHitlTaskRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, - }, -) -_OptionalCloseHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalCloseHitlTaskRequestRequestTypeDef", - { - "closureType": ClosureTypeType, - "idempotencyToken": str, - }, - total=False, -) - -class CloseHitlTaskRequestRequestTypeDef( - _RequiredCloseHitlTaskRequestRequestTypeDef, _OptionalCloseHitlTaskRequestRequestTypeDef -): - pass - -CloseHitlTaskResponseTypeDef = TypedDict( - "CloseHitlTaskResponseTypeDef", - { - "hitlTaskStatus": HitlTaskStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -CompleteArtifactUploadRequestRequestTypeDef = TypedDict( - "CompleteArtifactUploadRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "artifactId": str, - }, -) - -CompleteArtifactUploadResponseTypeDef = TypedDict( - "CompleteArtifactUploadResponseTypeDef", - { - "artifact": "ArtifactTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredConnectorSummaryDataTypeDef = TypedDict( - "_RequiredConnectorSummaryDataTypeDef", - { - "connectorId": str, - }, -) -_OptionalConnectorSummaryDataTypeDef = TypedDict( - "_OptionalConnectorSummaryDataTypeDef", - { - "connectorName": str, - "description": str, - "connectorType": str, - "targetRegions": List[str], - }, - total=False, -) - -class ConnectorSummaryDataTypeDef( - _RequiredConnectorSummaryDataTypeDef, _OptionalConnectorSummaryDataTypeDef -): - pass - -ContentDigestTypeDef = TypedDict( - "ContentDigestTypeDef", - { - "sha256": str, - }, - total=False, -) - -_RequiredCopyArtifactRequestRequestTypeDef = TypedDict( - "_RequiredCopyArtifactRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "artifactId": str, - }, -) -_OptionalCopyArtifactRequestRequestTypeDef = TypedDict( - "_OptionalCopyArtifactRequestRequestTypeDef", - { - "idempotencyToken": str, - }, - total=False, -) - -class CopyArtifactRequestRequestTypeDef( - _RequiredCopyArtifactRequestRequestTypeDef, _OptionalCopyArtifactRequestRequestTypeDef -): - pass - -CopyArtifactResponseTypeDef = TypedDict( - "CopyArtifactResponseTypeDef", - { - "copyStatus": CopyStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredCreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateArtifactDownloadUrlRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "artifactId": str, - }, -) -_OptionalCreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateArtifactDownloadUrlRequestRequestTypeDef", - { - "visibility": VisibilityType, - }, - total=False, -) - -class CreateArtifactDownloadUrlRequestRequestTypeDef( - _RequiredCreateArtifactDownloadUrlRequestRequestTypeDef, - _OptionalCreateArtifactDownloadUrlRequestRequestTypeDef, -): - pass - -CreateArtifactDownloadUrlResponseTypeDef = TypedDict( - "CreateArtifactDownloadUrlResponseTypeDef", - { - "s3preSignedUrl": str, - "s3UrlExpiryTimestamp": datetime, - "artifactType": "ArtifactTypeTypeDef", - "artifactLabel": str, - "requestHeaders": Dict[str, List[str]], - "artifact": "ArtifactTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredCreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateArtifactUploadUrlRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "contentDigest": "ContentDigestTypeDef", - "artifactReference": "ArtifactReferenceTypeDef", - }, -) -_OptionalCreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateArtifactUploadUrlRequestRequestTypeDef", - { - "label": str, - "planStepId": str, - "visibility": VisibilityType, - "metadata": "MetadataContextTypeDef", - "fileMetadata": "FileMetadataTypeDef", - }, - total=False, -) - -class CreateArtifactUploadUrlRequestRequestTypeDef( - _RequiredCreateArtifactUploadUrlRequestRequestTypeDef, - _OptionalCreateArtifactUploadUrlRequestRequestTypeDef, -): - pass - -CreateArtifactUploadUrlResponseTypeDef = TypedDict( - "CreateArtifactUploadUrlResponseTypeDef", - { - "artifactId": str, - "s3preSignedUrl": str, - "s3UrlExpiryTimestamp": datetime, - "requestHeaders": Dict[str, List[str]], - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredCreateHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredCreateHitlTaskRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "uxComponentId": str, - "description": str, - "title": str, - }, -) -_OptionalCreateHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalCreateHitlTaskRequestRequestTypeDef", - { - "severity": SeverityType, - "hitlTaskType": HitlTaskTypeType, - "stepId": str, - "blockingType": BlockingTypeType, - "hitlRequestArtifact": "HitlTaskArtifactTypeDef", - "expiredAt": Union[datetime, str], - "tag": str, - "idempotencyToken": str, - "category": CategoryType, - }, - total=False, -) - -class CreateHitlTaskRequestRequestTypeDef( - _RequiredCreateHitlTaskRequestRequestTypeDef, _OptionalCreateHitlTaskRequestRequestTypeDef -): - pass - -CreateHitlTaskResponseTypeDef = TypedDict( - "CreateHitlTaskResponseTypeDef", - { - "hitlTaskId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredCreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( - "_RequiredCreateSkillDownloadUrlRequestRequestTypeDef", - { - "requestContext": "RequestContextTypeDef", - "skillName": str, - }, -) -_OptionalCreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( - "_OptionalCreateSkillDownloadUrlRequestRequestTypeDef", - { - "idempotencyToken": str, - "version": str, - }, - total=False, -) - -class CreateSkillDownloadUrlRequestRequestTypeDef( - _RequiredCreateSkillDownloadUrlRequestRequestTypeDef, - _OptionalCreateSkillDownloadUrlRequestRequestTypeDef, -): - pass - -CreateSkillDownloadUrlResponseTypeDef = TypedDict( - "CreateSkillDownloadUrlResponseTypeDef", - { - "s3PreSignedUrl": str, - "s3UrlExpiryTimestamp": int, - "requestHeaders": Dict[str, List[str]], - "version": str, - "ResponseMetadata": "ResponseMetadataTypeDef", - }, -) - -_RequiredCreateWorklogRequestRequestTypeDef = TypedDict( - "_RequiredCreateWorklogRequestRequestTypeDef", + "AwsTemporaryCredentialsTypeDef", { - "requestContext": "RequestContextTypeDef", - "worklog": "WorklogTypeDef", + "accessKey": NotRequired[str], + "secretKey": NotRequired[str], + "accessToken": NotRequired[str], + "expirationTime": NotRequired[datetime], }, ) -_OptionalCreateWorklogRequestRequestTypeDef = TypedDict( - "_OptionalCreateWorklogRequestRequestTypeDef", +FixedSizeChunkingConfigurationTypeDef = TypedDict( + "FixedSizeChunkingConfigurationTypeDef", { - "idempotencyToken": str, + "maxTokens": int, + "overlapPercentage": int, }, - total=False, ) - -class CreateWorklogRequestRequestTypeDef( - _RequiredCreateWorklogRequestRequestTypeDef, _OptionalCreateWorklogRequestRequestTypeDef -): - pass - -_RequiredDeleteJobPlanStepRequestRequestTypeDef = TypedDict( - "_RequiredDeleteJobPlanStepRequestRequestTypeDef", +SemanticChunkingConfigurationTypeDef = TypedDict( + "SemanticChunkingConfigurationTypeDef", { - "requestContext": "RequestContextTypeDef", - "stepId": str, + "breakpointPercentileThreshold": int, + "bufferSize": int, + "maxTokens": int, }, ) -_OptionalDeleteJobPlanStepRequestRequestTypeDef = TypedDict( - "_OptionalDeleteJobPlanStepRequestRequestTypeDef", +ResponseMetadataTypeDef = TypedDict( + "ResponseMetadataTypeDef", { - "idempotencyToken": str, + "RequestId": str, + "HTTPStatusCode": int, + "HTTPHeaders": Dict[str, str], + "RetryAttempts": int, + "HostId": NotRequired[str], }, - total=False, ) - -class DeleteJobPlanStepRequestRequestTypeDef( - _RequiredDeleteJobPlanStepRequestRequestTypeDef, _OptionalDeleteJobPlanStepRequestRequestTypeDef -): - pass - -DeregisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", +ConnectorSummaryDataTypeDef = TypedDict( + "ConnectorSummaryDataTypeDef", { - "requestContext": "RequestContextTypeDef", - "artifactId": str, - "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "connectorId": str, + "connectorName": NotRequired[str], + "description": NotRequired[str], + "connectorType": NotRequired[str], + "targetRegions": NotRequired[List[str]], }, ) - -EntityTypeDef = TypedDict( - "EntityTypeDef", +ContentDigestTypeDef = TypedDict( + "ContentDigestTypeDef", { - "accountIdEntity": Dict[str, Any], + "sha256": NotRequired[str], }, - total=False, ) - -_RequiredFileMetadataTypeDef = TypedDict( - "_RequiredFileMetadataTypeDef", +HitlTaskArtifactTypeDef = TypedDict( + "HitlTaskArtifactTypeDef", { - "path": str, + "artifactId": NotRequired[str], }, ) -_OptionalFileMetadataTypeDef = TypedDict( - "_OptionalFileMetadataTypeDef", +TimestampTypeDef = Union[datetime, str] +EntityTypeDef = TypedDict( + "EntityTypeDef", { - "description": str, + "accountIdEntity": NotRequired[Mapping[str, Any]], }, - total=False, ) - -class FileMetadataTypeDef(_RequiredFileMetadataTypeDef, _OptionalFileMetadataTypeDef): - pass - FilterAttributeTypeDef = TypedDict( "FilterAttributeTypeDef", { "key": str, - "value": Dict[str, Any], + "value": Mapping[str, Any], }, ) - -FixedSizeChunkingConfigurationTypeDef = TypedDict( - "FixedSizeChunkingConfigurationTypeDef", +IsS3ObjectPresentTypeDef = TypedDict( + "IsS3ObjectPresentTypeDef", { - "maxTokens": int, - "overlapPercentage": int, + "publicBucket": NotRequired[bool], + "privateBucket": NotRequired[bool], }, ) - -GetAgentInstanceRequestRequestTypeDef = TypedDict( - "GetAgentInstanceRequestRequestTypeDef", +UmrAgreementTypeDef = TypedDict( + "UmrAgreementTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, + "agreementId": str, + "agreementStatus": UmrAgreementStatusType, + "agreementType": NotRequired[UmrIncentiveTypeType], + "executedTimestamp": NotRequired[datetime], + "amendmentVersion": NotRequired[int], + "agreementUrl": NotRequired[str], + "signedBy": NotRequired[str], + "awsSignatory": NotRequired[str], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, ) - -GetAgentInstanceResponseTypeDef = TypedDict( - "GetAgentInstanceResponseTypeDef", +UmrEligibilityTypeDef = TypedDict( + "UmrEligibilityTypeDef", { - "agentInstanceId": str, - "agentType": AgentTypeType, - "agentId": str, - "agentVersion": str, - "agentInstanceStatus": AgentInstanceStatusType, - "agentInput": "AgentInputPayloadTypeDef", - "agentOutput": "AgentOutputPayloadTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "outcome": UmrEligibilityOutcomeType, + "assessmentDate": datetime, + "assessmentScore": NotRequired[int], + "riskLevel": NotRequired[UmrRiskLevelType], + "qualificationCriteria": NotRequired[Dict[str, bool]], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, ) - -_RequiredGetAgentVersionRequestRequestTypeDef = TypedDict( - "_RequiredGetAgentVersionRequestRequestTypeDef", +UmrMigrationPlanTypeDef = TypedDict( + "UmrMigrationPlanTypeDef", { - "requestContext": "RequestContextTypeDef", - "name": str, + "incentiveType": UmrIncentiveTypeType, + "startDate": datetime, + "endDate": datetime, + "creditCap": float, + "creditPercentage": NotRequired[float], + "linkedAccountDisbursement": NotRequired[bool], + "baselineSpend": NotRequired[Dict[str, float]], + "programFlags": NotRequired[Dict[str, bool]], + "partnerSpmsId": NotRequired[str], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, ) -_OptionalGetAgentVersionRequestRequestTypeDef = TypedDict( - "_OptionalGetAgentVersionRequestRequestTypeDef", +HierarchicalChunkingLevelConfigurationTypeDef = TypedDict( + "HierarchicalChunkingLevelConfigurationTypeDef", { - "version": str, + "maxTokens": int, }, - total=False, ) - -class GetAgentVersionRequestRequestTypeDef( - _RequiredGetAgentVersionRequestRequestTypeDef, _OptionalGetAgentVersionRequestRequestTypeDef -): - pass - -GetAgentVersionResponseTypeDef = TypedDict( - "GetAgentVersionResponseTypeDef", +HitlTaskFilterTypeDef = TypedDict( + "HitlTaskFilterTypeDef", { - "version": str, - "metadata": "AgentMetadataTypeDef", - "visibility": AgentVisibilityType, - "configuration": "AgentConfigurationTypeDef", - "status": VersionStatusType, - "statusMessage": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "taskStatus": NotRequired[HitlTaskStatusType], + "agentInstanceId": NotRequired[str], + "stepId": NotRequired[str], + "tag": NotRequired[str], + "blockingType": NotRequired[BlockingTypeType], + "categories": NotRequired[Sequence[CategoryType]], }, ) - -GetArtifactMetadataRequestRequestTypeDef = TypedDict( - "GetArtifactMetadataRequestRequestTypeDef", +JobMetadataTypeDef = TypedDict( + "JobMetadataTypeDef", { - "requestContext": "RequestContextTypeDef", - "artifactId": str, + "jobId": str, + "workspaceId": str, }, ) - -GetArtifactMetadataResponseTypeDef = TypedDict( - "GetArtifactMetadataResponseTypeDef", +StatusDetailsTypeDef = TypedDict( + "StatusDetailsTypeDef", { - "artifact": "ArtifactTypeDef", - "isS3ObjectPresent": "IsS3ObjectPresentTypeDef", - "metadata": "MetadataContextTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "status": JobStatusType, + "failureReason": NotRequired[str], }, ) - -GetConnectorRequestRequestTypeDef = TypedDict( - "GetConnectorRequestRequestTypeDef", +JobPlanStepNodeTypeDef = TypedDict( + "JobPlanStepNodeTypeDef", { - "requestContext": "RequestContextTypeDef", - "connectorId": str, + "stepLabel": str, + "stepName": str, + "description": str, + "subSteps": NotRequired[Sequence[Dict[str, Any]]], }, ) - -GetConnectorResponseTypeDef = TypedDict( - "GetConnectorResponseTypeDef", +JobPlanStepTypeDef = TypedDict( + "JobPlanStepTypeDef", { - "connectorName": str, + "stepId": str, + "parentStepId": str, + "stepLabel": str, + "stepName": str, "description": str, - "connectorType": str, - "configuration": Dict[str, str], - "accountConnection": "AccountConnectionTypeDef", - "targetRegions": List[str], - "ResponseMetadata": "ResponseMetadataTypeDef", + "score": NotRequired[float], + "startTime": NotRequired[datetime], + "endTime": NotRequired[datetime], + "status": NotRequired[PlanStepStatusType], }, ) - -GetHitlTaskRequestRequestTypeDef = TypedDict( - "GetHitlTaskRequestRequestTypeDef", +JobPlanTreeTypeDef = TypedDict( + "JobPlanTreeTypeDef", { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, + "nodes": NotRequired[Sequence["JobPlanStepNodeTypeDef"]], }, ) - -GetHitlTaskResponseTypeDef = TypedDict( - "GetHitlTaskResponseTypeDef", +LimitDefinitionTypeDef = TypedDict( + "LimitDefinitionTypeDef", { - "hitlTask": "HitlTaskTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "limit": float, + "unit": Literal["COUNT"], }, ) - -_RequiredGetJobRequestRequestTypeDef = TypedDict( - "_RequiredGetJobRequestRequestTypeDef", +ListAgentFilterTypeDef = TypedDict( + "ListAgentFilterTypeDef", { - "requestContext": "RequestContextTypeDef", + "requesterAgentInstanceId": NotRequired[str], }, ) -_OptionalGetJobRequestRequestTypeDef = TypedDict( - "_OptionalGetJobRequestRequestTypeDef", +PaginatorConfigTypeDef = TypedDict( + "PaginatorConfigTypeDef", { - "includeObjective": bool, + "MaxItems": NotRequired[int], + "PageSize": NotRequired[int], + "StartingToken": NotRequired[str], }, - total=False, ) - -class GetJobRequestRequestTypeDef( - _RequiredGetJobRequestRequestTypeDef, _OptionalGetJobRequestRequestTypeDef -): - pass - -GetJobResponseTypeDef = TypedDict( - "GetJobResponseTypeDef", +WorklogOutputTypeDef = TypedDict( + "WorklogOutputTypeDef", { - "job": "JobInfoTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "timestamp": datetime, + "attributeMap": Dict[str, str], + "description": NotRequired[str], }, ) - -GetKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "GetKnowledgeBaseIngestionRequestRequestTypeDef", +MeteredAmountTypeDef = TypedDict( + "MeteredAmountTypeDef", { - "requestContext": "RequestContextTypeDef", - "ingestionId": str, + "amount": NotRequired[int], + "unit": NotRequired[Literal["COUNT"]], }, ) - -GetKnowledgeBaseIngestionResponseTypeDef = TypedDict( - "GetKnowledgeBaseIngestionResponseTypeDef", +MeteringAttributeTypeDef = TypedDict( + "MeteringAttributeTypeDef", { - "ingestion": "IngestionTypeDef", - "ResponseMetadata": "ResponseMetadataTypeDef", + "name": str, + "value": str, }, ) - -_RequiredGetTaskRequestRequestTypeDef = TypedDict( - "_RequiredGetTaskRequestRequestTypeDef", +PlanStepMappingTypeDef = TypedDict( + "PlanStepMappingTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, + "stepLabel": str, + "stepId": str, }, ) -_OptionalGetTaskRequestRequestTypeDef = TypedDict( - "_OptionalGetTaskRequestRequestTypeDef", +VectorSearchConfigurationTypeDef = TypedDict( + "VectorSearchConfigurationTypeDef", { - "params": Dict[str, Any], + "numberOfResults": NotRequired[int], + "filter": NotRequired["RetrievalFilterTypeDef"], }, - total=False, ) - -class GetTaskRequestRequestTypeDef( - _RequiredGetTaskRequestRequestTypeDef, _OptionalGetTaskRequestRequestTypeDef -): - pass - -GetTaskResponseTypeDef = TypedDict( - "GetTaskResponseTypeDef", +RetrievalQueryTypeDef = TypedDict( + "RetrievalQueryTypeDef", { - "result": Dict[str, Any], - "error": Dict[str, Any], - "ResponseMetadata": "ResponseMetadataTypeDef", + "text": str, }, ) - -_RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( - "_RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef", +RetrievalResultContentTypeDef = TypedDict( + "RetrievalResultContentTypeDef", { - "requestContext": "RequestContextTypeDef", - "connectorId": str, + "text": NotRequired[str], }, ) -_OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( - "_OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef", +RetrievalResultS3LocationTypeDef = TypedDict( + "RetrievalResultS3LocationTypeDef", { - "targetRegion": str, + "uri": NotRequired[str], }, - total=False, ) - -class GetTemporaryCredentialsForConnectorRequestRequestTypeDef( - _RequiredGetTemporaryCredentialsForConnectorRequestRequestTypeDef, - _OptionalGetTemporaryCredentialsForConnectorRequestRequestTypeDef, -): - pass - -GetTemporaryCredentialsForConnectorResponseTypeDef = TypedDict( - "GetTemporaryCredentialsForConnectorResponseTypeDef", +RetrievalResultWebLocationTypeDef = TypedDict( + "RetrievalResultWebLocationTypeDef", { - "temporaryCredentials": "TemporaryCredentialsTypeDef", - "connectorConfiguration": Dict[str, str], - "targetRegion": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "url": NotRequired[str], }, ) - -GetTemporaryCredentialsForRoleRequestRequestTypeDef = TypedDict( - "GetTemporaryCredentialsForRoleRequestRequestTypeDef", +StatusInfoTypeDef = TypedDict( + "StatusInfoTypeDef", { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, + "status": JobStatusType, + "failureCategory": NotRequired[FailureCategoryType], + "failureType": NotRequired[str], }, ) - -GetTemporaryCredentialsForRoleResponseTypeDef = TypedDict( - "GetTemporaryCredentialsForRoleResponseTypeDef", +UmrResourceOutputTypeDef = TypedDict( + "UmrResourceOutputTypeDef", { - "temporaryCredentials": "TemporaryCredentialsTypeDef", - "roleArn": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "resourceType": UmrResourceTypeType, + "resourceId": str, + "status": UmrResourceStatusType, + "metadata": NotRequired[Dict[str, str]], + "createdAt": NotRequired[datetime], }, ) - -GetUsageRequestRequestTypeDef = TypedDict( - "GetUsageRequestRequestTypeDef", +AccountConnectionTypeDef = TypedDict( + "AccountConnectionTypeDef", { - "requestContext": "RequestContextTypeDef", - "resourceTypes": List[ResourceTypeType], + "awsAccountConnection": NotRequired[AwsAccountConnectionTypeDef], }, ) - -GetUsageResponseTypeDef = TypedDict( - "GetUsageResponseTypeDef", +ListAgentsFilterTypeDef = TypedDict( + "ListAgentsFilterTypeDef", { - "usageResults": List["MeteringUsageTypeDef"], - "ResponseMetadata": "ResponseMetadataTypeDef", + "agentTypeFilter": NotRequired[AgentTypeFilterTypeDef], }, ) - -HierarchicalChunkingConfigurationTypeDef = TypedDict( - "HierarchicalChunkingConfigurationTypeDef", +PutJobPlanModeTypeDef = TypedDict( + "PutJobPlanModeTypeDef", { - "levelConfigurations": List["HierarchicalChunkingLevelConfigurationTypeDef"], - "overlapTokens": int, + "override": NotRequired[Mapping[str, Any]], + "append": NotRequired[AppendModeTypeDef], }, ) - -HierarchicalChunkingLevelConfigurationTypeDef = TypedDict( - "HierarchicalChunkingLevelConfigurationTypeDef", +ArtifactFilterTypeDef = TypedDict( + "ArtifactFilterTypeDef", { - "maxTokens": int, + "agentFilter": NotRequired[ArtifactAgentFilterTypeDef], + "categoryFilter": NotRequired[ArtifactCategoryFilterTypeDef], + "workspaceFilter": NotRequired[ArtifactWorkspaceFilterTypeDef], + "planStepFilter": NotRequired[ArtifactPlanStepFilterTypeDef], }, ) - -HitlTaskArtifactTypeDef = TypedDict( - "HitlTaskArtifactTypeDef", +ArtifactReferenceTypeDef = TypedDict( + "ArtifactReferenceTypeDef", + { + "artifactType": NotRequired[ArtifactTypeTypeDef], + "artifactId": NotRequired[str], + }, +) +ArtifactTypeDef = TypedDict( + "ArtifactTypeDef", { "artifactId": str, + "artifactType": ArtifactTypeTypeDef, + "artifactCreatedTimestamp": datetime, + "artifactExpiryTimestamp": datetime, + "artifactLabel": NotRequired[str], + "fileMetadata": NotRequired[FileMetadataTypeDef], + "sizeInBytes": NotRequired[int], + "storedInAtxBucket": NotRequired[bool], }, - total=False, ) - -HitlTaskFilterTypeDef = TypedDict( - "HitlTaskFilterTypeDef", +TemporaryCredentialsTypeDef = TypedDict( + "TemporaryCredentialsTypeDef", { - "taskStatus": HitlTaskStatusType, - "agentInstanceId": str, - "stepId": str, - "tag": str, - "blockingType": BlockingTypeType, - "categories": List[CategoryType], + "awsTemporaryCredentials": NotRequired[AwsTemporaryCredentialsTypeDef], }, - total=False, ) - -_RequiredHitlTaskTypeDef = TypedDict( - "_RequiredHitlTaskTypeDef", +CloseHitlTaskResponseTypeDef = TypedDict( + "CloseHitlTaskResponseTypeDef", { - "hitlTaskId": str, "hitlTaskStatus": HitlTaskStatusType, - "uxComponentId": str, - "blockingType": BlockingTypeType, - "severity": SeverityType, - "hitlTaskType": HitlTaskTypeType, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalHitlTaskTypeDef = TypedDict( - "_OptionalHitlTaskTypeDef", +CopyArtifactResponseTypeDef = TypedDict( + "CopyArtifactResponseTypeDef", { - "createdAt": datetime, - "updatedAt": datetime, - "completedAt": datetime, - "tag": str, - "stepId": str, - "agentArtifact": "HitlTaskArtifactTypeDef", - "humanArtifact": "HitlTaskArtifactTypeDef", - "description": str, - "action": ActionType, - "category": CategoryType, + "copyStatus": CopyStatusType, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class HitlTaskTypeDef(_RequiredHitlTaskTypeDef, _OptionalHitlTaskTypeDef): - pass - -IngestionConfigurationTypeDef = TypedDict( - "IngestionConfigurationTypeDef", +CreateArtifactUploadUrlResponseTypeDef = TypedDict( + "CreateArtifactUploadUrlResponseTypeDef", { - "vectorIngestionConfiguration": "VectorIngestionConfigurationTypeDef", + "artifactId": str, + "s3preSignedUrl": str, + "s3UrlExpiryTimestamp": datetime, + "requestHeaders": Dict[str, List[str]], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -IngestionScopeMetadataTypeDef = TypedDict( - "IngestionScopeMetadataTypeDef", +CreateHitlTaskResponseTypeDef = TypedDict( + "CreateHitlTaskResponseTypeDef", { - "jobScope": "JobMetadataTypeDef", + "hitlTaskId": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredIngestionTypeDef = TypedDict( - "_RequiredIngestionTypeDef", +CreateSkillDownloadUrlResponseTypeDef = TypedDict( + "CreateSkillDownloadUrlResponseTypeDef", { - "ingestionId": str, - "status": IngestionStatusType, - "ingestionScopeMetadata": "IngestionScopeMetadataTypeDef", + "s3PreSignedUrl": str, + "s3UrlExpiryTimestamp": int, + "requestHeaders": Dict[str, List[str]], + "version": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalIngestionTypeDef = TypedDict( - "_OptionalIngestionTypeDef", +GetAgentInstanceResponseTypeDef = TypedDict( + "GetAgentInstanceResponseTypeDef", { - "createdAt": datetime, - "updatedAt": datetime, - "failureReason": str, + "agentInstanceId": str, + "agentType": AgentTypeType, + "agentId": str, + "agentVersion": str, + "agentInstanceStatus": AgentInstanceStatusType, + "agentInput": AgentInputPayloadTypeDef, + "agentOutput": AgentOutputPayloadTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class IngestionTypeDef(_RequiredIngestionTypeDef, _OptionalIngestionTypeDef): - pass - -_RequiredInvokeAgentRequestRequestTypeDef = TypedDict( - "_RequiredInvokeAgentRequestRequestTypeDef", +GetAgentVersionResponseTypeDef = TypedDict( + "GetAgentVersionResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentId": str, + "version": str, + "metadata": AgentMetadataTypeDef, + "visibility": AgentVisibilityType, + "configuration": AgentConfigurationTypeDef, + "status": VersionStatusType, + "statusMessage": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalInvokeAgentRequestRequestTypeDef = TypedDict( - "_OptionalInvokeAgentRequestRequestTypeDef", +GetTaskResponseTypeDef = TypedDict( + "GetTaskResponseTypeDef", { - "inputPayload": "AgentInputPayloadTypeDef", - "idempotencyToken": str, - "agentVersion": str, - "agentInstanceId": str, - "agentType": AgentTypeType, + "result": Dict[str, Any], + "error": Dict[str, Any], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class InvokeAgentRequestRequestTypeDef( - _RequiredInvokeAgentRequestRequestTypeDef, _OptionalInvokeAgentRequestRequestTypeDef -): - pass - InvokeAgentResponseTypeDef = TypedDict( "InvokeAgentResponseTypeDef", { "agentInstanceId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -IsS3ObjectPresentTypeDef = TypedDict( - "IsS3ObjectPresentTypeDef", +ListAgentInstancesResponseTypeDef = TypedDict( + "ListAgentInstancesResponseTypeDef", { - "publicBucket": bool, - "privateBucket": bool, + "agentInstanceSummaries": List[AgentInstanceSummaryTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -JobInfoTypeDef = TypedDict( - "JobInfoTypeDef", +ListAgentsResponseTypeDef = TypedDict( + "ListAgentsResponseTypeDef", { - "jobId": str, - "workspaceId": str, - "statusDetails": "StatusDetailsTypeDef", - "creationTime": datetime, - "startExecutionTime": datetime, - "endExecutionTime": datetime, - "objective": str, - "jobName": str, - "intent": str, - "runCountId": int, - "latestPlanVersion": int, - "clientSource": str, - "clientAppId": str, - "softDeleted": bool, - }, - total=False, + "items": List[AgentMetadataSummaryTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, + }, ) - -JobMetadataTypeDef = TypedDict( - "JobMetadataTypeDef", +PutAgreementResponseTypeDef = TypedDict( + "PutAgreementResponseTypeDef", { - "jobId": str, - "workspaceId": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -_RequiredJobPlanStepNodeTypeDef = TypedDict( - "_RequiredJobPlanStepNodeTypeDef", +PutEligibilityResponseTypeDef = TypedDict( + "PutEligibilityResponseTypeDef", { - "stepLabel": str, - "stepName": str, - "description": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalJobPlanStepNodeTypeDef = TypedDict( - "_OptionalJobPlanStepNodeTypeDef", +PutMigrationPlanResponseTypeDef = TypedDict( + "PutMigrationPlanResponseTypeDef", { - "subSteps": List[Dict[str, Any]], + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class JobPlanStepNodeTypeDef(_RequiredJobPlanStepNodeTypeDef, _OptionalJobPlanStepNodeTypeDef): - pass - -_RequiredJobPlanStepTypeDef = TypedDict( - "_RequiredJobPlanStepTypeDef", +PutPartnerDetailsResponseTypeDef = TypedDict( + "PutPartnerDetailsResponseTypeDef", { - "stepId": str, - "parentStepId": str, - "stepLabel": str, - "stepName": str, - "description": str, + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalJobPlanStepTypeDef = TypedDict( - "_OptionalJobPlanStepTypeDef", +RefreshAuthTokenResponseTypeDef = TypedDict( + "RefreshAuthTokenResponseTypeDef", { - "score": float, - "startTime": datetime, - "endTime": datetime, - "status": PlanStepStatusType, + "authorizationToken": str, + "authorizationExpiration": datetime, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class JobPlanStepTypeDef(_RequiredJobPlanStepTypeDef, _OptionalJobPlanStepTypeDef): - pass - -JobPlanTreeTypeDef = TypedDict( - "JobPlanTreeTypeDef", +SendMessageResponseTypeDef = TypedDict( + "SendMessageResponseTypeDef", { - "nodes": List["JobPlanStepNodeTypeDef"], + "result": Dict[str, Any], + "error": Dict[str, Any], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -LimitDefinitionTypeDef = TypedDict( - "LimitDefinitionTypeDef", +StartHitlTaskResponseTypeDef = TypedDict( + "StartHitlTaskResponseTypeDef", { - "limit": float, - "unit": Literal["COUNT"], + "hitlTaskStatus": HitlTaskStatusType, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -ListAgentFilterTypeDef = TypedDict( - "ListAgentFilterTypeDef", +StartKnowledgeBaseIngestionResponseTypeDef = TypedDict( + "StartKnowledgeBaseIngestionResponseTypeDef", { - "requesterAgentInstanceId": str, + "ingestionId": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredListAgentInstancesRequestRequestTypeDef = TypedDict( - "_RequiredListAgentInstancesRequestRequestTypeDef", +UpdateUMRStatusResponseTypeDef = TypedDict( + "UpdateUMRStatusResponseTypeDef", { - "requestContext": "RequestContextTypeDef", + "version": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListAgentInstancesRequestRequestTypeDef = TypedDict( - "_OptionalListAgentInstancesRequestRequestTypeDef", +ListConnectorsResponseTypeDef = TypedDict( + "ListConnectorsResponseTypeDef", { + "connectorsList": List[ConnectorSummaryDataTypeDef], "nextToken": str, - "agentFilter": "ListAgentFilterTypeDef", - "maxResults": int, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class ListAgentInstancesRequestRequestTypeDef( - _RequiredListAgentInstancesRequestRequestTypeDef, - _OptionalListAgentInstancesRequestRequestTypeDef, -): - pass - -ListAgentInstancesResponseTypeDef = TypedDict( - "ListAgentInstancesResponseTypeDef", +HitlTaskTypeDef = TypedDict( + "HitlTaskTypeDef", { - "agentInstanceSummaries": List["AgentInstanceSummaryTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "hitlTaskId": str, + "hitlTaskStatus": HitlTaskStatusType, + "uxComponentId": str, + "blockingType": BlockingTypeType, + "severity": SeverityType, + "hitlTaskType": HitlTaskTypeType, + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], + "completedAt": NotRequired[datetime], + "tag": NotRequired[str], + "stepId": NotRequired[str], + "agentArtifact": NotRequired[HitlTaskArtifactTypeDef], + "humanArtifact": NotRequired[HitlTaskArtifactTypeDef], + "description": NotRequired[str], + "action": NotRequired[ActionType], + "category": NotRequired[CategoryType], + }, +) +PlanStepUpdateTypeDef = TypedDict( + "PlanStepUpdateTypeDef", + { + "stepId": str, + "startTime": NotRequired[TimestampTypeDef], + "endTime": NotRequired[TimestampTypeDef], + "status": NotRequired[PlanStepStatusType], + "description": NotRequired[str], }, ) - -ListAgentsFilterTypeDef = TypedDict( - "ListAgentsFilterTypeDef", +TimeFilterTypeDef = TypedDict( + "TimeFilterTypeDef", { - "agentTypeFilter": "AgentTypeFilterTypeDef", + "startTime": NotRequired[TimestampTypeDef], + "endTime": NotRequired[TimestampTypeDef], }, - total=False, ) - -_RequiredListAgentsRequestRequestTypeDef = TypedDict( - "_RequiredListAgentsRequestRequestTypeDef", +UmrResourceTypeDef = TypedDict( + "UmrResourceTypeDef", { - "requestContext": "RequestContextTypeDef", + "resourceType": UmrResourceTypeType, + "resourceId": str, + "status": UmrResourceStatusType, + "metadata": NotRequired[Mapping[str, str]], + "createdAt": NotRequired[TimestampTypeDef], }, ) -_OptionalListAgentsRequestRequestTypeDef = TypedDict( - "_OptionalListAgentsRequestRequestTypeDef", +WorklogTypeDef = TypedDict( + "WorklogTypeDef", { - "agentFilter": "ListAgentsFilterTypeDef", - "nextToken": str, - "maxResults": int, + "timestamp": TimestampTypeDef, + "attributeMap": Mapping[str, str], + "description": NotRequired[str], }, - total=False, ) - -class ListAgentsRequestRequestTypeDef( - _RequiredListAgentsRequestRequestTypeDef, _OptionalListAgentsRequestRequestTypeDef -): - pass - -ListAgentsResponseTypeDef = TypedDict( - "ListAgentsResponseTypeDef", +RetrievalFilterTypeDef = TypedDict( + "RetrievalFilterTypeDef", { - "items": List["AgentMetadataSummaryTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "equals": NotRequired[FilterAttributeTypeDef], + "notEquals": NotRequired[FilterAttributeTypeDef], + "greaterThan": NotRequired[FilterAttributeTypeDef], + "greaterThanOrEquals": NotRequired[FilterAttributeTypeDef], + "lessThan": NotRequired[FilterAttributeTypeDef], + "lessThanOrEquals": NotRequired[FilterAttributeTypeDef], + "in": NotRequired[FilterAttributeTypeDef], + "notIn": NotRequired[FilterAttributeTypeDef], + "startsWith": NotRequired[FilterAttributeTypeDef], + "listContains": NotRequired[FilterAttributeTypeDef], + "stringContains": NotRequired[FilterAttributeTypeDef], + "andAll": NotRequired[Sequence[Dict[str, Any]]], + "orAll": NotRequired[Sequence[Dict[str, Any]]], }, ) - -_RequiredListArtifactsRequestRequestTypeDef = TypedDict( - "_RequiredListArtifactsRequestRequestTypeDef", +HierarchicalChunkingConfigurationTypeDef = TypedDict( + "HierarchicalChunkingConfigurationTypeDef", { - "requestContext": "RequestContextTypeDef", + "levelConfigurations": Sequence[HierarchicalChunkingLevelConfigurationTypeDef], + "overlapTokens": int, }, ) -_OptionalListArtifactsRequestRequestTypeDef = TypedDict( - "_OptionalListArtifactsRequestRequestTypeDef", +IngestionScopeMetadataTypeDef = TypedDict( + "IngestionScopeMetadataTypeDef", { - "artifactFilter": "ArtifactFilterTypeDef", - "nextToken": str, - "pathPrefix": str, - "maxResults": int, + "jobScope": NotRequired[JobMetadataTypeDef], }, - total=False, ) - -class ListArtifactsRequestRequestTypeDef( - _RequiredListArtifactsRequestRequestTypeDef, _OptionalListArtifactsRequestRequestTypeDef -): - pass - -ListArtifactsResponseTypeDef = TypedDict( - "ListArtifactsResponseTypeDef", +RequestContextTypeDef = TypedDict( + "RequestContextTypeDef", { - "artifacts": List["ArtifactTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "jobMetadata": JobMetadataTypeDef, + "agentInstanceId": str, + "authorizationToken": str, }, ) - -_RequiredListConnectorsRequestRequestTypeDef = TypedDict( - "_RequiredListConnectorsRequestRequestTypeDef", +JobInfoTypeDef = TypedDict( + "JobInfoTypeDef", { - "requestContext": "RequestContextTypeDef", + "jobId": NotRequired[str], + "workspaceId": NotRequired[str], + "statusDetails": NotRequired[StatusDetailsTypeDef], + "creationTime": NotRequired[datetime], + "startExecutionTime": NotRequired[datetime], + "endExecutionTime": NotRequired[datetime], + "objective": NotRequired[str], + "jobName": NotRequired[str], + "intent": NotRequired[str], + "runCountId": NotRequired[int], + "latestPlanVersion": NotRequired[int], + "clientSource": NotRequired[str], + "clientAppId": NotRequired[str], + "softDeleted": NotRequired[bool], }, ) -_OptionalListConnectorsRequestRequestTypeDef = TypedDict( - "_OptionalListConnectorsRequestRequestTypeDef", +ListJobPlanStepsResponseTypeDef = TypedDict( + "ListJobPlanStepsResponseTypeDef", { - "maxResults": int, + "steps": List[JobPlanStepTypeDef], "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class ListConnectorsRequestRequestTypeDef( - _RequiredListConnectorsRequestRequestTypeDef, _OptionalListConnectorsRequestRequestTypeDef -): - pass - -ListConnectorsResponseTypeDef = TypedDict( - "ListConnectorsResponseTypeDef", +MeteringUsageTypeDef = TypedDict( + "MeteringUsageTypeDef", { - "connectorsList": List["ConnectorSummaryDataTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "resourceType": ResourceTypeType, + "amount": float, + "unit": Literal["COUNT"], + "limits": LimitDefinitionTypeDef, }, ) - -_RequiredListHitlTasksRequestRequestTypeDef = TypedDict( - "_RequiredListHitlTasksRequestRequestTypeDef", +ListWorklogsResponseTypeDef = TypedDict( + "ListWorklogsResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "taskType": HitlTaskTypeType, + "worklogs": List[WorklogOutputTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListHitlTasksRequestRequestTypeDef = TypedDict( - "_OptionalListHitlTasksRequestRequestTypeDef", +PutJobPlanResponseTypeDef = TypedDict( + "PutJobPlanResponseTypeDef", { - "taskFilter": "HitlTaskFilterTypeDef", - "nextToken": str, - "maxResults": int, + "status": PutJobPlanStatusType, + "mappings": List[PlanStepMappingTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class ListHitlTasksRequestRequestTypeDef( - _RequiredListHitlTasksRequestRequestTypeDef, _OptionalListHitlTasksRequestRequestTypeDef -): - pass - -ListHitlTasksResponseTypeDef = TypedDict( - "ListHitlTasksResponseTypeDef", +RetrievalConfigurationTypeDef = TypedDict( + "RetrievalConfigurationTypeDef", { - "hitlTasks": List["HitlTaskTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "vectorSearchConfiguration": VectorSearchConfigurationTypeDef, }, ) - -_RequiredListJobPlanStepsRequestRequestTypeDef = TypedDict( - "_RequiredListJobPlanStepsRequestRequestTypeDef", +RetrievalResultLocationTypeDef = TypedDict( + "RetrievalResultLocationTypeDef", { - "requestContext": "RequestContextTypeDef", + "type": RetrievalResultLocationTypeType, + "s3Location": NotRequired[RetrievalResultS3LocationTypeDef], + "webLocation": NotRequired[RetrievalResultWebLocationTypeDef], }, ) -_OptionalListJobPlanStepsRequestRequestTypeDef = TypedDict( - "_OptionalListJobPlanStepsRequestRequestTypeDef", +UmrPartnerDetailsTypeDef = TypedDict( + "UmrPartnerDetailsTypeDef", { - "parentStepId": str, - "maxResults": int, - "nextToken": str, + "partnerAccountId": str, + "partnerName": str, + "partnerType": NotRequired[UmrPartnerTypeType], + "migrationPhase": NotRequired[UmrMigrationPhaseType], + "prmId": NotRequired[str], + "workspaceId": NotRequired[str], + "resources": NotRequired[List[UmrResourceOutputTypeDef]], + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], }, - total=False, ) - -class ListJobPlanStepsRequestRequestTypeDef( - _RequiredListJobPlanStepsRequestRequestTypeDef, _OptionalListJobPlanStepsRequestRequestTypeDef -): - pass - -ListJobPlanStepsResponseTypeDef = TypedDict( - "ListJobPlanStepsResponseTypeDef", +GetConnectorResponseTypeDef = TypedDict( + "GetConnectorResponseTypeDef", { - "steps": List["JobPlanStepTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "connectorName": str, + "description": str, + "connectorType": str, + "configuration": Dict[str, str], + "accountConnection": AccountConnectionTypeDef, + "targetRegions": List[str], + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -_RequiredListWorklogsRequestRequestTypeDef = TypedDict( - "_RequiredListWorklogsRequestRequestTypeDef", +CompleteArtifactUploadResponseTypeDef = TypedDict( + "CompleteArtifactUploadResponseTypeDef", { - "requestContext": "RequestContextTypeDef", + "artifact": ArtifactTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalListWorklogsRequestRequestTypeDef = TypedDict( - "_OptionalListWorklogsRequestRequestTypeDef", +CreateArtifactDownloadUrlResponseTypeDef = TypedDict( + "CreateArtifactDownloadUrlResponseTypeDef", { - "worklogFilter": "WorklogFilterTypeDef", - "nextToken": str, + "s3preSignedUrl": str, + "s3UrlExpiryTimestamp": datetime, + "artifactType": ArtifactTypeTypeDef, + "artifactLabel": str, + "requestHeaders": Dict[str, List[str]], + "artifact": ArtifactTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class ListWorklogsRequestRequestTypeDef( - _RequiredListWorklogsRequestRequestTypeDef, _OptionalListWorklogsRequestRequestTypeDef -): - pass - -ListWorklogsResponseTypeDef = TypedDict( - "ListWorklogsResponseTypeDef", +GetArtifactMetadataResponseTypeDef = TypedDict( + "GetArtifactMetadataResponseTypeDef", { - "worklogs": List["WorklogTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "artifact": ArtifactTypeDef, + "isS3ObjectPresent": IsS3ObjectPresentTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -MetadataContextTypeDef = TypedDict( - "MetadataContextTypeDef", +ListArtifactsResponseTypeDef = TypedDict( + "ListArtifactsResponseTypeDef", { - "schemaVersion": str, - "content": Dict[str, Any], + "artifacts": List[ArtifactTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -MeteredAmountTypeDef = TypedDict( - "MeteredAmountTypeDef", +GetTemporaryCredentialsForConnectorResponseTypeDef = TypedDict( + "GetTemporaryCredentialsForConnectorResponseTypeDef", { - "amount": int, - "unit": Literal["COUNT"], + "temporaryCredentials": TemporaryCredentialsTypeDef, + "connectorConfiguration": Dict[str, str], + "targetRegion": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -MeteringAttributeTypeDef = TypedDict( - "MeteringAttributeTypeDef", +GetTemporaryCredentialsForRoleResponseTypeDef = TypedDict( + "GetTemporaryCredentialsForRoleResponseTypeDef", { - "name": str, - "value": str, + "temporaryCredentials": TemporaryCredentialsTypeDef, + "roleArn": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -MeteringUsageTypeDef = TypedDict( - "MeteringUsageTypeDef", +GetHitlTaskResponseTypeDef = TypedDict( + "GetHitlTaskResponseTypeDef", { - "resourceType": ResourceTypeType, - "amount": float, - "unit": Literal["COUNT"], - "limits": "LimitDefinitionTypeDef", + "hitlTask": HitlTaskTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, ) - -PaginatorConfigTypeDef = TypedDict( - "PaginatorConfigTypeDef", +ListHitlTasksResponseTypeDef = TypedDict( + "ListHitlTasksResponseTypeDef", { - "MaxItems": int, - "PageSize": int, - "StartingToken": str, + "hitlTasks": List[HitlTaskTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -PlanStepMappingTypeDef = TypedDict( - "PlanStepMappingTypeDef", +StepIdFilterTypeDef = TypedDict( + "StepIdFilterTypeDef", { - "stepLabel": str, "stepId": str, + "timeFilter": NotRequired[TimeFilterTypeDef], }, ) - -_RequiredPlanStepUpdateTypeDef = TypedDict( - "_RequiredPlanStepUpdateTypeDef", +UmrResourceUnionTypeDef = Union[UmrResourceTypeDef, UmrResourceOutputTypeDef] +WorklogUnionTypeDef = Union[WorklogTypeDef, WorklogOutputTypeDef] +ChunkingConfigurationTypeDef = TypedDict( + "ChunkingConfigurationTypeDef", { - "stepId": str, + "chunkingStrategy": ChunkingStrategyType, + "fixedSizeChunkingConfiguration": NotRequired[FixedSizeChunkingConfigurationTypeDef], + "hierarchicalChunkingConfiguration": NotRequired[HierarchicalChunkingConfigurationTypeDef], + "semanticChunkingConfiguration": NotRequired[SemanticChunkingConfigurationTypeDef], }, ) -_OptionalPlanStepUpdateTypeDef = TypedDict( - "_OptionalPlanStepUpdateTypeDef", +IngestionTypeDef = TypedDict( + "IngestionTypeDef", { - "startTime": Union[datetime, str], - "endTime": Union[datetime, str], - "status": PlanStepStatusType, - "description": str, + "ingestionId": str, + "status": IngestionStatusType, + "ingestionScopeMetadata": IngestionScopeMetadataTypeDef, + "createdAt": NotRequired[datetime], + "updatedAt": NotRequired[datetime], + "failureReason": NotRequired[str], }, - total=False, ) - -class PlanStepUpdateTypeDef(_RequiredPlanStepUpdateTypeDef, _OptionalPlanStepUpdateTypeDef): - pass - -PreProdTestOperationRequestRequestTypeDef = TypedDict( - "PreProdTestOperationRequestRequestTypeDef", +AcknowledgeDeletionRequestRequestTypeDef = TypedDict( + "AcknowledgeDeletionRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "deletionAcknowledgementToken": str, }, ) - -_RequiredPublishMeteringEventRequestRequestTypeDef = TypedDict( - "_RequiredPublishMeteringEventRequestRequestTypeDef", +CloseHitlTaskRequestRequestTypeDef = TypedDict( + "CloseHitlTaskRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "entity": "EntityTypeDef", - "resourceType": ResourceTypeType, - "resourceId": str, - "startTime": Union[datetime, str], + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, + "closureType": NotRequired[ClosureTypeType], + "idempotencyToken": NotRequired[str], }, ) -_OptionalPublishMeteringEventRequestRequestTypeDef = TypedDict( - "_OptionalPublishMeteringEventRequestRequestTypeDef", +CompleteArtifactUploadRequestRequestTypeDef = TypedDict( + "CompleteArtifactUploadRequestRequestTypeDef", { - "amount": "MeteredAmountTypeDef", - "idempotencyToken": str, - "attributes": List["MeteringAttributeTypeDef"], + "requestContext": RequestContextTypeDef, + "artifactId": str, }, - total=False, ) - -class PublishMeteringEventRequestRequestTypeDef( - _RequiredPublishMeteringEventRequestRequestTypeDef, - _OptionalPublishMeteringEventRequestRequestTypeDef, -): - pass - -PutJobPlanModeTypeDef = TypedDict( - "PutJobPlanModeTypeDef", +CopyArtifactRequestRequestTypeDef = TypedDict( + "CopyArtifactRequestRequestTypeDef", { - "override": Dict[str, Any], - "append": "AppendModeTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, + "idempotencyToken": NotRequired[str], }, - total=False, ) - -_RequiredPutJobPlanRequestRequestTypeDef = TypedDict( - "_RequiredPutJobPlanRequestRequestTypeDef", +CreateArtifactDownloadUrlRequestRequestTypeDef = TypedDict( + "CreateArtifactDownloadUrlRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "plan": "JobPlanTreeTypeDef", - "mode": "PutJobPlanModeTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, + "visibility": NotRequired[VisibilityType], }, ) -_OptionalPutJobPlanRequestRequestTypeDef = TypedDict( - "_OptionalPutJobPlanRequestRequestTypeDef", +CreateArtifactUploadUrlRequestRequestTypeDef = TypedDict( + "CreateArtifactUploadUrlRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "contentDigest": ContentDigestTypeDef, + "artifactReference": ArtifactReferenceTypeDef, + "label": NotRequired[str], + "planStepId": NotRequired[str], + "visibility": NotRequired[VisibilityType], + "fileMetadata": NotRequired[FileMetadataTypeDef], }, - total=False, ) - -class PutJobPlanRequestRequestTypeDef( - _RequiredPutJobPlanRequestRequestTypeDef, _OptionalPutJobPlanRequestRequestTypeDef -): - pass - -PutJobPlanResponseTypeDef = TypedDict( - "PutJobPlanResponseTypeDef", +CreateHitlTaskRequestRequestTypeDef = TypedDict( + "CreateHitlTaskRequestRequestTypeDef", { - "status": PutJobPlanStatusType, - "mappings": List["PlanStepMappingTypeDef"], - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "uxComponentId": str, + "description": str, + "title": str, + "severity": NotRequired[SeverityType], + "hitlTaskType": NotRequired[HitlTaskTypeType], + "stepId": NotRequired[str], + "blockingType": NotRequired[BlockingTypeType], + "hitlRequestArtifact": NotRequired[HitlTaskArtifactTypeDef], + "expiredAt": NotRequired[TimestampTypeDef], + "tag": NotRequired[str], + "idempotencyToken": NotRequired[str], + "category": NotRequired[CategoryType], + }, +) +CreateSkillDownloadUrlRequestRequestTypeDef = TypedDict( + "CreateSkillDownloadUrlRequestRequestTypeDef", + { + "requestContext": RequestContextTypeDef, + "skillName": str, + "idempotencyToken": NotRequired[str], + "version": NotRequired[str], }, ) - -RefreshAuthTokenRequestRequestTypeDef = TypedDict( - "RefreshAuthTokenRequestRequestTypeDef", +CreateWorklogRequestRequestTypeDef = TypedDict( + "CreateWorklogRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "sessionDuration": int, + "requestContext": RequestContextTypeDef, + "worklog": WorklogTypeDef, + "idempotencyToken": NotRequired[str], }, ) - -RefreshAuthTokenResponseTypeDef = TypedDict( - "RefreshAuthTokenResponseTypeDef", +DeleteJobPlanStepRequestRequestTypeDef = TypedDict( + "DeleteJobPlanStepRequestRequestTypeDef", { - "authorizationToken": str, - "authorizationExpiration": datetime, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "stepId": str, + "idempotencyToken": NotRequired[str], }, ) - -_RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "_RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef", +DeregisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( + "DeregisterKnowledgeBaseDocumentRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, "artifactId": str, "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], }, ) -_OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( - "_OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef", - { - "indexingMetadata": Dict[str, str], - }, - total=False, -) - -class RegisterKnowledgeBaseDocumentRequestRequestTypeDef( - _RequiredRegisterKnowledgeBaseDocumentRequestRequestTypeDef, - _OptionalRegisterKnowledgeBaseDocumentRequestRequestTypeDef, -): - pass - -RequestContextTypeDef = TypedDict( - "RequestContextTypeDef", +GetAgentInstanceRequestRequestTypeDef = TypedDict( + "GetAgentInstanceRequestRequestTypeDef", { - "jobMetadata": "JobMetadataTypeDef", + "requestContext": RequestContextTypeDef, "agentInstanceId": str, - "authorizationToken": str, }, ) - -ResponseMetadataTypeDef = TypedDict( - "ResponseMetadataTypeDef", +GetAgentVersionRequestRequestTypeDef = TypedDict( + "GetAgentVersionRequestRequestTypeDef", { - "RequestId": str, - "HostId": str, - "HTTPStatusCode": int, - "HTTPHeaders": Dict[str, Any], - "RetryAttempts": int, + "requestContext": RequestContextTypeDef, + "name": str, + "version": NotRequired[str], }, ) - -RetrievalConfigurationTypeDef = TypedDict( - "RetrievalConfigurationTypeDef", +GetArtifactMetadataRequestRequestTypeDef = TypedDict( + "GetArtifactMetadataRequestRequestTypeDef", { - "vectorSearchConfiguration": "VectorSearchConfigurationTypeDef", + "requestContext": RequestContextTypeDef, + "artifactId": str, }, ) - -RetrievalFilterTypeDef = TypedDict( - "RetrievalFilterTypeDef", +GetConnectorRequestRequestTypeDef = TypedDict( + "GetConnectorRequestRequestTypeDef", { - "equals": "FilterAttributeTypeDef", - "notEquals": "FilterAttributeTypeDef", - "greaterThan": "FilterAttributeTypeDef", - "greaterThanOrEquals": "FilterAttributeTypeDef", - "lessThan": "FilterAttributeTypeDef", - "lessThanOrEquals": "FilterAttributeTypeDef", - "in": "FilterAttributeTypeDef", - "notIn": "FilterAttributeTypeDef", - "startsWith": "FilterAttributeTypeDef", - "listContains": "FilterAttributeTypeDef", - "stringContains": "FilterAttributeTypeDef", - "andAll": List[Dict[str, Any]], - "orAll": List[Dict[str, Any]], - }, - total=False, + "requestContext": RequestContextTypeDef, + "connectorId": str, + }, ) - -RetrievalQueryTypeDef = TypedDict( - "RetrievalQueryTypeDef", +GetHitlTaskRequestRequestTypeDef = TypedDict( + "GetHitlTaskRequestRequestTypeDef", { - "text": str, + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, }, ) - -RetrievalResultContentTypeDef = TypedDict( - "RetrievalResultContentTypeDef", +GetJobRequestRequestTypeDef = TypedDict( + "GetJobRequestRequestTypeDef", { - "text": str, + "requestContext": RequestContextTypeDef, + "includeObjective": NotRequired[bool], }, - total=False, ) - -_RequiredRetrievalResultLocationTypeDef = TypedDict( - "_RequiredRetrievalResultLocationTypeDef", +GetKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( + "GetKnowledgeBaseIngestionRequestRequestTypeDef", { - "type": RetrievalResultLocationTypeType, + "requestContext": RequestContextTypeDef, + "ingestionId": str, }, ) -_OptionalRetrievalResultLocationTypeDef = TypedDict( - "_OptionalRetrievalResultLocationTypeDef", +GetTaskRequestRequestTypeDef = TypedDict( + "GetTaskRequestRequestTypeDef", { - "s3Location": "RetrievalResultS3LocationTypeDef", - "webLocation": "RetrievalResultWebLocationTypeDef", + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "params": NotRequired[Mapping[str, Any]], }, - total=False, ) - -class RetrievalResultLocationTypeDef( - _RequiredRetrievalResultLocationTypeDef, _OptionalRetrievalResultLocationTypeDef -): - pass - -RetrievalResultS3LocationTypeDef = TypedDict( - "RetrievalResultS3LocationTypeDef", +GetTemporaryCredentialsForConnectorRequestRequestTypeDef = TypedDict( + "GetTemporaryCredentialsForConnectorRequestRequestTypeDef", { - "uri": str, + "requestContext": RequestContextTypeDef, + "connectorId": str, + "targetRegion": NotRequired[str], }, - total=False, ) - -_RequiredRetrievalResultTypeDef = TypedDict( - "_RequiredRetrievalResultTypeDef", +GetTemporaryCredentialsForRoleRequestRequestTypeDef = TypedDict( + "GetTemporaryCredentialsForRoleRequestRequestTypeDef", { - "content": "RetrievalResultContentTypeDef", + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, }, ) -_OptionalRetrievalResultTypeDef = TypedDict( - "_OptionalRetrievalResultTypeDef", +GetUMRRequestRequestTypeDef = TypedDict( + "GetUMRRequestRequestTypeDef", { - "location": "RetrievalResultLocationTypeDef", - "score": float, - "metadata": Dict[str, Dict[str, Any]], + "requestContext": RequestContextTypeDef, }, - total=False, ) - -class RetrievalResultTypeDef(_RequiredRetrievalResultTypeDef, _OptionalRetrievalResultTypeDef): - pass - -RetrievalResultWebLocationTypeDef = TypedDict( - "RetrievalResultWebLocationTypeDef", +GetUsageRequestRequestTypeDef = TypedDict( + "GetUsageRequestRequestTypeDef", { - "url": str, + "requestContext": RequestContextTypeDef, + "resourceTypes": Sequence[ResourceTypeType], }, - total=False, ) - -_RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( - "_RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef", +InvokeAgentRequestRequestTypeDef = TypedDict( + "InvokeAgentRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "retrievalQuery": "RetrievalQueryTypeDef", - "retrievalScope": RetrievalScopeType, + "requestContext": RequestContextTypeDef, + "agentId": str, + "inputPayload": NotRequired[AgentInputPayloadTypeDef], + "idempotencyToken": NotRequired[str], + "agentVersion": NotRequired[str], + "agentInstanceId": NotRequired[str], + "agentType": NotRequired[AgentTypeType], }, ) -_OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( - "_OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef", +ListAgentInstancesRequestListAgentInstancesPaginateTypeDef = TypedDict( + "ListAgentInstancesRequestListAgentInstancesPaginateTypeDef", { - "retrievalConfiguration": "RetrievalConfigurationTypeDef", - "nextToken": str, + "requestContext": RequestContextTypeDef, + "agentFilter": NotRequired[ListAgentFilterTypeDef], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, - total=False, ) - -class RetrieveFromKnowledgeBaseRequestRequestTypeDef( - _RequiredRetrieveFromKnowledgeBaseRequestRequestTypeDef, - _OptionalRetrieveFromKnowledgeBaseRequestRequestTypeDef, -): - pass - -RetrieveFromKnowledgeBaseResponseTypeDef = TypedDict( - "RetrieveFromKnowledgeBaseResponseTypeDef", +ListAgentInstancesRequestRequestTypeDef = TypedDict( + "ListAgentInstancesRequestRequestTypeDef", { - "retrievalResults": List["RetrievalResultTypeDef"], - "nextToken": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "nextToken": NotRequired[str], + "agentFilter": NotRequired[ListAgentFilterTypeDef], + "maxResults": NotRequired[int], }, ) - -RollbackMeteringEventRequestRequestTypeDef = TypedDict( - "RollbackMeteringEventRequestRequestTypeDef", +ListAgentsRequestRequestTypeDef = TypedDict( + "ListAgentsRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "entity": "EntityTypeDef", - "resourceType": ResourceTypeType, - "resourceId": str, - "amendTime": Union[datetime, str], + "requestContext": RequestContextTypeDef, + "agentFilter": NotRequired[ListAgentsFilterTypeDef], + "nextToken": NotRequired[str], + "maxResults": NotRequired[int], }, ) - -SemanticChunkingConfigurationTypeDef = TypedDict( - "SemanticChunkingConfigurationTypeDef", +ListArtifactsRequestListArtifactsPaginateTypeDef = TypedDict( + "ListArtifactsRequestListArtifactsPaginateTypeDef", { - "breakpointPercentileThreshold": int, - "bufferSize": int, - "maxTokens": int, + "requestContext": RequestContextTypeDef, + "artifactFilter": NotRequired[ArtifactFilterTypeDef], + "pathPrefix": NotRequired[str], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, ) - -_RequiredSendMessageRequestRequestTypeDef = TypedDict( - "_RequiredSendMessageRequestRequestTypeDef", +ListArtifactsRequestRequestTypeDef = TypedDict( + "ListArtifactsRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, + "requestContext": RequestContextTypeDef, + "artifactFilter": NotRequired[ArtifactFilterTypeDef], + "nextToken": NotRequired[str], + "pathPrefix": NotRequired[str], + "maxResults": NotRequired[int], }, ) -_OptionalSendMessageRequestRequestTypeDef = TypedDict( - "_OptionalSendMessageRequestRequestTypeDef", +ListConnectorsRequestRequestTypeDef = TypedDict( + "ListConnectorsRequestRequestTypeDef", { - "params": Dict[str, Any], + "requestContext": RequestContextTypeDef, + "maxResults": NotRequired[int], + "nextToken": NotRequired[str], }, - total=False, ) - -class SendMessageRequestRequestTypeDef( - _RequiredSendMessageRequestRequestTypeDef, _OptionalSendMessageRequestRequestTypeDef -): - pass - -SendMessageResponseTypeDef = TypedDict( - "SendMessageResponseTypeDef", +ListHitlTasksRequestListHitlTasksPaginateTypeDef = TypedDict( + "ListHitlTasksRequestListHitlTasksPaginateTypeDef", { - "result": Dict[str, Any], - "error": Dict[str, Any], - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "taskType": HitlTaskTypeType, + "taskFilter": NotRequired[HitlTaskFilterTypeDef], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, ) - -_RequiredStartHitlTaskRequestRequestTypeDef = TypedDict( - "_RequiredStartHitlTaskRequestRequestTypeDef", +ListHitlTasksRequestRequestTypeDef = TypedDict( + "ListHitlTasksRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "hitlTaskId": str, + "requestContext": RequestContextTypeDef, + "taskType": HitlTaskTypeType, + "taskFilter": NotRequired[HitlTaskFilterTypeDef], + "nextToken": NotRequired[str], + "maxResults": NotRequired[int], }, ) -_OptionalStartHitlTaskRequestRequestTypeDef = TypedDict( - "_OptionalStartHitlTaskRequestRequestTypeDef", +ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef = TypedDict( + "ListJobPlanStepsRequestListJobPlanStepsPaginateTypeDef", { - "firstInChain": bool, - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "parentStepId": NotRequired[str], + "PaginationConfig": NotRequired[PaginatorConfigTypeDef], }, - total=False, ) - -class StartHitlTaskRequestRequestTypeDef( - _RequiredStartHitlTaskRequestRequestTypeDef, _OptionalStartHitlTaskRequestRequestTypeDef -): - pass - -StartHitlTaskResponseTypeDef = TypedDict( - "StartHitlTaskResponseTypeDef", +ListJobPlanStepsRequestRequestTypeDef = TypedDict( + "ListJobPlanStepsRequestRequestTypeDef", { - "hitlTaskStatus": HitlTaskStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "parentStepId": NotRequired[str], + "maxResults": NotRequired[int], + "nextToken": NotRequired[str], }, ) - -_RequiredStartJobRequestRequestTypeDef = TypedDict( - "_RequiredStartJobRequestRequestTypeDef", +PublishMeteringEventRequestRequestTypeDef = TypedDict( + "PublishMeteringEventRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "entity": EntityTypeDef, + "resourceType": ResourceTypeType, + "resourceId": str, + "startTime": TimestampTypeDef, + "amount": NotRequired[MeteredAmountTypeDef], + "idempotencyToken": NotRequired[str], + "attributes": NotRequired[Sequence[MeteringAttributeTypeDef]], }, ) -_OptionalStartJobRequestRequestTypeDef = TypedDict( - "_OptionalStartJobRequestRequestTypeDef", +PutAgreementRequestRequestTypeDef = TypedDict( + "PutAgreementRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "agreementId": str, + "agreementStatus": UmrAgreementStatusType, + "agreementType": NotRequired[UmrIncentiveTypeType], + "executedTimestamp": NotRequired[TimestampTypeDef], + "amendmentVersion": NotRequired[int], + "agreementUrl": NotRequired[str], + "signedBy": NotRequired[str], + "awsSignatory": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class StartJobRequestRequestTypeDef( - _RequiredStartJobRequestRequestTypeDef, _OptionalStartJobRequestRequestTypeDef -): - pass - -StartJobResponseTypeDef = TypedDict( - "StartJobResponseTypeDef", +PutEligibilityRequestRequestTypeDef = TypedDict( + "PutEligibilityRequestRequestTypeDef", { - "status": JobStatusType, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "outcome": UmrEligibilityOutcomeType, + "assessmentDate": TimestampTypeDef, + "assessmentScore": NotRequired[int], + "riskLevel": NotRequired[UmrRiskLevelType], + "qualificationCriteria": NotRequired[Mapping[str, bool]], + "idempotencyToken": NotRequired[str], }, ) - -_RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "_RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef", +PutJobPlanRequestRequestTypeDef = TypedDict( + "PutJobPlanRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", - "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], - "ingestionScopeMetadata": "IngestionScopeMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "plan": JobPlanTreeTypeDef, + "mode": PutJobPlanModeTypeDef, + "idempotencyToken": NotRequired[str], }, ) -_OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( - "_OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef", +PutMigrationPlanRequestRequestTypeDef = TypedDict( + "PutMigrationPlanRequestRequestTypeDef", { - "ingestionConfiguration": "IngestionConfigurationTypeDef", + "requestContext": RequestContextTypeDef, + "incentiveType": UmrIncentiveTypeType, + "startDate": TimestampTypeDef, + "endDate": TimestampTypeDef, + "creditCap": float, + "creditPercentage": NotRequired[float], + "linkedAccountDisbursement": NotRequired[bool], + "baselineSpend": NotRequired[Mapping[str, float]], + "programFlags": NotRequired[Mapping[str, bool]], + "partnerSpmsId": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class StartKnowledgeBaseIngestionRequestRequestTypeDef( - _RequiredStartKnowledgeBaseIngestionRequestRequestTypeDef, - _OptionalStartKnowledgeBaseIngestionRequestRequestTypeDef, -): - pass - -StartKnowledgeBaseIngestionResponseTypeDef = TypedDict( - "StartKnowledgeBaseIngestionResponseTypeDef", +RefreshAuthTokenRequestRequestTypeDef = TypedDict( + "RefreshAuthTokenRequestRequestTypeDef", { - "ingestionId": str, - "ResponseMetadata": "ResponseMetadataTypeDef", + "requestContext": RequestContextTypeDef, + "sessionDuration": int, }, ) - -_RequiredStatusDetailsTypeDef = TypedDict( - "_RequiredStatusDetailsTypeDef", +RegisterKnowledgeBaseDocumentRequestRequestTypeDef = TypedDict( + "RegisterKnowledgeBaseDocumentRequestRequestTypeDef", { - "status": JobStatusType, + "requestContext": RequestContextTypeDef, + "artifactId": str, + "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "indexingMetadata": NotRequired[Mapping[str, str]], }, ) -_OptionalStatusDetailsTypeDef = TypedDict( - "_OptionalStatusDetailsTypeDef", +RestoreAgentRequestRequestTypeDef = TypedDict( + "RestoreAgentRequestRequestTypeDef", { - "failureReason": str, + "requestContext": RequestContextTypeDef, + "agentId": str, + "agentInstanceId": str, + "agentType": AgentTypeType, + "agentVersion": NotRequired[str], + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class StatusDetailsTypeDef(_RequiredStatusDetailsTypeDef, _OptionalStatusDetailsTypeDef): - pass - -_RequiredStatusInfoTypeDef = TypedDict( - "_RequiredStatusInfoTypeDef", +RollbackMeteringEventRequestRequestTypeDef = TypedDict( + "RollbackMeteringEventRequestRequestTypeDef", { - "status": JobStatusType, + "requestContext": RequestContextTypeDef, + "entity": EntityTypeDef, + "resourceType": ResourceTypeType, + "resourceId": str, + "amendTime": TimestampTypeDef, }, ) -_OptionalStatusInfoTypeDef = TypedDict( - "_OptionalStatusInfoTypeDef", +SendMessageRequestRequestTypeDef = TypedDict( + "SendMessageRequestRequestTypeDef", { - "failureCategory": FailureCategoryType, - "failureType": str, + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "params": NotRequired[Mapping[str, Any]], }, - total=False, ) - -class StatusInfoTypeDef(_RequiredStatusInfoTypeDef, _OptionalStatusInfoTypeDef): - pass - -_RequiredStepIdFilterTypeDef = TypedDict( - "_RequiredStepIdFilterTypeDef", +StartHitlTaskRequestRequestTypeDef = TypedDict( + "StartHitlTaskRequestRequestTypeDef", { - "stepId": str, + "requestContext": RequestContextTypeDef, + "hitlTaskId": str, + "firstInChain": NotRequired[bool], + "idempotencyToken": NotRequired[str], }, ) -_OptionalStepIdFilterTypeDef = TypedDict( - "_OptionalStepIdFilterTypeDef", +StopAgentRequestRequestTypeDef = TypedDict( + "StopAgentRequestRequestTypeDef", { - "timeFilter": "TimeFilterTypeDef", + "requestContext": RequestContextTypeDef, + "agentInstanceId": str, + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class StepIdFilterTypeDef(_RequiredStepIdFilterTypeDef, _OptionalStepIdFilterTypeDef): - pass - -_RequiredStopAgentRequestRequestTypeDef = TypedDict( - "_RequiredStopAgentRequestRequestTypeDef", +UpdateAgentInstanceRequestRequestTypeDef = TypedDict( + "UpdateAgentInstanceRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, "agentInstanceId": str, + "agentInstanceStatus": UpdateAgentInstanceStatusType, + "agentInstanceStatusReason": NotRequired[str], + "agentOutput": NotRequired[AgentOutputPayloadTypeDef], }, ) -_OptionalStopAgentRequestRequestTypeDef = TypedDict( - "_OptionalStopAgentRequestRequestTypeDef", +UpdateJobPlanStepRequestRequestTypeDef = TypedDict( + "UpdateJobPlanStepRequestRequestTypeDef", { - "idempotencyToken": str, + "requestContext": RequestContextTypeDef, + "planStep": PlanStepUpdateTypeDef, + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class StopAgentRequestRequestTypeDef( - _RequiredStopAgentRequestRequestTypeDef, _OptionalStopAgentRequestRequestTypeDef -): - pass - -TemporaryCredentialsTypeDef = TypedDict( - "TemporaryCredentialsTypeDef", +UpdateJobStatusRequestRequestTypeDef = TypedDict( + "UpdateJobStatusRequestRequestTypeDef", { - "awsTemporaryCredentials": "AwsTemporaryCredentialsTypeDef", + "requestContext": RequestContextTypeDef, + "status": NotRequired[JobStatusType], + "statusInfo": NotRequired[StatusInfoTypeDef], + "idempotencyToken": NotRequired[str], + "notificationArtifactId": NotRequired[str], }, - total=False, ) - -TestOperationRequestRequestTypeDef = TypedDict( - "TestOperationRequestRequestTypeDef", +UpdateUMRStatusRequestRequestTypeDef = TypedDict( + "UpdateUMRStatusRequestRequestTypeDef", { - "requestContext": "RequestContextTypeDef", + "requestContext": RequestContextTypeDef, + "status": UmrStatusType, + "idempotencyToken": NotRequired[str], }, ) - -TimeFilterTypeDef = TypedDict( - "TimeFilterTypeDef", +GetJobResponseTypeDef = TypedDict( + "GetJobResponseTypeDef", { - "startTime": Union[datetime, str], - "endTime": Union[datetime, str], + "job": JobInfoTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredUpdateAgentInstanceRequestRequestTypeDef = TypedDict( - "_RequiredUpdateAgentInstanceRequestRequestTypeDef", +GetUsageResponseTypeDef = TypedDict( + "GetUsageResponseTypeDef", { - "requestContext": "RequestContextTypeDef", - "agentInstanceId": str, - "agentInstanceStatus": UpdateAgentInstanceStatusType, + "usageResults": List[MeteringUsageTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, ) -_OptionalUpdateAgentInstanceRequestRequestTypeDef = TypedDict( - "_OptionalUpdateAgentInstanceRequestRequestTypeDef", +RetrieveFromKnowledgeBaseRequestRequestTypeDef = TypedDict( + "RetrieveFromKnowledgeBaseRequestRequestTypeDef", { - "agentInstanceStatusReason": str, - "agentOutput": "AgentOutputPayloadTypeDef", + "requestContext": RequestContextTypeDef, + "retrievalQuery": RetrievalQueryTypeDef, + "retrievalScope": RetrievalScopeType, + "retrievalConfiguration": NotRequired[RetrievalConfigurationTypeDef], + "nextToken": NotRequired[str], }, - total=False, ) - -class UpdateAgentInstanceRequestRequestTypeDef( - _RequiredUpdateAgentInstanceRequestRequestTypeDef, - _OptionalUpdateAgentInstanceRequestRequestTypeDef, -): - pass - -_RequiredUpdateJobPlanStepRequestRequestTypeDef = TypedDict( - "_RequiredUpdateJobPlanStepRequestRequestTypeDef", +RetrievalResultTypeDef = TypedDict( + "RetrievalResultTypeDef", { - "requestContext": "RequestContextTypeDef", - "planStep": "PlanStepUpdateTypeDef", + "content": RetrievalResultContentTypeDef, + "location": NotRequired[RetrievalResultLocationTypeDef], + "score": NotRequired[float], + "metadata": NotRequired[Dict[str, Dict[str, Any]]], }, ) -_OptionalUpdateJobPlanStepRequestRequestTypeDef = TypedDict( - "_OptionalUpdateJobPlanStepRequestRequestTypeDef", +GetUMRResponseTypeDef = TypedDict( + "GetUMRResponseTypeDef", { - "idempotencyToken": str, + "customerAccountId": str, + "projectName": str, + "status": UmrStatusType, + "version": int, + "plan": UmrMigrationPlanTypeDef, + "eligibility": UmrEligibilityTypeDef, + "agreements": List[UmrAgreementTypeDef], + "partners": List[UmrPartnerDetailsTypeDef], + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -class UpdateJobPlanStepRequestRequestTypeDef( - _RequiredUpdateJobPlanStepRequestRequestTypeDef, _OptionalUpdateJobPlanStepRequestRequestTypeDef -): - pass - -_RequiredUpdateJobStatusRequestRequestTypeDef = TypedDict( - "_RequiredUpdateJobStatusRequestRequestTypeDef", +WorklogFilterTypeDef = TypedDict( + "WorklogFilterTypeDef", { - "requestContext": "RequestContextTypeDef", + "stepIdFilter": NotRequired[StepIdFilterTypeDef], + "timeFilter": NotRequired[TimeFilterTypeDef], }, ) -_OptionalUpdateJobStatusRequestRequestTypeDef = TypedDict( - "_OptionalUpdateJobStatusRequestRequestTypeDef", +PutPartnerDetailsRequestRequestTypeDef = TypedDict( + "PutPartnerDetailsRequestRequestTypeDef", { - "status": JobStatusType, - "statusInfo": "StatusInfoTypeDef", - "idempotencyToken": str, - "notificationArtifactId": str, + "requestContext": RequestContextTypeDef, + "partnerAccountId": str, + "partnerName": str, + "partnerType": NotRequired[UmrPartnerTypeType], + "migrationPhase": NotRequired[UmrMigrationPhaseType], + "prmId": NotRequired[str], + "workspaceId": NotRequired[str], + "resources": NotRequired[Sequence[UmrResourceUnionTypeDef]], + "idempotencyToken": NotRequired[str], }, - total=False, ) - -class UpdateJobStatusRequestRequestTypeDef( - _RequiredUpdateJobStatusRequestRequestTypeDef, _OptionalUpdateJobStatusRequestRequestTypeDef -): - pass - VectorIngestionConfigurationTypeDef = TypedDict( "VectorIngestionConfigurationTypeDef", { - "chunkingConfiguration": "ChunkingConfigurationTypeDef", + "chunkingConfiguration": NotRequired[ChunkingConfigurationTypeDef], }, - total=False, ) - -VectorSearchConfigurationTypeDef = TypedDict( - "VectorSearchConfigurationTypeDef", +GetKnowledgeBaseIngestionResponseTypeDef = TypedDict( + "GetKnowledgeBaseIngestionResponseTypeDef", { - "numberOfResults": int, - "filter": "RetrievalFilterTypeDef", + "ingestion": IngestionTypeDef, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -WorklogFilterTypeDef = TypedDict( - "WorklogFilterTypeDef", +RetrieveFromKnowledgeBaseResponseTypeDef = TypedDict( + "RetrieveFromKnowledgeBaseResponseTypeDef", { - "stepIdFilter": "StepIdFilterTypeDef", - "timeFilter": "TimeFilterTypeDef", + "retrievalResults": List[RetrievalResultTypeDef], + "nextToken": str, + "ResponseMetadata": ResponseMetadataTypeDef, }, - total=False, ) - -_RequiredWorklogTypeDef = TypedDict( - "_RequiredWorklogTypeDef", +ListWorklogsRequestRequestTypeDef = TypedDict( + "ListWorklogsRequestRequestTypeDef", { - "timestamp": Union[datetime, str], - "attributeMap": Dict[str, str], + "requestContext": RequestContextTypeDef, + "worklogFilter": NotRequired[WorklogFilterTypeDef], + "nextToken": NotRequired[str], + }, +) +IngestionConfigurationTypeDef = TypedDict( + "IngestionConfigurationTypeDef", + { + "vectorIngestionConfiguration": NotRequired[VectorIngestionConfigurationTypeDef], }, ) -_OptionalWorklogTypeDef = TypedDict( - "_OptionalWorklogTypeDef", +StartKnowledgeBaseIngestionRequestRequestTypeDef = TypedDict( + "StartKnowledgeBaseIngestionRequestRequestTypeDef", { - "description": str, + "requestContext": RequestContextTypeDef, + "knowledgeBaseConfigType": Literal["TEXT_TITAN_CONFIG"], + "ingestionScopeMetadata": IngestionScopeMetadataTypeDef, + "ingestionConfiguration": NotRequired[IngestionConfigurationTypeDef], }, - total=False, ) - -class WorklogTypeDef(_RequiredWorklogTypeDef, _OptionalWorklogTypeDef): - pass