botocore API reference
158 public APIs from botocore (boto/botocore) — 119 classes, 15 functions, 24 methods. Signatures extracted by static analysis of the actual source.
Repository: boto/botocore
| Kind | Count |
|---|---|
| Classes | 119 |
| Functions | 15 |
| Methods | 24 |
API list
class
botocore.args.ConfigObjectWrapperBase class to mark values set via in-code Config object.
class
botocore.auth.HmacV1PostAuthGenerates a presigned post for s3.
class
botocore.auth.HmacV1QueryAuthGenerates a presigned request for s3.
class
botocore.auth.S3SigV4QueryAuthS3 SigV4 auth using query parameters.
class
botocore.auth.SigV2AuthSign a request with Signature V2.
class
botocore.auth.SigV4AuthSign a request with Signature V4.
class
botocore.awsrequest.AWSConnectionMixin for HTTPConnection that supports Expect 100-continue.
class
botocore.awsrequest.AWSHTTPConnectionAn HTTPConnection that supports 100 Continue behavior.
class
botocore.awsrequest.AWSHTTPSConnectionAn HTTPSConnection that supports 100 Continue behavior.
class
botocore.awsrequest.AWSRequestRepresents the elements of an HTTP request.
class
botocore.awsrequest.AWSResponseA data class representing an HTTP response.
method
botocore.awsrequest.AWSResponse.content()Content of the response as bytes.
class
botocore.awsrequest.HeadersDictA case-insenseitive dictionary to represent HTTP headers.
method
botocore.client.BaseClient.close()Closes underlying endpoint connections.
class
botocore.client.ClientCreatorCreates client objects for a service.
class
botocore.client.ClientMetaHolds additional client methods.
func
botocore.compat.get_md5(*args, **kwargs)Attempts to get an md5 hashing object.
class
botocore.config.ConfigAdvanced configuration for Botocore clients.
func
botocore.configloader.load_config(config_filename)Parse a INI config with profiles.
class
botocore.configprovider.BaseProviderBase class for configuration value providers.
method
botocore.configprovider.BaseProvider.provide()Provide a config value.
class
botocore.configprovider.ChainProviderThis provider wraps one or more other providers.
class
botocore.configprovider.ConfigValueStoreThe ConfigValueStore object stores configuration values.
class
botocore.configprovider.ConstantProviderThis provider provides a constant value.
class
botocore.configprovider.EnvironmentProviderThis class loads config values from environment variables.
class
botocore.credentials.ConfigProviderINI based config provider with profile sections.
class
botocore.credentials.CredentialsHolds the credentials needed to authenticate requests.
class
botocore.credentials.RefreshableCredentialsHolds the credentials needed to authenticate requests.
method
botocore.credentials.RefreshableCredentials.get_frozen_credentials()Return immutable credentials.
method
botocore.credentials.RefreshableCredentials.refresh_needed(refresh_in=None)Check if a refresh is needed.
class
botocore.crt.auth.CrtS3SigV4AsymQueryAuthS3 SigV4A auth using query parameters.
class
botocore.crt.auth.CrtS3SigV4QueryAuthS3 SigV4 auth using query parameters.
class
botocore.endpoint_provider.BaseRuleBase interface for individual endpoint rules.
class
botocore.endpoint_provider.ParameterDefinitionThe spec of an individual parameter defined in a RuleSet.
class
botocore.endpoint_provider.ParameterTypeTranslation from `type` attribute to native Python type.
class
botocore.endpoint_provider.RuleSetCollection of rules to derive a routable service endpoint.
class
botocore.endpoint_provider.RuleSetEndpointA resolved endpoint object returned by a rule.
class
botocore.endpoint_provider.RuleSetStandardLibraryRule actions to be performed by the EndpointProvider.
method
botocore.endpoint_provider.RuleSetStandardLibrary.convert_func_name(value)Normalize function names.
class
botocore.eventstream.ChecksumMismatchCalculated checksum did not match the expected checksum.
class
botocore.eventstream.DecodeUtilsUnpacking utility functions used in the decoder.
method
botocore.eventstream.DecodeUtils.unpack_uuid(data)Parse a 16-byte uuid from the bytes.
class
botocore.eventstream.DuplicateHeaderDuplicate header found in the event.
class
botocore.eventstream.EventStreamWrapper class for an event stream body.
method
botocore.eventstream.EventStream.close()Closes the underlying streaming body.
class
botocore.eventstream.EventStreamHeaderParserParses the event headers from an event stream message.
class
botocore.eventstream.EventStreamMessageRepresents an event stream message.
class
botocore.eventstream.InvalidHeadersLengthHeaders length is longer than the maximum.
class
botocore.eventstream.InvalidPayloadLengthPayload length is longer than the maximum.
class
botocore.eventstream.MessagePreludeRepresents the prelude of an event stream message.
class
botocore.eventstream.NoInitialResponseErrorAn event of type initial-response was not received.
class
botocore.eventstream.ParserErrorBase binary flow encoding parsing exception.
class
botocore.exceptions.BaseEndpointResolverErrorBase error for endpoint resolving errors.
class
botocore.exceptions.BotoCoreErrorThe base exception class for BotoCore exceptions.
class
botocore.exceptions.ChecksumErrorThe expected checksum did not match the calculated checksum.
class
botocore.exceptions.ConfigNotFoundThe specified configuration file could not be found.
class
botocore.exceptions.ConfigParseErrorThe configuration file could not be parsed.
class
botocore.exceptions.DataNotFoundErrorThe data associated with a particular path could not be loaded.
class
botocore.exceptions.EndpointProviderErrorBase error for the EndpointProvider class
class
botocore.exceptions.EndpointResolutionErrorError when input parameters resolve to an error rule
class
botocore.exceptions.EndpointVariantErrorCould not construct modeled endpoint variant.
class
botocore.exceptions.IncompleteReadErrorHTTP response did not return expected number of bytes.
class
botocore.exceptions.InvalidChecksumConfigErrorError when an invalid checksum config value is supplied.
class
botocore.exceptions.InvalidExpressionErrorExpression is either invalid or too complex.
class
botocore.exceptions.InvalidMaxRetryAttemptsErrorError when invalid retry configuration is specified
class
botocore.exceptions.InvalidRegionErrorInvalid region_name provided to client or resource.
class
botocore.exceptions.InvalidRetryConfigurationErrorError when invalid retry configuration is specified
class
botocore.exceptions.InvalidRetryModeErrorError when invalid retry mode configuration is specified
class
botocore.exceptions.InvalidS3AddressingStyleErrorError when an invalid path style is specified
class
botocore.exceptions.MissingParametersErrorOne or more required parameters were not supplied.
class
botocore.exceptions.NoAuthTokenErrorNo authorization token could be found.
class
botocore.exceptions.NoCredentialsErrorNo credentials could be found.
class
botocore.exceptions.NoRegionErrorNo region was specified.
class
botocore.exceptions.PartialCredentialsErrorOnly partial credentials were found.
class
botocore.exceptions.RangeErrorA parameter value was out of the valid range.
class
botocore.exceptions.ServiceNotInRegionErrorThe service is not available in requested region.
class
botocore.exceptions.TokenRetrievalErrorError attempting to retrieve a token from a remote source.
class
botocore.exceptions.UnknownEndpointErrorCould not construct an endpoint.
class
botocore.exceptions.UnknownFIPSEndpointErrorCould not construct a FIPS endpoint.
class
botocore.exceptions.UnknownKeyErrorUnknown key in a struct parameter.
class
botocore.exceptions.UnknownParameterErrorUnknown top level parameter.
class
botocore.exceptions.UnknownRegionErrorRaised when trying to load data for an unknown region.
class
botocore.exceptions.UnknownServiceErrorRaised when trying to load data for an unknown service.
class
botocore.exceptions.UnknownServiceStyleUnknown style of service invocation.
class
botocore.exceptions.UnknownSignatureVersionErrorRequested Signature Version is not known.
class
botocore.exceptions.UnseekableStreamErrorNeed to seek a stream, but stream does not support seeking.
class
botocore.exceptions.ValidationErrorAn exception occurred validating parameters.
class
botocore.exceptions.WaiterConfigErrorError when processing waiter configuration.
class
botocore.exceptions.WaiterErrorWaiter failed to reach desired state.
class
botocore.handlers.HeaderToHostHoisterTakes a header and moves it to the front of the hoststring.
method
botocore.handlers.HeaderToHostHoister.hoist(params, **kwargs)Hoist a header to the hostname.
func
botocore.httpsession.mask_proxy_url(proxy_url)Mask proxy url credentials.
func
botocore.invoke_initializers(session)Invoke all initializers for a session.
class
botocore.loaders.ExtrasProcessorProcesses data from extras files into service models.
class
botocore.loaders.JSONFileLoaderLoader JSON files.
method
botocore.loaders.JSONFileLoader.exists(file_path)Checks if the file exists.
method
botocore.loaders.JSONFileLoader.load_file(file_path)Attempt to load the file path.
class
botocore.loaders.LoaderFind and load data models.
method
botocore.loaders.Loader.list_available_services(type_name)List all known services.
method
botocore.loaders.Loader.load_data(name)Load data given a data path.
func
botocore.loaders.create_loader(search_path_string=None)Create a Loader class.
class
botocore.model.DenormalizedStructureBuilderBuild a StructureShape from a denormalized model.
method
botocore.model.OperationModel.wire_name()The wire name of the operation.
method
botocore.model.ServiceModel.service_name()The name of the service.
class
botocore.model.ShapeObject representing a shape from the service model.
method
botocore.model.Shape.metadata()Metadata about the shape.
method
botocore.model.Shape.required_members()A list of members that are required.
class
botocore.model.ShapeNameGeneratorGenerate unique shape names for a type.
method
botocore.model.ShapeNameGenerator.new_shape_name(type_name)Generate a unique shape name.
class
botocore.model.ShapeResolverResolves shape references.
class
botocore.paginate.PageIteratorAn iterable object to paginate API results.
method
botocore.paginate.PageIterator.resume_token()Token to specify to resume pagination.
class
botocore.paginate.ResultKeyIteratorIterates over the results of paginated responses.
class
botocore.paginate.TokenDecoderDecodes token strings back into dictionaries.
method
botocore.paginate.TokenDecoder.decode(token)Decodes an opaque string to a dictionary.
class
botocore.paginate.TokenEncoderEncodes dictionaries into opaque strings.
method
botocore.paginate.TokenEncoder.encode(token)Encodes a dictionary to an opaque string.
class
botocore.parsers.ResponseParserBase class for response parsing.
class
botocore.regions.BaseEndpointResolverResolves regions and endpoints.
class
botocore.regions.EndpointResolverResolves endpoints based on partition endpoint metadata
class
botocore.regions.EndpointRulesetResolverResolves endpoints using a service's endpoint ruleset
class
botocore.response.StreamingBodyWrapper class for an http response body.
class
botocore.retries.adaptive.RateClockerTracks the rate at which a client is sending a request.
class
botocore.retries.base.BaseRetryableCheckerBase class for determining if a retry should happen.
class
botocore.retries.standard.MaxAttemptsSeederAdds the resolved max attempts to the retries context.
class
botocore.retries.standard.ModeledRetryableCheckerCheck if an error has been modeled as retryable.
class
botocore.retries.standard.RetryHandlerBridge between botocore's event system and this module.
class
botocore.retryhandler.BaseCheckerBase class for retry checkers.
class
botocore.retryhandler.ExceptionRaiserRaise any caught exceptions.
class
botocore.retryhandler.MaxAttemptsDecoratorAllow retries up to a maximum number of attempts.
class
botocore.retryhandler.RetryHandlerRetry handler.
class
botocore.serialize.BaseRestSerializerBase class for rest protocols.
class
botocore.serialize.BaseRpcV2SerializerBase class for RPCv2 protocols.
class
botocore.serialize.EC2SerializerEC2 specific customizations to the query protocol serializers.
class
botocore.session.ComponentLocatorService locator for session components.
method
botocore.session.Session.full_config()Return the parsed config file.
method
botocore.session.Session.get_service_model(service_name, api_version=None)Get the service model object.
func
botocore.session.get_session(env_vars=None)Return a new session object.
class
botocore.signers.CloudFrontSignerA signer to create a signed CloudFront URL.
func
botocore.translate.resolve_references(config, definitions)Recursively replace $ref keys.
func
botocore.unregister_initializer(callback)Unregister an initializer function.
class
botocore.useragent.RawStringUserAgentComponentUserAgentComponent interface wrapper around ``str``.
class
botocore.useragent.UserAgentStringGenerator for AWS SDK User-Agent header strings.
class
botocore.utils.ArgumentGeneratorGenerate sample input based on a shape model.
method
botocore.utils.ArgumentGenerator.generate_skeleton(shape)Generate a sample input.
class
botocore.utils.CachedPropertyA read only property that caches the initially computed value.
class
botocore.utils.JSONFileCacheJSON file cache.
class
botocore.utils.LoginTokenLoaderLoads and saves login access tokens to disk
class
botocore.utils.S3RegionRedirectorThis handler has been replaced by S3RegionRedirectorv2.
func
botocore.utils.calculate_sha256(body, as_hex=False)Calculate a sha256 checksum.
func
botocore.utils.calculate_tree_hash(body)Calculate a tree hash checksum.
func
botocore.utils.has_header(header_name, headers)Case-insensitive check for header key.
func
botocore.utils.is_valid_endpoint_url(endpoint_url)Verify the endpoint_url is valid.
func
botocore.utils.parse_timestamp(value)Parse a timestamp into a datetime object.
func
botocore.utils.percent_encode(input_str, safe=SAFE_CHARS)Urlencodes a string.
class
botocore.validate.ParamValidatorValidates parameters against a shape model.
class
botocore.waiter.SingleWaiterConfigRepresents the waiter configuration for a single waiter.
func
botocore.xform_name(name, sep='_', _xform_cache=_xform_cache)Convert camel case to a "pythonic" name.
About this data
These signatures were extracted from the public source of boto/botocore
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.