Synthetics module
Index > Synthetics
Auto-generated documentation for Synthetics type annotations stubs module types-aiobotocore-synthetics.
How to install
From PyPI with pip
Install types-aioboto3
for Synthetics
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[synthetics]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[synthetics]'
# standalone installation
python -m pip install types-aiobotocore-synthetics
How to uninstall
Usage
Code samples can be found in Examples.
SyntheticsClient
Type annotations and code completion for session.client("synthetics")
as SyntheticsClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_synthetics.client import SyntheticsClient
session = Session()
async with session.client("synthetics") as client:
client: SyntheticsClient
Literals
Type annotations for literals used in methods and schema.
Usage example
from types_aiobotocore_synthetics.literals import CanaryRunStateReasonCodeType
def get_value() -> CanaryRunStateReasonCodeType:
return "CANARY_FAILURE"
- CanaryRunStateReasonCodeType
- CanaryRunStateType
- CanaryStateReasonCodeType
- CanaryStateType
- EncryptionModeType
- SyntheticsServiceName
- ServiceName
- ResourceServiceName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_synthetics.type_defs import S3EncryptionConfigTypeDef
def get_value() -> S3EncryptionConfigTypeDef:
return {
"EncryptionMode": ...,
}
- S3EncryptionConfigTypeDef
- AssociateResourceRequestRequestTypeDef
- BaseScreenshotTypeDef
- CanaryCodeInputTypeDef
- CanaryCodeOutputTypeDef
- CanaryRunConfigInputTypeDef
- CanaryRunConfigOutputTypeDef
- CanaryRunStatusTypeDef
- CanaryRunTimelineTypeDef
- CanaryScheduleInputTypeDef
- CanaryScheduleOutputTypeDef
- CanaryStatusTypeDef
- CanaryTimelineTypeDef
- VpcConfigOutputTypeDef
- VpcConfigInputTypeDef
- ResponseMetadataTypeDef
- CreateGroupRequestRequestTypeDef
- GroupTypeDef
- DeleteCanaryRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DescribeCanariesLastRunRequestRequestTypeDef
- DescribeCanariesRequestRequestTypeDef
- DescribeRuntimeVersionsRequestRequestTypeDef
- RuntimeVersionTypeDef
- DisassociateResourceRequestRequestTypeDef
- GetCanaryRequestRequestTypeDef
- GetCanaryRunsRequestRequestTypeDef
- GetGroupRequestRequestTypeDef
- GroupSummaryTypeDef
- ListAssociatedGroupsRequestRequestTypeDef
- ListGroupResourcesRequestRequestTypeDef
- ListGroupsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- StartCanaryRequestRequestTypeDef
- StopCanaryRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ArtifactConfigInputTypeDef
- ArtifactConfigOutputTypeDef
- VisualReferenceInputTypeDef
- VisualReferenceOutputTypeDef
- CanaryRunTypeDef
- ListGroupResourcesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- CreateGroupResponseTypeDef
- GetGroupResponseTypeDef
- DescribeRuntimeVersionsResponseTypeDef
- ListAssociatedGroupsResponseTypeDef
- ListGroupsResponseTypeDef
- CreateCanaryRequestRequestTypeDef
- UpdateCanaryRequestRequestTypeDef
- CanaryTypeDef
- CanaryLastRunTypeDef
- GetCanaryRunsResponseTypeDef
- CreateCanaryResponseTypeDef
- DescribeCanariesResponseTypeDef
- GetCanaryResponseTypeDef
- DescribeCanariesLastRunResponseTypeDef