Skip to content

Type definitions#

Index > PrometheusService > Type definitions

Auto-generated documentation for PrometheusService type annotations stubs module mypy-boto3-amp.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

EksConfigurationUnionTypeDef#

# EksConfigurationUnionTypeDef definition

EksConfigurationUnionTypeDef = Union[
    EksConfigurationTypeDef,  # (1)
    EksConfigurationOutputTypeDef,  # (2)
]
  1. See EksConfigurationTypeDef
  2. See EksConfigurationOutputTypeDef

AlertManagerDefinitionStatusTypeDef#

# AlertManagerDefinitionStatusTypeDef definition

class AlertManagerDefinitionStatusTypeDef(TypedDict):
    statusCode: AlertManagerDefinitionStatusCodeType,  # (1)
    statusReason: NotRequired[str],
  1. See AlertManagerDefinitionStatusCodeType

AmpConfigurationTypeDef#

# AmpConfigurationTypeDef definition

class AmpConfigurationTypeDef(TypedDict):
    workspaceArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateLoggingConfigurationRequestRequestTypeDef#

# CreateLoggingConfigurationRequestRequestTypeDef definition

class CreateLoggingConfigurationRequestRequestTypeDef(TypedDict):
    logGroupArn: str,
    workspaceId: str,
    clientToken: NotRequired[str],

LoggingConfigurationStatusTypeDef#

# LoggingConfigurationStatusTypeDef definition

class LoggingConfigurationStatusTypeDef(TypedDict):
    statusCode: LoggingConfigurationStatusCodeType,  # (1)
    statusReason: NotRequired[str],
  1. See LoggingConfigurationStatusCodeType

RuleGroupsNamespaceStatusTypeDef#

# RuleGroupsNamespaceStatusTypeDef definition

class RuleGroupsNamespaceStatusTypeDef(TypedDict):
    statusCode: RuleGroupsNamespaceStatusCodeType,  # (1)
    statusReason: NotRequired[str],
  1. See RuleGroupsNamespaceStatusCodeType

ScraperStatusTypeDef#

# ScraperStatusTypeDef definition

class ScraperStatusTypeDef(TypedDict):
    statusCode: ScraperStatusCodeType,  # (1)
  1. See ScraperStatusCodeType

CreateWorkspaceRequestRequestTypeDef#

# CreateWorkspaceRequestRequestTypeDef definition

class CreateWorkspaceRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    clientToken: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

WorkspaceStatusTypeDef#

# WorkspaceStatusTypeDef definition

class WorkspaceStatusTypeDef(TypedDict):
    statusCode: WorkspaceStatusCodeType,  # (1)
  1. See WorkspaceStatusCodeType

DeleteAlertManagerDefinitionRequestRequestTypeDef#

# DeleteAlertManagerDefinitionRequestRequestTypeDef definition

class DeleteAlertManagerDefinitionRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    clientToken: NotRequired[str],

DeleteLoggingConfigurationRequestRequestTypeDef#

# DeleteLoggingConfigurationRequestRequestTypeDef definition

class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    clientToken: NotRequired[str],

DeleteRuleGroupsNamespaceRequestRequestTypeDef#

# DeleteRuleGroupsNamespaceRequestRequestTypeDef definition

class DeleteRuleGroupsNamespaceRequestRequestTypeDef(TypedDict):
    name: str,
    workspaceId: str,
    clientToken: NotRequired[str],

DeleteScraperRequestRequestTypeDef#

# DeleteScraperRequestRequestTypeDef definition

class DeleteScraperRequestRequestTypeDef(TypedDict):
    scraperId: str,
    clientToken: NotRequired[str],

DeleteWorkspaceRequestRequestTypeDef#

# DeleteWorkspaceRequestRequestTypeDef definition

class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    clientToken: NotRequired[str],

DescribeAlertManagerDefinitionRequestRequestTypeDef#

# DescribeAlertManagerDefinitionRequestRequestTypeDef definition

class DescribeAlertManagerDefinitionRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DescribeLoggingConfigurationRequestRequestTypeDef#

# DescribeLoggingConfigurationRequestRequestTypeDef definition

class DescribeLoggingConfigurationRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DescribeRuleGroupsNamespaceRequestRequestTypeDef#

# DescribeRuleGroupsNamespaceRequestRequestTypeDef definition

class DescribeRuleGroupsNamespaceRequestRequestTypeDef(TypedDict):
    name: str,
    workspaceId: str,

DescribeScraperRequestRequestTypeDef#

# DescribeScraperRequestRequestTypeDef definition

class DescribeScraperRequestRequestTypeDef(TypedDict):
    scraperId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeWorkspaceRequestRequestTypeDef#

# DescribeWorkspaceRequestRequestTypeDef definition

class DescribeWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

EksConfigurationOutputTypeDef#

# EksConfigurationOutputTypeDef definition

class EksConfigurationOutputTypeDef(TypedDict):
    clusterArn: str,
    subnetIds: List[str],
    securityGroupIds: NotRequired[List[str]],

EksConfigurationTypeDef#

# EksConfigurationTypeDef definition

class EksConfigurationTypeDef(TypedDict):
    clusterArn: str,
    subnetIds: Sequence[str],
    securityGroupIds: NotRequired[Sequence[str]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListRuleGroupsNamespacesRequestRequestTypeDef#

# ListRuleGroupsNamespacesRequestRequestTypeDef definition

class ListRuleGroupsNamespacesRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    maxResults: NotRequired[int],
    name: NotRequired[str],
    nextToken: NotRequired[str],

ListScrapersRequestRequestTypeDef#

# ListScrapersRequestRequestTypeDef definition

class ListScrapersRequestRequestTypeDef(TypedDict):
    filters: NotRequired[Mapping[str, Sequence[str]]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListWorkspacesRequestRequestTypeDef#

# ListWorkspacesRequestRequestTypeDef definition

class ListWorkspacesRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ScrapeConfigurationOutputTypeDef#

# ScrapeConfigurationOutputTypeDef definition

class ScrapeConfigurationOutputTypeDef(TypedDict):
    configurationBlob: NotRequired[bytes],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateLoggingConfigurationRequestRequestTypeDef#

# UpdateLoggingConfigurationRequestRequestTypeDef definition

class UpdateLoggingConfigurationRequestRequestTypeDef(TypedDict):
    logGroupArn: str,
    workspaceId: str,
    clientToken: NotRequired[str],

UpdateWorkspaceAliasRequestRequestTypeDef#

# UpdateWorkspaceAliasRequestRequestTypeDef definition

class UpdateWorkspaceAliasRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    alias: NotRequired[str],
    clientToken: NotRequired[str],

AlertManagerDefinitionDescriptionTypeDef#

# AlertManagerDefinitionDescriptionTypeDef definition

class AlertManagerDefinitionDescriptionTypeDef(TypedDict):
    createdAt: datetime,
    data: bytes,
    modifiedAt: datetime,
    status: AlertManagerDefinitionStatusTypeDef,  # (1)
  1. See AlertManagerDefinitionStatusTypeDef

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    ampConfiguration: NotRequired[AmpConfigurationTypeDef],  # (1)
  1. See AmpConfigurationTypeDef

CreateAlertManagerDefinitionRequestRequestTypeDef#

# CreateAlertManagerDefinitionRequestRequestTypeDef definition

class CreateAlertManagerDefinitionRequestRequestTypeDef(TypedDict):
    data: BlobTypeDef,
    workspaceId: str,
    clientToken: NotRequired[str],

CreateRuleGroupsNamespaceRequestRequestTypeDef#

# CreateRuleGroupsNamespaceRequestRequestTypeDef definition

class CreateRuleGroupsNamespaceRequestRequestTypeDef(TypedDict):
    data: BlobTypeDef,
    name: str,
    workspaceId: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

PutAlertManagerDefinitionRequestRequestTypeDef#

# PutAlertManagerDefinitionRequestRequestTypeDef definition

class PutAlertManagerDefinitionRequestRequestTypeDef(TypedDict):
    data: BlobTypeDef,
    workspaceId: str,
    clientToken: NotRequired[str],

PutRuleGroupsNamespaceRequestRequestTypeDef#

# PutRuleGroupsNamespaceRequestRequestTypeDef definition

class PutRuleGroupsNamespaceRequestRequestTypeDef(TypedDict):
    data: BlobTypeDef,
    name: str,
    workspaceId: str,
    clientToken: NotRequired[str],

ScrapeConfigurationTypeDef#

# ScrapeConfigurationTypeDef definition

class ScrapeConfigurationTypeDef(TypedDict):
    configurationBlob: NotRequired[BlobTypeDef],

CreateAlertManagerDefinitionResponseTypeDef#

# CreateAlertManagerDefinitionResponseTypeDef definition

class CreateAlertManagerDefinitionResponseTypeDef(TypedDict):
    status: AlertManagerDefinitionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlertManagerDefinitionStatusTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDefaultScraperConfigurationResponseTypeDef#

# GetDefaultScraperConfigurationResponseTypeDef definition

class GetDefaultScraperConfigurationResponseTypeDef(TypedDict):
    configuration: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutAlertManagerDefinitionResponseTypeDef#

# PutAlertManagerDefinitionResponseTypeDef definition

class PutAlertManagerDefinitionResponseTypeDef(TypedDict):
    status: AlertManagerDefinitionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlertManagerDefinitionStatusTypeDef
  2. See ResponseMetadataTypeDef

CreateLoggingConfigurationResponseTypeDef#

# CreateLoggingConfigurationResponseTypeDef definition

class CreateLoggingConfigurationResponseTypeDef(TypedDict):
    status: LoggingConfigurationStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigurationStatusTypeDef
  2. See ResponseMetadataTypeDef

LoggingConfigurationMetadataTypeDef#

# LoggingConfigurationMetadataTypeDef definition

class LoggingConfigurationMetadataTypeDef(TypedDict):
    createdAt: datetime,
    logGroupArn: str,
    modifiedAt: datetime,
    status: LoggingConfigurationStatusTypeDef,  # (1)
    workspace: str,
  1. See LoggingConfigurationStatusTypeDef

UpdateLoggingConfigurationResponseTypeDef#

# UpdateLoggingConfigurationResponseTypeDef definition

class UpdateLoggingConfigurationResponseTypeDef(TypedDict):
    status: LoggingConfigurationStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigurationStatusTypeDef
  2. See ResponseMetadataTypeDef

CreateRuleGroupsNamespaceResponseTypeDef#

# CreateRuleGroupsNamespaceResponseTypeDef definition

class CreateRuleGroupsNamespaceResponseTypeDef(TypedDict):
    arn: str,
    name: str,
    status: RuleGroupsNamespaceStatusTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupsNamespaceStatusTypeDef
  2. See ResponseMetadataTypeDef

PutRuleGroupsNamespaceResponseTypeDef#

# PutRuleGroupsNamespaceResponseTypeDef definition

class PutRuleGroupsNamespaceResponseTypeDef(TypedDict):
    arn: str,
    name: str,
    status: RuleGroupsNamespaceStatusTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupsNamespaceStatusTypeDef
  2. See ResponseMetadataTypeDef

RuleGroupsNamespaceDescriptionTypeDef#

# RuleGroupsNamespaceDescriptionTypeDef definition

class RuleGroupsNamespaceDescriptionTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    data: bytes,
    modifiedAt: datetime,
    name: str,
    status: RuleGroupsNamespaceStatusTypeDef,  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See RuleGroupsNamespaceStatusTypeDef

RuleGroupsNamespaceSummaryTypeDef#

# RuleGroupsNamespaceSummaryTypeDef definition

class RuleGroupsNamespaceSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    modifiedAt: datetime,
    name: str,
    status: RuleGroupsNamespaceStatusTypeDef,  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See RuleGroupsNamespaceStatusTypeDef

CreateScraperResponseTypeDef#

# CreateScraperResponseTypeDef definition

class CreateScraperResponseTypeDef(TypedDict):
    arn: str,
    scraperId: str,
    status: ScraperStatusTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScraperStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteScraperResponseTypeDef#

# DeleteScraperResponseTypeDef definition

class DeleteScraperResponseTypeDef(TypedDict):
    scraperId: str,
    status: ScraperStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScraperStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateScraperResponseTypeDef#

# UpdateScraperResponseTypeDef definition

class UpdateScraperResponseTypeDef(TypedDict):
    arn: str,
    scraperId: str,
    status: ScraperStatusTypeDef,  # (1)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScraperStatusTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkspaceResponseTypeDef#

# CreateWorkspaceResponseTypeDef definition

class CreateWorkspaceResponseTypeDef(TypedDict):
    arn: str,
    kmsKeyArn: str,
    status: WorkspaceStatusTypeDef,  # (1)
    tags: Dict[str, str],
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceStatusTypeDef
  2. See ResponseMetadataTypeDef

WorkspaceDescriptionTypeDef#

# WorkspaceDescriptionTypeDef definition

class WorkspaceDescriptionTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    status: WorkspaceStatusTypeDef,  # (1)
    workspaceId: str,
    alias: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    prometheusEndpoint: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See WorkspaceStatusTypeDef

WorkspaceSummaryTypeDef#

# WorkspaceSummaryTypeDef definition

class WorkspaceSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    status: WorkspaceStatusTypeDef,  # (1)
    workspaceId: str,
    alias: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See WorkspaceStatusTypeDef

DescribeScraperRequestScraperActiveWaitTypeDef#

# DescribeScraperRequestScraperActiveWaitTypeDef definition

class DescribeScraperRequestScraperActiveWaitTypeDef(TypedDict):
    scraperId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeScraperRequestScraperDeletedWaitTypeDef#

# DescribeScraperRequestScraperDeletedWaitTypeDef definition

class DescribeScraperRequestScraperDeletedWaitTypeDef(TypedDict):
    scraperId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeWorkspaceRequestWorkspaceActiveWaitTypeDef#

# DescribeWorkspaceRequestWorkspaceActiveWaitTypeDef definition

class DescribeWorkspaceRequestWorkspaceActiveWaitTypeDef(TypedDict):
    workspaceId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeWorkspaceRequestWorkspaceDeletedWaitTypeDef#

# DescribeWorkspaceRequestWorkspaceDeletedWaitTypeDef definition

class DescribeWorkspaceRequestWorkspaceDeletedWaitTypeDef(TypedDict):
    workspaceId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

SourceOutputTypeDef#

# SourceOutputTypeDef definition

class SourceOutputTypeDef(TypedDict):
    eksConfiguration: NotRequired[EksConfigurationOutputTypeDef],  # (1)
  1. See EksConfigurationOutputTypeDef

ListRuleGroupsNamespacesRequestListRuleGroupsNamespacesPaginateTypeDef#

# ListRuleGroupsNamespacesRequestListRuleGroupsNamespacesPaginateTypeDef definition

class ListRuleGroupsNamespacesRequestListRuleGroupsNamespacesPaginateTypeDef(TypedDict):
    workspaceId: str,
    name: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListScrapersRequestListScrapersPaginateTypeDef#

# ListScrapersRequestListScrapersPaginateTypeDef definition

class ListScrapersRequestListScrapersPaginateTypeDef(TypedDict):
    filters: NotRequired[Mapping[str, Sequence[str]]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkspacesRequestListWorkspacesPaginateTypeDef#

# ListWorkspacesRequestListWorkspacesPaginateTypeDef definition

class ListWorkspacesRequestListWorkspacesPaginateTypeDef(TypedDict):
    alias: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeAlertManagerDefinitionResponseTypeDef#

# DescribeAlertManagerDefinitionResponseTypeDef definition

class DescribeAlertManagerDefinitionResponseTypeDef(TypedDict):
    alertManagerDefinition: AlertManagerDefinitionDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlertManagerDefinitionDescriptionTypeDef
  2. See ResponseMetadataTypeDef

UpdateScraperRequestRequestTypeDef#

# UpdateScraperRequestRequestTypeDef definition

class UpdateScraperRequestRequestTypeDef(TypedDict):
    scraperId: str,
    alias: NotRequired[str],
    clientToken: NotRequired[str],
    destination: NotRequired[DestinationTypeDef],  # (1)
    scrapeConfiguration: NotRequired[ScrapeConfigurationTypeDef],  # (2)
  1. See DestinationTypeDef
  2. See ScrapeConfigurationTypeDef

DescribeLoggingConfigurationResponseTypeDef#

# DescribeLoggingConfigurationResponseTypeDef definition

class DescribeLoggingConfigurationResponseTypeDef(TypedDict):
    loggingConfiguration: LoggingConfigurationMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigurationMetadataTypeDef
  2. See ResponseMetadataTypeDef

DescribeRuleGroupsNamespaceResponseTypeDef#

# DescribeRuleGroupsNamespaceResponseTypeDef definition

class DescribeRuleGroupsNamespaceResponseTypeDef(TypedDict):
    ruleGroupsNamespace: RuleGroupsNamespaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupsNamespaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListRuleGroupsNamespacesResponseTypeDef#

# ListRuleGroupsNamespacesResponseTypeDef definition

class ListRuleGroupsNamespacesResponseTypeDef(TypedDict):
    ruleGroupsNamespaces: List[RuleGroupsNamespaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See RuleGroupsNamespaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceResponseTypeDef#

# DescribeWorkspaceResponseTypeDef definition

class DescribeWorkspaceResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListWorkspacesResponseTypeDef#

# ListWorkspacesResponseTypeDef definition

class ListWorkspacesResponseTypeDef(TypedDict):
    workspaces: List[WorkspaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See WorkspaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ScraperDescriptionTypeDef#

# ScraperDescriptionTypeDef definition

class ScraperDescriptionTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    destination: DestinationTypeDef,  # (1)
    lastModifiedAt: datetime,
    roleArn: str,
    scrapeConfiguration: ScrapeConfigurationOutputTypeDef,  # (2)
    scraperId: str,
    source: SourceOutputTypeDef,  # (3)
    status: ScraperStatusTypeDef,  # (4)
    alias: NotRequired[str],
    statusReason: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See DestinationTypeDef
  2. See ScrapeConfigurationOutputTypeDef
  3. See SourceOutputTypeDef
  4. See ScraperStatusTypeDef

ScraperSummaryTypeDef#

# ScraperSummaryTypeDef definition

class ScraperSummaryTypeDef(TypedDict):
    arn: str,
    createdAt: datetime,
    destination: DestinationTypeDef,  # (1)
    lastModifiedAt: datetime,
    roleArn: str,
    scraperId: str,
    source: SourceOutputTypeDef,  # (2)
    status: ScraperStatusTypeDef,  # (3)
    alias: NotRequired[str],
    statusReason: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See DestinationTypeDef
  2. See SourceOutputTypeDef
  3. See ScraperStatusTypeDef

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    eksConfiguration: NotRequired[EksConfigurationUnionTypeDef],  # (1)
  1. See EksConfigurationTypeDef EksConfigurationOutputTypeDef

DescribeScraperResponseTypeDef#

# DescribeScraperResponseTypeDef definition

class DescribeScraperResponseTypeDef(TypedDict):
    scraper: ScraperDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScraperDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListScrapersResponseTypeDef#

# ListScrapersResponseTypeDef definition

class ListScrapersResponseTypeDef(TypedDict):
    scrapers: List[ScraperSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ScraperSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateScraperRequestRequestTypeDef#

# CreateScraperRequestRequestTypeDef definition

class CreateScraperRequestRequestTypeDef(TypedDict):
    destination: DestinationTypeDef,  # (1)
    scrapeConfiguration: ScrapeConfigurationTypeDef,  # (2)
    source: SourceTypeDef,  # (3)
    alias: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See DestinationTypeDef
  2. See ScrapeConfigurationTypeDef
  3. See SourceTypeDef