moto API reference

400 public APIs from moto (getmoto/moto) — 193 classes, 58 functions, 149 methods. Signatures extracted by static analysis of the actual source.

Repository: getmoto/moto

Kind	Count
Classes	193
Functions	58
Methods	149

API list

classmoto.acmpca.models.ACMPCABackend

Implementation of ACMPCA APIs.

methodmoto.acmpca.models.ACMPCABackend.delete_policy(resource_arn:str) -> None

Deletes the resource-based policy attached to a private CA.

methodmoto.acmpca.models.ACMPCABackend.get_policy(resource_arn:str) -> str

Retrieves the resource-based policy attached to a private CA.

methodmoto.acmpca.models.ACMPCABackend.list_tags(certificate_authority_arn:str) -> dict[str, list[dict[str, str]]]

Pagination is not yet implemented

methodmoto.acmpca.models.ACMPCABackend.put_policy(resource_arn:str, policy:str) -> None

Attaches a resource-based policy to a private CA.

classmoto.acmpca.responses.ACMPCAResponse

Handler for ACMPCA requests and responses.

methodmoto.acmpca.responses.ACMPCAResponse.acmpca_backend() -> ACMPCABackend

Return backend instance specific for this region.

methodmoto.acmpca.responses.ACMPCAResponse.list_certificate_authorities() -> str

Handler for ListCertificateAuthorities API request

classmoto.amp.models.PrometheusServiceBackend

Implementation of PrometheusService APIs.

methodmoto.amp.models.PrometheusServiceBackend.create_workspace(alias:str, tags:dict[str, str]) -> Workspace

The ClientToken-parameter is not yet implemented

methodmoto.amp.models.PrometheusServiceBackend.delete_rule_groups_namespace(name:str, workspace_id:str) -> None

The ClientToken-parameter is not yet implemented

methodmoto.amp.models.PrometheusServiceBackend.delete_workspace(workspace_id:str) -> None

The ClientToken-parameter is not yet implemented

method

moto.amp.models.PrometheusServiceBackend.put_rule_groups_namespace(data:str, name:str, workspace_id:str) -> RuleGroupNamespace

The ClientToken-parameter is not yet implemented

methodmoto.amp.models.PrometheusServiceBackend.update_workspace_alias(alias:str, workspace_id:str) -> None

The ClientToken-parameter is not yet implemented

classmoto.amp.responses.PrometheusServiceResponse

Handler for PrometheusService requests and responses.

classmoto.apigateway.models.APIGatewayBackend

API Gateway mock.

methodmoto.apigateway.models.APIGatewayBackend.export_api(rest_api_id:str, export_type:str) -> dict[str, Any]

Not all fields are implemented yet.

methodmoto.apigateway.models.APIGatewayBackend.get_gateway_responses(rest_api_id:str) -> list[GatewayResponse]

Pagination is not yet implemented

methodmoto.apigateway.models.APIGatewayBackend.get_vpc_links() -> list[VpcLink]

Pagination has not yet been implemented

classmoto.apigatewayv2.models.ApiGatewayV2Backend

Implementation of ApiGatewayV2 APIs.

methodmoto.apigatewayv2.models.ApiGatewayV2Backend.get_apis() -> list[Api]

Pagination is not yet implemented

methodmoto.apigatewayv2.models.ApiGatewayV2Backend.get_domain_names() -> list[DomainName]

Pagination is not yet implemented

methodmoto.apigatewayv2.models.ApiGatewayV2Backend.get_integrations(api_id:str) -> list[Integration]

Pagination is not yet implemented

methodmoto.apigatewayv2.models.ApiGatewayV2Backend.get_routes(api_id:str) -> list[Route]

Pagination is not yet implemented

methodmoto.apigatewayv2.models.ApiGatewayV2Backend.reimport_api(api_id:str, body:str, fail_on_warnings:bool) -> Api

Only YAML is supported at the moment.

classmoto.apigatewayv2.responses.ApiGatewayV2Response

Handler for ApiGatewayV2 requests and responses.

classmoto.appconfig.models.AppConfigBackend

Implementation of AppConfig APIs.

classmoto.appmesh.models.AppMeshBackend

Implementation of AppMesh APIs.

classmoto.appmesh.responses.AppMeshResponse

Handler for AppMesh requests and responses.

methodmoto.appmesh.responses.AppMeshResponse.appmesh_backend() -> AppMeshBackend

Return backend instance specific for this region.

classmoto.appsync.models.AppSyncBackend

Implementation of AppSync APIs.

classmoto.appsync.responses.AppSyncResponse

Handler for AppSync requests and responses.

methodmoto.appsync.responses.AppSyncResponse.appsync_backend() -> AppSyncBackend

Return backend instance specific for this region.

classmoto.awslambda.models.LambdaBackend

Implementation of the AWS Lambda endpoint.

methodmoto.awslambda.models.LambdaBackend.create_function(spec:dict[str, Any]) -> LambdaFunction

The Code.ImageUri is not validated by default.

method

moto.awslambda.models.LambdaBackend.create_function_url_config(name_or_arn:str, config:dict[str, Any]) -> FunctionUrlConfig

The Qualifier-parameter is not yet implemented.

methodmoto.awslambda.models.LambdaBackend.delete_function_url_config(name_or_arn:str) -> None

The Qualifier-parameter is not yet implemented

methodmoto.awslambda.models.LambdaBackend.get_function_url_config(name_or_arn:str) -> FunctionUrlConfig

The Qualifier-parameter is not yet implemented

method

moto.awslambda.models.LambdaBackend.update_alias(name:str, function_name:str, function_version:str, description:str, routing_config:str) -> LambdaAlias

The RevisionId parameter is not yet implemented

method

moto.awslambda.models.LambdaBackend.update_function_url_config(name_or_arn:str, config:dict[str, Any]) -> FunctionUrlConfig

The Qualifier-parameter is not yet implemented

classmoto.backup.models.BackupBackend

Implementation of Backup APIs.

methodmoto.backup.models.BackupBackend.list_backup_plans(include_deleted:Any) -> list[Plan]

Pagination is not yet implemented

methodmoto.backup.models.BackupBackend.list_backup_vaults() -> list[Vault]

Pagination is not yet implemented

methodmoto.backup.models.BackupBackend.list_report_plans() -> list[ReportPlan]

Pagination is not yet implemented

methodmoto.backup.models.BackupBackend.list_tags(resource_arn:str) -> dict[str, str]

Pagination is not yet implemented

classmoto.backup.responses.BackupResponse

Handler for Backup requests and responses.

methodmoto.backup.responses.BackupResponse.backup_backend() -> BackupBackend

Return backend instance specific for this region.

classmoto.batch.models.BatchBackend

Batch-jobs are executed inside a Docker-container.

methodmoto.batch.models.BatchBackend.describe_compute_environments(environments:list[str] | None=None) -> list[dict[str, Any]]

Pagination is not yet implemented

method

moto.batch.models.BatchBackend.describe_job_definitions(job_def_name:str | None=None, job_def_list:list[str] | None=None, status:str | None=None) -> list[JobDefinition]

Pagination is not yet implemented

methodmoto.batch.models.BatchBackend.describe_job_queues(job_queues:list[str] | None=None) -> list[dict[str, Any]]

Pagination is not yet implemented

methodmoto.batch.models.BatchBackend.ec2_backend() -> EC2Backend

:return: EC2 Backend :rtype: moto.ec2.models.EC2Backend

methodmoto.batch.models.BatchBackend.iam_backend() -> IAMBackend

:return: IAM Backend :rtype: moto.iam.models.IAMBackend

methodmoto.batch.models.BatchBackend.list_scheduling_policies() -> list[str]

Pagination is not yet implemented

methodmoto.batch.models.Job.run() -> None

Run the container.

classmoto.bedrock.models.BedrockBackend

Implementation of Bedrock APIs.

classmoto.bedrock.responses.BedrockResponse

Handler for Bedrock requests and responses.

methodmoto.bedrock.responses.BedrockResponse.bedrock_backend() -> BedrockBackend

Return backend instance specific for this region.

classmoto.bedrockagent.models.AgentsforBedrockBackend

Implementation of AgentsforBedrock APIs.

classmoto.bedrockagent.responses.AgentsforBedrockResponse

Handler for AgentsforBedrock requests and responses.

classmoto.bedrockruntime.models.BedrockRuntimeBackend

Implementation of BedrockRuntime APIs.

classmoto.bedrockruntime.responses.BedrockRuntimeResponse

Handler for BedrockRuntime requests and responses.

classmoto.budgets.models.BudgetsBackend

Implementation of Budgets APIs.

methodmoto.budgets.models.BudgetsBackend.describe_budgets(account_id:str) -> Iterable[dict[str, Any]]

Pagination is not yet implemented

method

moto.budgets.models.BudgetsBackend.describe_notifications_for_budget(account_id:str, budget_name:str) -> Iterable[dict[str, Any]]

Pagination has not yet been implemented

classmoto.ce.models.CostExplorerBackend

Implementation of CostExplorer APIs.

methodmoto.ce.models.CostExplorerBackend.delete_cost_category_definition(cost_category_arn:str) -> tuple[str, str]

The EffectiveOn-parameter is not yet implemented

methodmoto.ce.models.CostExplorerBackend.describe_cost_category_definition(cost_category_arn:str) -> CostCategoryDefinition

The EffectiveOn-parameter is not yet implemented

methodmoto.ce.models.CostExplorerBackend.get_cost_and_usage(body:str) -> dict[str, Any]

There is no validation yet on any of the input parameters.

classmoto.ce.responses.CostExplorerResponse

Handler for CostExplorer requests and responses.

methodmoto.ce.responses.CostExplorerResponse.ce_backend() -> CostExplorerBackend

Return backend instance specific for this region.

classmoto.clouddirectory.models.CloudDirectoryBackend

Implementation of CloudDirectory APIs.

classmoto.clouddirectory.responses.CloudDirectoryResponse

Handler for CloudDirectory requests and responses.

classmoto.cloudformation.parsing.ResourceMap

This is a lazy loading map for resources.

funcmoto.cloudformation.parsing.clean_json(resource_json:Any, resources_map:'ResourceMap') -> Any

Cleanup a resource dict.

funcmoto.cloudformation.utils.yaml_tag_constructor(loader:Any, tag:Any, node:Any) -> Any

convert shorthand intrinsic function to full name

classmoto.cloudhsmv2.exceptions.CloudHSMv2ClientError

Base class for CloudHSMv2 errors.

classmoto.cloudhsmv2.models.CloudHSMV2Backend

Implementation of CloudHSMV2 APIs.

method

moto.cloudhsmv2.models.CloudHSMV2Backend.list_tags(resource_id:str, next_token:str, max_results:int) -> tuple[list[dict[str, str]], str | None]

Pagination is not yet implemented

classmoto.cloudhsmv2.responses.CloudHSMV2Response

Handler for CloudHSMV2 requests and responses.

classmoto.cloudtrail.models.CloudTrailBackend

Implementation of CloudTrail APIs.

methodmoto.cloudtrail.models.CloudTrailBackend.list_tags(resource_id_list:list[str]) -> list[dict[str, Any]]

Pagination is not yet implemented

classmoto.cloudtrail.responses.CloudTrailResponse

Handler for CloudTrail requests and responses.

classmoto.codedeploy.models.CodeDeployBackend

Implementation of CodeDeploy APIs.

classmoto.codedeploy.responses.CodeDeployResponse

Handler for CodeDeploy requests and responses.

methodmoto.codedeploy.responses.CodeDeployResponse.list_tags_for_resource() -> str

Handler for list_tags_for_resource API call.

methodmoto.codedeploy.responses.CodeDeployResponse.tag_resource() -> str

Handler for tag_resource API call.

methodmoto.codedeploy.responses.CodeDeployResponse.untag_resource() -> str

Handler for untag_resource API call.

classmoto.cognitoidp.models.CognitoIdpBackend

Moto mocks the JWK uris.

classmoto.comprehend.models.ComprehendBackend

Implementation of Comprehend APIs.

methodmoto.comprehend.models.ComprehendBackend.list_entity_recognizers(_filter:dict[str, Any]) -> Iterable[EntityRecognizer]

Pagination is not yet implemented.

classmoto.comprehend.models.ComprehendJob

Generic model for any Comprehend asynchronous job.

classmoto.comprehend.responses.ComprehendResponse

Handler for Comprehend requests and responses.

classmoto.config.models.ConfigEmptyDictable

Base class to make serialization easy.

classmoto.config.models.Scope

Defines resources that can trigger an evaluation for the rule.

classmoto.config.models.Source

Defines rule owner, id and notification for triggering evaluation.

methodmoto.config.models.Source.to_dict() -> dict[str, Any]

Format the SourceDetails properly.

funcmoto.config.models.validate_tag_key(tag_key:str, exception_param:str='tags.X.member.key') -> None

Validates the tag key.

classmoto.connect.models.ConnectBackend

Backend for Amazon Connect API.

method

moto.connect.models.ConnectBackend.create_instance(identity_management_type:str, inbound_calls_enabled:bool, outbound_calls_enabled:bool, instance_alias:str | None=None, tags:dict[str, str] | None=None) -> dict[str, str]

Create a new Connect instance.

methodmoto.connect.models.ConnectBackend.describe_instance(instance_id:str) -> dict[str, Any]

Describe a Connect instance.

methodmoto.connect.models.Instance.to_dict() -> dict[str, Any]

Return full instance details for DescribeInstance.

methodmoto.connect.models.Instance.to_summary_dict() -> dict[str, Any]

Return summary for ListInstances.

classmoto.connect.responses.ConnectResponse

Handler for Connect requests and responses.

methodmoto.connect.responses.ConnectResponse.connect_backend() -> ConnectBackend

Return backend instance specific for this region.

classmoto.connectcampaigns.exceptions.ResourceNotFoundException

When a resource is not found.

classmoto.connectcampaigns.exceptions.ValidationException

When validation fails on input parameters.

funcmoto.core.authorization.disable_iam_authentication() -> Generator[None, None, None]

Inverse of enable().

methodmoto.core.base_backend.BaseBackend.url_bases() -> list[str]

A list containing the url_bases extracted from urls.py

classmoto.core.custom_responses_mock.CallbackResponse

Need to subclass so we can change a couple things

methodmoto.core.custom_responses_mock.CallbackResponse.get_response(request:Any) -> responses.HTTPResponse

Need to override this so we can pass decode_content=False

classmoto.core.eventstream.EncodeUtils

Packing utility functions used in the encoder.

classmoto.core.eventstream.EventStreamEncoder

Encodes Amazon event-stream binary messages.

classmoto.core.exceptions.InvalidNextTokenException

For AWS Config resource listing.

classmoto.core.exceptions.ServiceException

The base class for all (serializable) Moto service exceptions.

funcmoto.core.models.patch_client(client:botocore.client.BaseClient) -> None

Explicitly patch a boto3-client

funcmoto.core.models.patch_resource(resource:Any) -> None

Explicitly patch a boto3-resource

classmoto.core.parse.XFormedDict

A Pascal/Snake case-insensitive ``dict``-like object.

funcmoto.core.parse.default_timestamp_parser(value:str) -> datetime

Parse a timestamp and return a naive datetime object in UTC.

funcmoto.core.resource_tagging.match_resource_type(resource_type:str, resource_type_filters:list[str] | None) -> bool

Return True if `resource_type` (e.g.

classmoto.core.responses.ActionResult

Wrapper class for serializable results returned from `responses.py` methods.

classmoto.core.responses.EmptyResult

A special ActionResult that represents an empty result.

classmoto.core.serialize.AttributeAliasProvider

Abstract base class for providing attribute key aliases.

methodmoto.core.serialize.AttributeAliasProvider.get_alias(key:str) -> str

Get the key alias for the given context.

methodmoto.core.serialize.AttributeAliasProvider.has_alias(key:str) -> bool

Check if a key alias exists for the given context.

classmoto.core.serialize.NoAlias

Provides the key as is, without any aliasing.

classmoto.core.types.Base64EncodedString

A type to encapsulate a Base64 encoded string.

funcmoto.core.utils.aws_api_matches(pattern:str, string:Any) -> bool

AWS API can match a value based on a glob, or an exact match

funcmoto.core.utils.camelcase_to_pascal(argument:str) -> str

Converts a camelCase param to the PascalCase equivalent

funcmoto.core.utils.convert_regex_to_flask_path(url_path:str) -> str

Converts a regex matching url to one that can be used with flask

funcmoto.core.utils.get_value(obj:Any, key:int | str, default:Any=MISSING) -> Any

Helper for pulling a keyed value off various types of objects.

funcmoto.core.utils.pascal_to_camelcase(argument:str) -> str

Converts a PascalCase param to the camelCase equivalent

funcmoto.core.utils.set_value(obj:Any, key:str, value:Any) -> None

Helper for adding a keyed value to various types of objects.

classmoto.directconnect.models.DirectConnectBackend

Implementation of DirectConnect APIs.

classmoto.directconnect.responses.DirectConnectResponse

Handler for DirectConnect requests and responses.

classmoto.ds.exceptions.ClientException

Client exception has occurred.

classmoto.ds.exceptions.DirectoryLimitExceededException

Maximum number of directories in region has been reached.

classmoto.ds.exceptions.DsValidationException

Report one of more parameter validation errors.

classmoto.ds.exceptions.EntityAlreadyExistsException

The specified entity already exists.

classmoto.ds.exceptions.EntityDoesNotExistException

The specified entity could not be found.

classmoto.ds.exceptions.InvalidParameterException

Invalid parameter.

classmoto.ds.exceptions.TagLimitExceededException

The maximum allowed number of tags was exceeded.

classmoto.ds.exceptions.UnsupportedOperationException

Unsupported Operation

classmoto.ds.exceptions.ValidationException

Tag validation failed.

classmoto.ds.models.Directory

Representation of a Simple AD Directory.

methodmoto.ds.models.Directory.create_security_group(vpc_id:str) -> str

Create security group for the network interface.

methodmoto.ds.models.Directory.delete_eni() -> None

Delete ENI for each subnet and the security group.

methodmoto.ds.models.Directory.delete_security_group() -> None

Delete the given security group.

methodmoto.ds.models.Directory.disable_radius() -> None

Clear RADIUS settings and status.

methodmoto.ds.models.Directory.enable_ldaps(enable:bool) -> None

Enable/disable ldaps based on whether new_state is True or False.

methodmoto.ds.models.Directory.enable_radius(radius_settings:dict[str, Any]) -> None

Store RADIUS settings and mark as completed.

methodmoto.ds.models.Directory.enable_sso(new_state:bool) -> None

Enable/disable sso based on whether new_state is True or False.

methodmoto.ds.models.Directory.to_dict() -> dict[str, Any]

Create a dictionary of attributes for Directory.

methodmoto.ds.models.Directory.update_alias(alias:str) -> None

Change default alias to given alias.

classmoto.ds.models.DirectoryServiceBackend

Implementation of DirectoryService APIs.

method

moto.ds.models.DirectoryServiceBackend.connect_directory(region:str, name:str, short_name:str, password:str, description:str, size:str, connect_settings:dict[str, Any], tags:list[dict[str, str]]) -> str

Create a fake AD Connector.

methodmoto.ds.models.DirectoryServiceBackend.create_alias(directory_id:str, alias:str) -> dict[str, str]

Create and assign an alias to a directory.

method

moto.ds.models.DirectoryServiceBackend.create_directory(region:str, name:str, short_name:str, password:str, description:str, size:str, vpc_settings:dict[str, Any], tags:list[dict[str, str]]) -> str

Create a fake Simple Ad Directory.

methodmoto.ds.models.DirectoryServiceBackend.delete_directory(directory_id:str) -> str

Delete directory with the matching ID.

methodmoto.ds.models.DirectoryServiceBackend.describe_ldaps_settings(directory_id:str, type:str) -> list[LdapsSettingInfo]

Describe LDAPS settings for a Directory

methodmoto.ds.models.DirectoryServiceBackend.describe_settings(directory_id:str, status:str | None) -> list[dict[str, str]]

Describe settings for a Directory

methodmoto.ds.models.DirectoryServiceBackend.disable_ldaps(directory_id:str, type:str) -> None

Disable LDAPS for a Directory

methodmoto.ds.models.DirectoryServiceBackend.disable_radius(directory_id:str) -> None

Disable RADIUS for a directory.

method

moto.ds.models.DirectoryServiceBackend.disable_sso(directory_id:str, username:str | None=None, password:str | None=None) -> None

Disable single-sign on for a directory.

methodmoto.ds.models.DirectoryServiceBackend.enable_ldaps(directory_id:str, type:str) -> None

Enable LDAPS for a Directory

methodmoto.ds.models.DirectoryServiceBackend.enable_radius(directory_id:str, radius_settings:dict[str, Any]) -> None

Enable RADIUS for a directory.

method

moto.ds.models.DirectoryServiceBackend.enable_sso(directory_id:str, username:str | None=None, password:str | None=None) -> None

Enable single-sign on for a directory.

methodmoto.ds.models.DirectoryServiceBackend.get_directory_limits() -> dict[str, Any]

Return hard-coded limits for the directories.

methodmoto.ds.models.DirectoryServiceBackend.list_tags_for_resource(resource_id:str) -> list[dict[str, str]]

List all tags on a directory.

methodmoto.ds.models.DirectoryServiceBackend.remove_tags_from_resource(resource_id:str, tag_keys:list[str]) -> None

Removes tags from a directory.

classmoto.ds.responses.DirectoryServiceResponse

Handler for DirectoryService requests and responses.

methodmoto.ds.responses.DirectoryServiceResponse.create_alias() -> str

Create an alias and assign the alias to the directory.

methodmoto.ds.responses.DirectoryServiceResponse.create_directory() -> str

Create a Simple AD directory.

methodmoto.ds.responses.DirectoryServiceResponse.create_microsoft_ad() -> str

Create a Microsoft AD directory.

methodmoto.ds.responses.DirectoryServiceResponse.delete_directory() -> str

Delete a Directory Service directory.

methodmoto.ds.responses.DirectoryServiceResponse.describe_directories() -> str

Return directory info for the given IDs or all IDs.

methodmoto.ds.responses.DirectoryServiceResponse.disable_sso() -> str

Disable single-sign on for a directory.

methodmoto.ds.responses.DirectoryServiceResponse.enable_sso() -> str

Enable single-sign on for a directory.

methodmoto.ds.responses.DirectoryServiceResponse.list_tags_for_resource() -> str

Lists all tags on a directory.

methodmoto.ds.responses.DirectoryServiceResponse.remove_tags_from_resource() -> str

Removes tags from a directory.

funcmoto.ds.validations.validate_alias(value:str) -> str

Raise exception if alias fails to conform to length and constraints.

funcmoto.ds.validations.validate_args(validators:Any) -> None

Raise exception if any of the validations fails.

funcmoto.ds.validations.validate_description(value:str) -> str

Raise exception if description exceeds length.

funcmoto.ds.validations.validate_directory_id(value:str) -> str

Raise exception if the directory id is invalid.

funcmoto.ds.validations.validate_dns_ips(value:str) -> str

Raise exception if DNS IPs fail to match constraints.

funcmoto.ds.validations.validate_edition(value:str) -> str

Raise exception if edition not one of the allowed values.

funcmoto.ds.validations.validate_name(value:str) -> str

Raise exception if name fails to match constraints.

funcmoto.ds.validations.validate_password(value:str) -> str

Raise exception if password fails to match constraints.

funcmoto.ds.validations.validate_remote_domain_name(value:str) -> str

Raise exception if remote domain name fails to match constraints.

funcmoto.ds.validations.validate_short_name(value:str) -> str

Raise exception if short name fails to match constraints.

funcmoto.ds.validations.validate_size(value:str) -> str

Raise exception if size fails to match constraints.

funcmoto.ds.validations.validate_sso_password(value:str) -> str

Raise exception is SSO password exceeds length.

funcmoto.ds.validations.validate_subnet_ids(value:str) -> str

Raise exception is subnet IDs fail to match constraints.

funcmoto.ds.validations.validate_trust_direction(value:str) -> str

Raise exception if trust direction fails to match constraints.

funcmoto.ds.validations.validate_user_name(value:str) -> str

Raise exception is username fails to match constraints.

classmoto.dsql.models.AuroraDSQLBackend

Implementation of AuroraDSQL APIs.

classmoto.dsql.models.Cluster

Model for an AuroraDSQL cluster.

classmoto.dsql.responses.AuroraDSQLResponse

Handler for AuroraDSQL requests and responses.

methodmoto.dsql.responses.AuroraDSQLResponse.dsql_backend() -> AuroraDSQLBackend

Return backend instance specific for this region.

classmoto.dynamodb.comparisons.ConditionExpressionParser.Kind

Enum defining types of nodes in the syntax tree.

classmoto.dynamodb.comparisons.ConditionExpressionParser.Nonterminal

Enum defining nonterminals for productions.

classmoto.dynamodb.comparisons.Func

Base class for a FilterExpression function

classmoto.dynamodb.comparisons.Op

Base class for a FilterExpression operator

funcmoto.dynamodb.comparisons.get_expected(expected:dict[str, Any]) -> Op | Func

Parse a filter expression into an Op.

func

moto.dynamodb.comparisons.get_filter_expression(expr:str | None, names:dict[str, str] | None, values:dict[str, dict[str, str]] | None) -> Op | Func

Parse a filter expression into an Op.

method

moto.dynamodb.models.DynamoDBBackend.default_vpc_endpoint_service(service_region:str, zones:list[str]) -> list[dict[str, str]]

Default VPC endpoint service.

method

moto.dynamodb.models.DynamoDBBackend.execute_statement(statement:str, parameters:list[dict[str, Any]]) -> list[dict[str, Any]]

Pagination is not yet implemented.

method

moto.dynamodb.models.DynamoDBBackend.get_table_keys_name(table_name:str, keys:dict[str, Any]) -> tuple[str | None, str | None]

Given a set of keys, extracts the key and range key

funcmoto.dynamodb.models.utilities.dynamo_to_dict(obj:Any) -> Any

Recursively convert DynamoDB model objects to plain Python types.

classmoto.dynamodb.parsing.ast_nodes.DDBTypedValue

A node representing a DDBTyped value.

classmoto.dynamodb.parsing.ast_nodes.ExpressionAttribute

An attribute identifier as used in the DDB item

classmoto.dynamodb.parsing.ast_nodes.ExpressionAttributeValue

An ExpressionAttributeValue is an alias for an value

classmoto.dynamodb.parsing.ast_nodes.ExpressionSelector

Node identifying selector [selection_index] in expresion

classmoto.dynamodb.parsing.ast_nodes.NodeDepthLeftTypeFetcher

Helper class to fetch a node of a specific type.

classmoto.dynamodb.parsing.ast_nodes.NoneExistingPath

A placeholder for Paths that did not exist in the Item.

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionAddAction

AddAction => Path Value

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionAddClause

UpdateExpressionAddClause => ADD AddActions

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionDeleteAction

DeleteAction => Path Value

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionDeleteClause

UpdateExpressionDeleteClause => DELETE DeleteActions

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionFunction

A Node representing a function of an Update Expression.

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionGroupedValue

GroupedValue => ( Value )

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionRemoveAction

RemoveAction => Path

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionRemoveClause

UpdateExpressionRemoveClause => REMOVE RemoveActions

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionSetAction

SetAction => Path = Value

classmoto.dynamodb.parsing.ast_nodes.UpdateExpressionSetClause

UpdateExpressionSetClause => SET SetActions

classmoto.dynamodb.parsing.expressions.ExpressionParser

Abstract class

classmoto.dynamodb.parsing.expressions.NestableExpressionParserMixin

For nodes that can be nested in themselves (recursive).

classmoto.dynamodb.parsing.expressions.UpdateExpressionActionsParser

UpdateExpressionSetActions

classmoto.dynamodb.parsing.expressions.UpdateExpressionAddActionsParser

UpdateExpressionSetActions

classmoto.dynamodb.parsing.expressions.UpdateExpressionDeleteActionsParser

UpdateExpressionSetActions

classmoto.dynamodb.parsing.expressions.UpdateExpressionParser

Parser to create update expressions

classmoto.dynamodb.parsing.expressions.UpdateExpressionRemoveActionsParser

UpdateExpressionSetActions

classmoto.dynamodb.parsing.expressions.UpdateExpressionSetActionsParser

UpdateExpressionSetActions

classmoto.dynamodb.parsing.expressions.UpdateExpressionSetClauseParser

UpdateExpressionSetClause => SET SetActions

funcmoto.dynamodb.parsing.key_condition_expression.get_keys(schema:list[dict[str, str]], key_type:str) -> list[str]

Get all keys of the specified type in schema order.

classmoto.dynamodb.parsing.reserved_keywords.ReservedKeywords

DynamoDB has an extensive list of keywords.

classmoto.dynamodb.parsing.tokens.ExpressionTokenizer

Takes a string and returns a list of tokens.

func

moto.dynamodb.responses.validate_put_has_empty_keys(field_updates:dict[str, Any], table:Table, custom_error_msg:str | None=None) -> None

Error if any keys have an empty value.

classmoto.ebs.models.EBSBackend

Implementation of EBS APIs.

methodmoto.ebs.models.EBSBackend.get_snapshot_block(snapshot_id:str, block_index:str) -> Block

The BlockToken-parameter is not yet implemented

classmoto.ebs.responses.EBSResponse

Handler for EBS requests and responses.

methodmoto.ebs.responses.EBSResponse.ebs_backend() -> EBSBackend

Return backend instance specific for this region.

methodmoto.ec2.models.instances.Instance.get_block_device_status(volume_status:str) -> str

Convert volume status to attachment status

classmoto.ecs.models.EC2ContainerServiceBackend

ECS resources use the new ARN format by default.

methodmoto.ecs.models.EC2ContainerServiceBackend.delete_task_set(cluster:str, service:str, task_set:str) -> TaskSet

The Force-parameter is not yet implemented

methodmoto.ecs.models.EC2ContainerServiceBackend.describe_tasks(cluster_str:str, tasks:list[str]) -> list[Task]

Only include=TAGS is currently supported.

method

moto.ecs.models.EC2ContainerServiceBackend.list_attributes(target_type:str, cluster_name:str | None=None, attr_name:str | None=None, attr_value:str | None=None) -> Any

Pagination is not yet implemented

methodmoto.ecs.models.EC2ContainerServiceBackend.list_clusters() -> list[str]

maxSize and pagination not implemented

method

moto.ecs.models.EC2ContainerServiceBackend.update_cluster_resources(cluster:Cluster, task_num:int, task_state:str | None='RUNNING') -> None

Modify the number tasks running on the cluster.

classmoto.efs.models.EFSBackend

The backend manager of EFS resources.

methodmoto.efs.models.EFSBackend.delete_file_system(file_system_id:str) -> None

Delete the file system specified by the given file_system_id.

methodmoto.efs.models.EFSBackend.delete_mount_target(mount_target_id:str) -> None

Delete a mount target specified by the given mount_target_id.

method

moto.efs.models.EFSBackend.describe_access_points(access_point_id:str | None, file_system_id:str | None) -> list[AccessPoint]

Pagination is not yet implemented

classmoto.efs.models.FileSystem

A model for an EFS File System Volume.

classmoto.efs.models.MountTarget

A model for an EFS Mount Target.

classmoto.elasticache.models.ElastiCacheBackend

Implementation of ElastiCache APIs.

methodmoto.elasticache.models.ElastiCacheBackend.describe_users(user_id:str | None) -> list[User]

Only the `user_id` parameter is currently supported.

classmoto.elasticache.responses.ElastiCacheResponse

Handler for ElastiCache requests and responses.

methodmoto.elb.models.LoadBalancer.delete(account_id:str, region:str) -> None

Not exposed as part of the ELB API - used for CloudFormation.

methodmoto.elb.models.LoadBalancer.instance_ids() -> list[str]

Return all the instances attached to the ELB

classmoto.emrcontainers.models.EMRContainersBackend

Implementation of EMRContainers APIs.

classmoto.emrcontainers.responses.EMRContainersResponse

Handler for EMRContainers requests and responses.

classmoto.emrserverless.models.EMRServerlessBackend

Implementation of EMRServerless APIs.

classmoto.emrserverless.responses.EMRServerlessResponse

Handler for EMRServerless requests and responses.

methodmoto.events.models.Connection.describe() -> dict[str, Any]

Create a complete description for the Connection object.

classmoto.firehose.exceptions.InvalidArgumentException

The specified input parameter has a value that is not valid.

classmoto.firehose.exceptions.ResourceNotFoundException

The specified resource could not be found.

classmoto.firehose.exceptions.ValidationException

The tag key or tag value is not valid.

classmoto.firehose.models.FirehoseBackend

Implementation of Firehose APIs.

method

moto.firehose.models.FirehoseBackend.default_vpc_endpoint_service(service_region:str, zones:list[str]) -> list[dict[str, str]]

Default VPC endpoint service.

methodmoto.firehose.models.FirehoseBackend.delete_delivery_stream(delivery_stream_name:str) -> None

Delete a delivery stream and its data.

method

moto.firehose.models.FirehoseBackend.list_tags_for_delivery_stream(delivery_stream_name:str, exclusive_start_tag_key:str, limit:int | None) -> dict[str, Any]

Return list of tags.

methodmoto.firehose.models.FirehoseBackend.lookup_name_from_arn(arn:str) -> DeliveryStream | None

Given an ARN, return the associated delivery stream name.

method

moto.firehose.models.FirehoseBackend.put_http_records(http_destination:dict[str, Any], records:list[dict[str, bytes]]) -> list[dict[str, str]]

Put records to a HTTP destination.

methodmoto.firehose.models.FirehoseBackend.tag_delivery_stream(delivery_stream_name:str, tags:list[dict[str, str]]) -> None

Add/update tags for specified delivery stream.

methodmoto.firehose.models.FirehoseBackend.untag_delivery_stream(delivery_stream_name:str, tag_keys:list[str]) -> None

Removes tags from specified delivery stream.

funcmoto.firehose.models.find_destination_config_in_args(api_args:dict[str, Any]) -> tuple[str, Any]

Return (config_name, config) tuple for destination config.

classmoto.firehose.responses.FirehoseResponse

Handler for Firehose requests and responses.

methodmoto.firehose.responses.FirehoseResponse.firehose_backend() -> FirehoseBackend

Return backend instance specific to this region.

methodmoto.firehose.responses.FirehoseResponse.put_record() -> ActionResult

Prepare arguments and response to PutRecord().

classmoto.fsx.models.FSxBackend

Implementation of FSx APIs.

methodmoto.fsx.models.FSxBackend.list_tags_for_resource(resource_arn:str) -> list[dict[str, str]]

Pagination is not yet implemented

classmoto.fsx.responses.FSxResponse

Handler for FSx requests and responses.

methodmoto.fsx.responses.FSxResponse.fsx_backend() -> FSxBackend

Return backend instance specific for this region.

classmoto.iam.models.AWSManagedPolicy

AWS-managed policy.

classmoto.iam.models.MFADevice

MFA Device class.

classmoto.iam.models.ManagedPolicy

Managed policy.

classmoto.iam.policy_conditions.TrustCondition

Single condition object

classmoto.iam.policy_conditions.TrustRelationShipConditions

Trust relationship conditions segment model

funcmoto.iam.utils.generate_access_key_id_from_account_id(account_id:str, prefix:str, total_length:int=20) -> str

Generates a key id (e.g.

classmoto.identitystore.models.IdentityStoreBackend

Implementation of IdentityStore APIs.

classmoto.identitystore.responses.IdentityStoreResponse

Handler for IdentityStore requests and responses.

classmoto.ivs.models.IVSBackend

Implementation of IVS APIs.

classmoto.ivs.responses.IVSResponse

Handler for IVS requests and responses.

methodmoto.ivs.responses.IVSResponse.ivs_backend() -> IVSBackend

Return backend instance specific for this region.

classmoto.kafka.models.KafkaBackend

Implementation of Kafka APIs.

classmoto.kafka.responses.KafkaResponse

Handler for Kafka requests and responses.

methodmoto.kafka.responses.KafkaResponse.kafka_backend() -> KafkaBackend

Return backend instance specific for this region.

classmoto.kinesisanalyticsv2.models.KinesisAnalyticsV2Backend

Implementation of KinesisAnalyticsV2 APIs.

func

moto.kms.utils.decrypt(master_keys:dict[str, Any], ciphertext_blob:bytes, encryption_context:dict[str, str]) -> tuple[bytes, str]

Decrypt a ciphertext blob using a master key material.

func

moto.kms.utils.encrypt(master_keys:dict[str, Any], key_id:str, plaintext:bytes, encryption_context:dict[str, str]) -> bytes

Encrypt data using a master key material.

funcmoto.kms.utils.generate_data_key(number_of_bytes:int) -> bytes

Generate a data key.

funcmoto.kms.utils.generate_hmac(key:bytes, message:bytes, mac_algorithm:str) -> str

Returns a base64 encoded HMAC

funcmoto.kms.utils.generate_master_key() -> bytes

Generate a master key.

funcmoto.kms.utils.generate_private_key(key_spec:str) -> AbstractPrivateKey

Generate a private key to be used on asymmetric sign/verify.

classmoto.lakeformation.responses.LakeFormationResponse

Handler for LakeFormation requests and responses.

classmoto.lexv2models.models.LexModelsV2Backend

Implementation of LexModelsV2 APIs.

classmoto.lexv2models.responses.LexModelsV2Response

Handler for LexModelsV2 requests and responses.

classmoto.macie2.responses.MacieResponse

Handles API requests for the Macie service.

classmoto.mediapackagev2.responses.mediapackagev2Response

Handler for mediapackagev2 requests and responses.

classmoto.memorydb.models.MemoryDBBackend

Implementation of MemoryDB APIs.

classmoto.memorydb.responses.MemoryDBResponse

Handler for MemoryDB requests and responses.

methodmoto.memorydb.responses.MemoryDBResponse.memorydb_backend() -> MemoryDBBackend

Return backend instance specific for this region.

classmoto.moto_api._internal.managed_state_model.ManagedState

Subclass this class to configure state-transitions

classmoto.moto_api._internal.moto_random.MotoRandom

Class used for all sources of random-ness in Moto.

methodmoto.moto_api._internal.state_manager.StateManager.get_transition(model_name:str) -> dict[str, Any]

Return the configuration for a specific model.

methodmoto.moto_api._internal.state_manager.StateManager.set_transition(model_name:str, transition:dict[str, Any]) -> None

Set a transition for a specific model.

methodmoto.moto_api._internal.state_manager.StateManager.unset_transition(model_name:str) -> None

Unset (remove) a custom transition that was set.

classmoto.mq.responses.MQResponse

Handler for MQ requests and responses.

methodmoto.mq.responses.MQResponse.mq_backend() -> MQBackend

Return backend instance specific for this region.

classmoto.networkfirewall.models.NetworkFirewallBackend

Implementation of NetworkFirewall APIs.

classmoto.networkfirewall.responses.NetworkFirewallResponse

Handler for NetworkFirewall requests and responses.

classmoto.networkmanager.models.NetworkManagerBackend

Implementation of NetworkManager APIs.

classmoto.networkmanager.responses.NetworkManagerResponse

Handler for NetworkManager requests and responses.

classmoto.opensearch.models.OpenSearchServiceBackend

Implementation of OpenSearchService APIs.

classmoto.opensearch.responses.OpenSearchServiceResponse

Handler for OpenSearchService requests and responses.

method

moto.opensearchserverless.models.OpenSearchServiceServerlessBackend.list_collections(collection_filters:dict[str, str]) -> list[Collection]

Pagination is not yet implemented

method

moto.opensearchserverless.models.OpenSearchServiceServerlessBackend.list_security_policies(resource:list[str], type:str) -> list[SecurityPolicy]

Pagination is not yet implemented

classmoto.organizations.models.OrganizationsBackendDict

Specialised to keep track of master accounts.

funcmoto.organizations.utils.fullmatch(regex:Pattern[str] | str, s:str, flags:int=0) -> bool

Emulate python-3.4 re.fullmatch().

classmoto.osis.models.OpenSearchIngestionBackend

Implementation of OpenSearchIngestion APIs.

classmoto.osis.responses.OpenSearchIngestionResponse

Handler for OpenSearchIngestion requests and responses.

classmoto.packages.boto.ec2.blockdevicemapping.BlockDeviceType

Represents parameters for a block device.

classmoto.packages.boto.ec2.instance.Instance

Represents an instance.

classmoto.packages.boto.ec2.instance.InstancePlacement

The location where the instance launched.

classmoto.packages.boto.ec2.instance.Reservation

Represents a Reservation response object.

classmoto.personalize.models.PersonalizeBackend

Implementation of Personalize APIs.

methodmoto.personalize.models.PersonalizeBackend.list_schemas() -> Iterable[Schema]

Pagination is not yet implemented

classmoto.personalize.responses.PersonalizeResponse

Handler for Personalize requests and responses.

classmoto.pinpoint.models.PinpointBackend

Implementation of Pinpoint APIs.

methodmoto.pinpoint.models.PinpointBackend.get_apps() -> Iterable[App]

Pagination is not yet implemented

classmoto.pinpoint.responses.PinpointResponse

Handler for Pinpoint requests and responses.

methodmoto.pinpoint.responses.PinpointResponse.pinpoint_backend() -> PinpointBackend

Return backend instance specific for this region.

classmoto.pipes.models.EventBridgePipesBackend

Implementation of EventBridgePipes APIs.

classmoto.pipes.models.Pipe

Represents an EventBridge Pipe.

classmoto.pipes.responses.EventBridgePipesResponse

Handler for EventBridgePipes requests and responses.

classmoto.quicksight.models.QuickSightBackend

Implementation of QuickSight APIs.

classmoto.quicksight.utils.QuicksightBaseSearchFilter

Base Search Filter.

classmoto.quicksight.utils.QuicksightGroupSearchFilter

Group Search Filter.

classmoto.quicksight.utils.QuicksightSearchFilterFactory

Creates the appropriate search filter.

classmoto.quicksight.utils.QuicksightSearchFilterList

Generic QuickSight Search Filter List.

funcmoto.rds.utils.apply_filter(resources:Any, filters:Any, filter_defs:dict[str, FilterDef]) -> Any

Apply an arbitrary filter to a group of resources.

funcmoto.rds.utils.get_object_value(obj:Any, attr:str) -> Any

Retrieves an arbitrary attribute value from an object.

funcmoto.rds.utils.validate_filters(filters:dict[str, Any], filter_defs:dict[str, FilterDef]) -> None

Validates filters against a set of filter definitions.

classmoto.rekognition.models.RekognitionBackend

Implementation of Rekognition APIs.

classmoto.rekognition.responses.RekognitionResponse

Handler for Rekognition requests and responses.

classmoto.route53.exceptions.ConflictingDomainExists

Domain already exists.

classmoto.route53.exceptions.HostedZoneNotEmpty

HostedZone does not exist.

classmoto.route53.exceptions.InvalidInput

Malformed ARN for the CloudWatch log group.

classmoto.route53.exceptions.InvalidVPCId

Missing/Invalid VPC ID

classmoto.route53.exceptions.LastVPCAssociation

Last VPC can't be disassociate.

classmoto.route53.exceptions.NoSuchHealthCheck

HealthCheck does not exist.

classmoto.route53.exceptions.NoSuchHostedZone

HostedZone does not exist.

classmoto.route53.exceptions.NoSuchQueryLoggingConfig

Query log config does not exist.

classmoto.route53.exceptions.PublicZoneVPCAssociation

Public hosted zone can't be associated.

classmoto.route53.exceptions.QueryLoggingConfigAlreadyExists

Query log config exists for the hosted zone.

classmoto.route53.exceptions.Route53ClientError

Base class for Route53 errors.

classmoto.route53.exceptions.UnsupportedCharacter

Malformed ARN for the CloudWatch log group.

classmoto.route53.models.ChangeList

Contains a 'clean' list of ResourceRecordChangeSets

methodmoto.route53.models.RecordSet.delete(account_id:str, region:str) -> None

Not exposed as part of the Route 53 API - used for CloudFormation

classmoto.route53.responses.Route53

Handler for Route53 requests and responses.

classmoto.route53domains.models.Route53DomainsBackend

Implementation of Route53Domains APIs.

classmoto.route53resolver.models.ResolverDnssecConfig

Representation of a configuration for DNSSEC validation.

classmoto.route53resolver.models.ResolverEndpoint

Representation of a fake Route53 Resolver Endpoint.

methodmoto.route53resolver.models.ResolverEndpoint.create_eni() -> list[str]

Create a VPC ENI for each combo of AZ, subnet and IP.

methodmoto.route53resolver.models.ResolverEndpoint.update_name(name:str) -> None

Replace existing name with new name.

classmoto.route53resolver.models.ResolverRule

Representation of a fake Route53 Resolver Rule.

classmoto.route53resolver.models.Route53ResolverBackend

Implementation of Route53Resolver APIs.

methodmoto.route53resolver.models.Route53ResolverBackend.get_resolver_dnssec_config(resource_id:str) -> ResolverDnssecConfig

Get information about a resolver DNSSEC config.

methodmoto.route53resolver.models.Route53ResolverBackend.get_resolver_rule(resolver_rule_id:str) -> ResolverRule

Return info for specified resolver rule.

classmoto.route53resolver.responses.Route53ResolverResponse

Handler for Route53Resolver requests and responses.

methodmoto.route53resolver.responses.Route53ResolverResponse.associate_resolver_rule() -> str

Associate a Resolver rule with a VPC.

methodmoto.route53resolver.responses.Route53ResolverResponse.delete_resolver_endpoint() -> str

Delete a Resolver endpoint.

methodmoto.route53resolver.responses.Route53ResolverResponse.delete_resolver_rule() -> str

Delete a Resolver rule.

methodmoto.route53resolver.responses.Route53ResolverResponse.get_resolver_rule() -> str

Return info about a specific Resolver rule.

methodmoto.route53resolver.responses.Route53ResolverResponse.list_tags_for_resource() -> str

Lists all tags for the given resource.

methodmoto.route53resolver.responses.Route53ResolverResponse.tag_resource() -> str

Add one or more tags to a specified resource.

methodmoto.route53resolver.responses.Route53ResolverResponse.update_resolver_endpoint() -> str

Update name of Resolver endpoint.

funcmoto.route53resolver.validations.validate_args(validators:list[tuple[str, Any]]) -> None

Raise exception if any of the validations fails.

funcmoto.route53resolver.validations.validate_creator_request_id(value:str | None) -> str

Raise exception if the creator_request_id has invalid length.

funcmoto.route53resolver.validations.validate_direction(value:str | None) -> str

Raise exception if direction not one of the allowed values.

funcmoto.route53resolver.validations.validate_domain_name(value:str) -> str

Raise exception if the domain_name has invalid length.

funcmoto.route53resolver.validations.validate_endpoint_id(value:str | None) -> str

Raise exception if resolver endpoint id has invalid length.

funcmoto.route53resolver.validations.validate_ip_addresses(value:str) -> str

Raise exception if IPs fail to match length constraint.

funcmoto.route53resolver.validations.validate_max_results(value:int | None) -> str

Raise exception if number of endpoints or IPs is too large.

funcmoto.route53resolver.validations.validate_name(value:str | None) -> str

Raise exception if name fails to match constraints.

funcmoto.route53resolver.validations.validate_rule_id(value:str | None) -> str

Raise exception if resolver rule id has invalid length.

funcmoto.route53resolver.validations.validate_rule_type(value:str | None) -> str

Raise exception if rule_type not one of the allowed values.

funcmoto.route53resolver.validations.validate_security_group_ids(value:list[str]) -> str

Raise exception if IPs fail to match length constraint.

funcmoto.route53resolver.validations.validate_subnets(value:list[dict[str, Any]]) -> str

Raise exception if subnets fail to match length constraint.

About this data

These signatures were extracted from the public source of getmoto/moto using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries