Skip to content

RekognitionClient#

Index > Rekognition > RekognitionClient

Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.

RekognitionClient#

Type annotations and code completion for boto3.client("rekognition"). boto3 documentation

# RekognitionClient usage example

from boto3.session import Session
from mypy_boto3_rekognition.client import RekognitionClient

def get_rekognition_client() -> RekognitionClient:
    return Session().client("rekognition")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("rekognition").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("rekognition")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.HumanLoopQuotaExceededException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.ImageTooLargeException,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidImageFormatException,
    client.exceptions.InvalidPaginationTokenException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidPolicyRevisionIdException,
    client.exceptions.InvalidS3ObjectException,
    client.exceptions.LimitExceededException,
    client.exceptions.MalformedPolicyDocumentException,
    client.exceptions.ProvisionedThroughputExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceNotReadyException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.SessionNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.VideoTooLargeException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_rekognition.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("rekognition").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("rekognition").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

compare_faces#

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

Type annotations and code completion for boto3.client("rekognition").compare_faces method. boto3 documentation

# compare_faces method definition

def compare_faces(
    self,
    *,
    SourceImage: ImageTypeDef,  # (1)
    TargetImage: ImageTypeDef,  # (1)
    SimilarityThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (3)
) -> CompareFacesResponseTypeDef:  # (4)
    ...
  1. See ImageTypeDef
  2. See ImageTypeDef
  3. See QualityFilterType
  4. See CompareFacesResponseTypeDef 
# compare_faces method usage example with argument unpacking

kwargs: CompareFacesRequestRequestTypeDef = {  # (1)
    "SourceImage": ...,
    "TargetImage": ...,
}

parent.compare_faces(**kwargs)
  1. See CompareFacesRequestRequestTypeDef

copy_project_version#

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.

Type annotations and code completion for boto3.client("rekognition").copy_project_version method. boto3 documentation

# copy_project_version method definition

def copy_project_version(
    self,
    *,
    SourceProjectArn: str,
    SourceProjectVersionArn: str,
    DestinationProjectArn: str,
    VersionName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
    KmsKeyId: str = ...,
) -> CopyProjectVersionResponseTypeDef:  # (2)
    ...
  1. See OutputConfigTypeDef
  2. See CopyProjectVersionResponseTypeDef 
# copy_project_version method usage example with argument unpacking

kwargs: CopyProjectVersionRequestRequestTypeDef = {  # (1)
    "SourceProjectArn": ...,
    "SourceProjectVersionArn": ...,
    "DestinationProjectArn": ...,
    "VersionName": ...,
    "OutputConfig": ...,
}

parent.copy_project_version(**kwargs)
  1. See CopyProjectVersionRequestRequestTypeDef

create_collection#

Creates a collection in an AWS Region.

Type annotations and code completion for boto3.client("rekognition").create_collection method. boto3 documentation

# create_collection method definition

def create_collection(
    self,
    *,
    CollectionId: str,
    Tags: Mapping[str, str] = ...,
) -> CreateCollectionResponseTypeDef:  # (1)
    ...
  1. See CreateCollectionResponseTypeDef 
# create_collection method usage example with argument unpacking

kwargs: CreateCollectionRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.create_collection(**kwargs)
  1. See CreateCollectionRequestRequestTypeDef

create_dataset#

Creates a new Amazon Rekognition Custom Labels dataset.

Type annotations and code completion for boto3.client("rekognition").create_dataset method. boto3 documentation

# create_dataset method definition

def create_dataset(
    self,
    *,
    DatasetType: DatasetTypeType,  # (1)
    ProjectArn: str,
    DatasetSource: DatasetSourceTypeDef = ...,  # (2)
) -> CreateDatasetResponseTypeDef:  # (3)
    ...
  1. See DatasetTypeType
  2. See DatasetSourceTypeDef
  3. See CreateDatasetResponseTypeDef 
# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "DatasetType": ...,
    "ProjectArn": ...,
}

parent.create_dataset(**kwargs)
  1. See CreateDatasetRequestRequestTypeDef

create_face_liveness_session#

This API operation initiates a Face Liveness session.

Type annotations and code completion for boto3.client("rekognition").create_face_liveness_session method. boto3 documentation

# create_face_liveness_session method definition

def create_face_liveness_session(
    self,
    *,
    KmsKeyId: str = ...,
    Settings: CreateFaceLivenessSessionRequestSettingsTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
) -> CreateFaceLivenessSessionResponseTypeDef:  # (2)
    ...
  1. See CreateFaceLivenessSessionRequestSettingsTypeDef
  2. See CreateFaceLivenessSessionResponseTypeDef 
# create_face_liveness_session method usage example with argument unpacking

kwargs: CreateFaceLivenessSessionRequestRequestTypeDef = {  # (1)
    "KmsKeyId": ...,
}

parent.create_face_liveness_session(**kwargs)
  1. See CreateFaceLivenessSessionRequestRequestTypeDef

create_project#

Creates a new Amazon Rekognition Custom Labels project.

Type annotations and code completion for boto3.client("rekognition").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    ProjectName: str,
) -> CreateProjectResponseTypeDef:  # (1)
    ...
  1. See CreateProjectResponseTypeDef 
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

create_project_version#

Creates a new version of a model and begins training.

Type annotations and code completion for boto3.client("rekognition").create_project_version method. boto3 documentation

# create_project_version method definition

def create_project_version(
    self,
    *,
    ProjectArn: str,
    VersionName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    TrainingData: TrainingDataTypeDef = ...,  # (2)
    TestingData: TestingDataTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
    KmsKeyId: str = ...,
) -> CreateProjectVersionResponseTypeDef:  # (4)
    ...
  1. See OutputConfigTypeDef
  2. See TrainingDataTypeDef
  3. See TestingDataTypeDef
  4. See CreateProjectVersionResponseTypeDef 
# create_project_version method usage example with argument unpacking

kwargs: CreateProjectVersionRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "VersionName": ...,
    "OutputConfig": ...,
}

parent.create_project_version(**kwargs)
  1. See CreateProjectVersionRequestRequestTypeDef

create_stream_processor#

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

Type annotations and code completion for boto3.client("rekognition").create_stream_processor method. boto3 documentation

# create_stream_processor method definition

def create_stream_processor(
    self,
    *,
    Input: StreamProcessorInputTypeDef,  # (1)
    Output: StreamProcessorOutputTypeDef,  # (2)
    Name: str,
    Settings: StreamProcessorSettingsTypeDef,  # (3)
    RoleArn: str,
    Tags: Mapping[str, str] = ...,
    NotificationChannel: StreamProcessorNotificationChannelTypeDef = ...,  # (4)
    KmsKeyId: str = ...,
    RegionsOfInterest: Sequence[RegionOfInterestTypeDef] = ...,  # (5)
    DataSharingPreference: StreamProcessorDataSharingPreferenceTypeDef = ...,  # (6)
) -> CreateStreamProcessorResponseTypeDef:  # (7)
    ...
  1. See StreamProcessorInputTypeDef
  2. See StreamProcessorOutputTypeDef
  3. See StreamProcessorSettingsTypeDef
  4. See StreamProcessorNotificationChannelTypeDef
  5. See RegionOfInterestTypeDef
  6. See StreamProcessorDataSharingPreferenceTypeDef
  7. See CreateStreamProcessorResponseTypeDef 
# create_stream_processor method usage example with argument unpacking

kwargs: CreateStreamProcessorRequestRequestTypeDef = {  # (1)
    "Input": ...,
    "Output": ...,
    "Name": ...,
    "Settings": ...,
    "RoleArn": ...,
}

parent.create_stream_processor(**kwargs)
  1. See CreateStreamProcessorRequestRequestTypeDef

delete_collection#

Deletes the specified collection.

Type annotations and code completion for boto3.client("rekognition").delete_collection method. boto3 documentation

# delete_collection method definition

def delete_collection(
    self,
    *,
    CollectionId: str,
) -> DeleteCollectionResponseTypeDef:  # (1)
    ...
  1. See DeleteCollectionResponseTypeDef 
# delete_collection method usage example with argument unpacking

kwargs: DeleteCollectionRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.delete_collection(**kwargs)
  1. See DeleteCollectionRequestRequestTypeDef

delete_dataset#

Deletes an existing Amazon Rekognition Custom Labels dataset.

Type annotations and code completion for boto3.client("rekognition").delete_dataset method. boto3 documentation

# delete_dataset method definition

def delete_dataset(
    self,
    *,
    DatasetArn: str,
) -> Dict[str, Any]:
    ...
# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.delete_dataset(**kwargs)
  1. See DeleteDatasetRequestRequestTypeDef

delete_faces#

Deletes faces from a collection.

Type annotations and code completion for boto3.client("rekognition").delete_faces method. boto3 documentation

# delete_faces method definition

def delete_faces(
    self,
    *,
    CollectionId: str,
    FaceIds: Sequence[str],
) -> DeleteFacesResponseTypeDef:  # (1)
    ...
  1. See DeleteFacesResponseTypeDef 
# delete_faces method usage example with argument unpacking

kwargs: DeleteFacesRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "FaceIds": ...,
}

parent.delete_faces(**kwargs)
  1. See DeleteFacesRequestRequestTypeDef

delete_project#

Deletes an Amazon Rekognition Custom Labels project.

Type annotations and code completion for boto3.client("rekognition").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    ProjectArn: str,
) -> DeleteProjectResponseTypeDef:  # (1)
    ...
  1. See DeleteProjectResponseTypeDef 
# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.delete_project(**kwargs)
  1. See DeleteProjectRequestRequestTypeDef

delete_project_policy#

Deletes an existing project policy.

Type annotations and code completion for boto3.client("rekognition").delete_project_policy method. boto3 documentation

# delete_project_policy method definition

def delete_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyRevisionId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_project_policy method usage example with argument unpacking

kwargs: DeleteProjectPolicyRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "PolicyName": ...,
}

parent.delete_project_policy(**kwargs)
  1. See DeleteProjectPolicyRequestRequestTypeDef

delete_project_version#

Deletes an Amazon Rekognition Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").delete_project_version method. boto3 documentation

# delete_project_version method definition

def delete_project_version(
    self,
    *,
    ProjectVersionArn: str,
) -> DeleteProjectVersionResponseTypeDef:  # (1)
    ...
  1. See DeleteProjectVersionResponseTypeDef 
# delete_project_version method usage example with argument unpacking

kwargs: DeleteProjectVersionRequestRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
}

parent.delete_project_version(**kwargs)
  1. See DeleteProjectVersionRequestRequestTypeDef

delete_stream_processor#

Deletes the stream processor identified by Name.

Type annotations and code completion for boto3.client("rekognition").delete_stream_processor method. boto3 documentation

# delete_stream_processor method definition

def delete_stream_processor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
# delete_stream_processor method usage example with argument unpacking

kwargs: DeleteStreamProcessorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_stream_processor(**kwargs)
  1. See DeleteStreamProcessorRequestRequestTypeDef

describe_collection#

Describes the specified collection.

Type annotations and code completion for boto3.client("rekognition").describe_collection method. boto3 documentation

# describe_collection method definition

def describe_collection(
    self,
    *,
    CollectionId: str,
) -> DescribeCollectionResponseTypeDef:  # (1)
    ...
  1. See DescribeCollectionResponseTypeDef 
# describe_collection method usage example with argument unpacking

kwargs: DescribeCollectionRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.describe_collection(**kwargs)
  1. See DescribeCollectionRequestRequestTypeDef

describe_dataset#

Describes an Amazon Rekognition Custom Labels dataset.

Type annotations and code completion for boto3.client("rekognition").describe_dataset method. boto3 documentation

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    DatasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...
  1. See DescribeDatasetResponseTypeDef 
# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.describe_dataset(**kwargs)
  1. See DescribeDatasetRequestRequestTypeDef

describe_project_versions#

Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project.

Type annotations and code completion for boto3.client("rekognition").describe_project_versions method. boto3 documentation

# describe_project_versions method definition

def describe_project_versions(
    self,
    *,
    ProjectArn: str,
    VersionNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeProjectVersionsResponseTypeDef:  # (1)
    ...
  1. See DescribeProjectVersionsResponseTypeDef 
# describe_project_versions method usage example with argument unpacking

kwargs: DescribeProjectVersionsRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.describe_project_versions(**kwargs)
  1. See DescribeProjectVersionsRequestRequestTypeDef

describe_projects#

Gets information about your Amazon Rekognition Custom Labels projects.

Type annotations and code completion for boto3.client("rekognition").describe_projects method. boto3 documentation

# describe_projects method definition

def describe_projects(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ProjectNames: Sequence[str] = ...,
) -> DescribeProjectsResponseTypeDef:  # (1)
    ...
  1. See DescribeProjectsResponseTypeDef 
# describe_projects method usage example with argument unpacking

kwargs: DescribeProjectsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_projects(**kwargs)
  1. See DescribeProjectsRequestRequestTypeDef

describe_stream_processor#

Provides information about a stream processor created by CreateStreamProcessor.

Type annotations and code completion for boto3.client("rekognition").describe_stream_processor method. boto3 documentation

# describe_stream_processor method definition

def describe_stream_processor(
    self,
    *,
    Name: str,
) -> DescribeStreamProcessorResponseTypeDef:  # (1)
    ...
  1. See DescribeStreamProcessorResponseTypeDef 
# describe_stream_processor method usage example with argument unpacking

kwargs: DescribeStreamProcessorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_stream_processor(**kwargs)
  1. See DescribeStreamProcessorRequestRequestTypeDef

detect_custom_labels#

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").detect_custom_labels method. boto3 documentation

# detect_custom_labels method definition

def detect_custom_labels(
    self,
    *,
    ProjectVersionArn: str,
    Image: ImageTypeDef,  # (1)
    MaxResults: int = ...,
    MinConfidence: float = ...,
) -> DetectCustomLabelsResponseTypeDef:  # (2)
    ...
  1. See ImageTypeDef
  2. See DetectCustomLabelsResponseTypeDef 
# detect_custom_labels method usage example with argument unpacking

kwargs: DetectCustomLabelsRequestRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
    "Image": ...,
}

parent.detect_custom_labels(**kwargs)
  1. See DetectCustomLabelsRequestRequestTypeDef

detect_faces#

Detects faces within an image that is provided as input.

Type annotations and code completion for boto3.client("rekognition").detect_faces method. boto3 documentation

# detect_faces method definition

def detect_faces(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Attributes: Sequence[AttributeType] = ...,  # (2)
) -> DetectFacesResponseTypeDef:  # (3)
    ...
  1. See ImageTypeDef
  2. See AttributeType
  3. See DetectFacesResponseTypeDef 
# detect_faces method usage example with argument unpacking

kwargs: DetectFacesRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_faces(**kwargs)
  1. See DetectFacesRequestRequestTypeDef

detect_labels#

Detects instances of real-world entities within an image (JPEG or PNG) provided as input.

Type annotations and code completion for boto3.client("rekognition").detect_labels method. boto3 documentation

# detect_labels method definition

def detect_labels(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    MaxLabels: int = ...,
    MinConfidence: float = ...,
    Features: Sequence[DetectLabelsFeatureNameType] = ...,  # (2)
    Settings: DetectLabelsSettingsTypeDef = ...,  # (3)
) -> DetectLabelsResponseTypeDef:  # (4)
    ...
  1. See ImageTypeDef
  2. See DetectLabelsFeatureNameType
  3. See DetectLabelsSettingsTypeDef
  4. See DetectLabelsResponseTypeDef 
# detect_labels method usage example with argument unpacking

kwargs: DetectLabelsRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_labels(**kwargs)
  1. See DetectLabelsRequestRequestTypeDef

detect_moderation_labels#

Detects unsafe content in a specified JPEG or PNG format image.

Type annotations and code completion for boto3.client("rekognition").detect_moderation_labels method. boto3 documentation

# detect_moderation_labels method definition

def detect_moderation_labels(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    MinConfidence: float = ...,
    HumanLoopConfig: HumanLoopConfigTypeDef = ...,  # (2)
) -> DetectModerationLabelsResponseTypeDef:  # (3)
    ...
  1. See ImageTypeDef
  2. See HumanLoopConfigTypeDef
  3. See DetectModerationLabelsResponseTypeDef 
# detect_moderation_labels method usage example with argument unpacking

kwargs: DetectModerationLabelsRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_moderation_labels(**kwargs)
  1. See DetectModerationLabelsRequestRequestTypeDef

detect_protective_equipment#

Detects Personal Protective Equipment (PPE) worn by people detected in an image.

Type annotations and code completion for boto3.client("rekognition").detect_protective_equipment method. boto3 documentation

# detect_protective_equipment method definition

def detect_protective_equipment(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    SummarizationAttributes: ProtectiveEquipmentSummarizationAttributesTypeDef = ...,  # (2)
) -> DetectProtectiveEquipmentResponseTypeDef:  # (3)
    ...
  1. See ImageTypeDef
  2. See ProtectiveEquipmentSummarizationAttributesTypeDef
  3. See DetectProtectiveEquipmentResponseTypeDef 
# detect_protective_equipment method usage example with argument unpacking

kwargs: DetectProtectiveEquipmentRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_protective_equipment(**kwargs)
  1. See DetectProtectiveEquipmentRequestRequestTypeDef

detect_text#

Detects text in the input image and converts it into machine-readable text.

Type annotations and code completion for boto3.client("rekognition").detect_text method. boto3 documentation

# detect_text method definition

def detect_text(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Filters: DetectTextFiltersTypeDef = ...,  # (2)
) -> DetectTextResponseTypeDef:  # (3)
    ...
  1. See ImageTypeDef
  2. See DetectTextFiltersTypeDef
  3. See DetectTextResponseTypeDef 
# detect_text method usage example with argument unpacking

kwargs: DetectTextRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_text(**kwargs)
  1. See DetectTextRequestRequestTypeDef

distribute_dataset_entries#

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.

Type annotations and code completion for boto3.client("rekognition").distribute_dataset_entries method. boto3 documentation

# distribute_dataset_entries method definition

def distribute_dataset_entries(
    self,
    *,
    Datasets: Sequence[DistributeDatasetTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See DistributeDatasetTypeDef 
# distribute_dataset_entries method usage example with argument unpacking

kwargs: DistributeDatasetEntriesRequestRequestTypeDef = {  # (1)
    "Datasets": ...,
}

parent.distribute_dataset_entries(**kwargs)
  1. See DistributeDatasetEntriesRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("rekognition").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_celebrity_info#

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.

Type annotations and code completion for boto3.client("rekognition").get_celebrity_info method. boto3 documentation

# get_celebrity_info method definition

def get_celebrity_info(
    self,
    *,
    Id: str,
) -> GetCelebrityInfoResponseTypeDef:  # (1)
    ...
  1. See GetCelebrityInfoResponseTypeDef 
# get_celebrity_info method usage example with argument unpacking

kwargs: GetCelebrityInfoRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_celebrity_info(**kwargs)
  1. See GetCelebrityInfoRequestRequestTypeDef

get_celebrity_recognition#

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Type annotations and code completion for boto3.client("rekognition").get_celebrity_recognition method. boto3 documentation

# get_celebrity_recognition method definition

def get_celebrity_recognition(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: CelebrityRecognitionSortByType = ...,  # (1)
) -> GetCelebrityRecognitionResponseTypeDef:  # (2)
    ...
  1. See CelebrityRecognitionSortByType
  2. See GetCelebrityRecognitionResponseTypeDef 
# get_celebrity_recognition method usage example with argument unpacking

kwargs: GetCelebrityRecognitionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_celebrity_recognition(**kwargs)
  1. See GetCelebrityRecognitionRequestRequestTypeDef

get_content_moderation#

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

Type annotations and code completion for boto3.client("rekognition").get_content_moderation method. boto3 documentation

# get_content_moderation method definition

def get_content_moderation(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ContentModerationSortByType = ...,  # (1)
    AggregateBy: ContentModerationAggregateByType = ...,  # (2)
) -> GetContentModerationResponseTypeDef:  # (3)
    ...
  1. See ContentModerationSortByType
  2. See ContentModerationAggregateByType
  3. See GetContentModerationResponseTypeDef 
# get_content_moderation method usage example with argument unpacking

kwargs: GetContentModerationRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_content_moderation(**kwargs)
  1. See GetContentModerationRequestRequestTypeDef

get_face_detection#

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

Type annotations and code completion for boto3.client("rekognition").get_face_detection method. boto3 documentation

# get_face_detection method definition

def get_face_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetFaceDetectionResponseTypeDef:  # (1)
    ...
  1. See GetFaceDetectionResponseTypeDef 
# get_face_detection method usage example with argument unpacking

kwargs: GetFaceDetectionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_face_detection(**kwargs)
  1. See GetFaceDetectionRequestRequestTypeDef

get_face_liveness_session_results#

Retrieves the results of a specific Face Liveness session.

Type annotations and code completion for boto3.client("rekognition").get_face_liveness_session_results method. boto3 documentation

# get_face_liveness_session_results method definition

def get_face_liveness_session_results(
    self,
    *,
    SessionId: str,
) -> GetFaceLivenessSessionResultsResponseTypeDef:  # (1)
    ...
  1. See GetFaceLivenessSessionResultsResponseTypeDef 
# get_face_liveness_session_results method usage example with argument unpacking

kwargs: GetFaceLivenessSessionResultsRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.get_face_liveness_session_results(**kwargs)
  1. See GetFaceLivenessSessionResultsRequestRequestTypeDef

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch.

Type annotations and code completion for boto3.client("rekognition").get_face_search method. boto3 documentation

# get_face_search method definition

def get_face_search(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: FaceSearchSortByType = ...,  # (1)
) -> GetFaceSearchResponseTypeDef:  # (2)
    ...
  1. See FaceSearchSortByType
  2. See GetFaceSearchResponseTypeDef 
# get_face_search method usage example with argument unpacking

kwargs: GetFaceSearchRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_face_search(**kwargs)
  1. See GetFaceSearchRequestRequestTypeDef

get_label_detection#

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

Type annotations and code completion for boto3.client("rekognition").get_label_detection method. boto3 documentation

# get_label_detection method definition

def get_label_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: LabelDetectionSortByType = ...,  # (1)
    AggregateBy: LabelDetectionAggregateByType = ...,  # (2)
) -> GetLabelDetectionResponseTypeDef:  # (3)
    ...
  1. See LabelDetectionSortByType
  2. See LabelDetectionAggregateByType
  3. See GetLabelDetectionResponseTypeDef 
# get_label_detection method usage example with argument unpacking

kwargs: GetLabelDetectionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_label_detection(**kwargs)
  1. See GetLabelDetectionRequestRequestTypeDef

get_person_tracking#

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

Type annotations and code completion for boto3.client("rekognition").get_person_tracking method. boto3 documentation

# get_person_tracking method definition

def get_person_tracking(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: PersonTrackingSortByType = ...,  # (1)
) -> GetPersonTrackingResponseTypeDef:  # (2)
    ...
  1. See PersonTrackingSortByType
  2. See GetPersonTrackingResponseTypeDef 
# get_person_tracking method usage example with argument unpacking

kwargs: GetPersonTrackingRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_person_tracking(**kwargs)
  1. See GetPersonTrackingRequestRequestTypeDef

get_segment_detection#

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Type annotations and code completion for boto3.client("rekognition").get_segment_detection method. boto3 documentation

# get_segment_detection method definition

def get_segment_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetSegmentDetectionResponseTypeDef:  # (1)
    ...
  1. See GetSegmentDetectionResponseTypeDef 
# get_segment_detection method usage example with argument unpacking

kwargs: GetSegmentDetectionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_segment_detection(**kwargs)
  1. See GetSegmentDetectionRequestRequestTypeDef

get_text_detection#

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Type annotations and code completion for boto3.client("rekognition").get_text_detection method. boto3 documentation

# get_text_detection method definition

def get_text_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTextDetectionResponseTypeDef:  # (1)
    ...
  1. See GetTextDetectionResponseTypeDef 
# get_text_detection method usage example with argument unpacking

kwargs: GetTextDetectionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_text_detection(**kwargs)
  1. See GetTextDetectionRequestRequestTypeDef

index_faces#

Detects faces in the input image and adds them to the specified collection.

Type annotations and code completion for boto3.client("rekognition").index_faces method. boto3 documentation

# index_faces method definition

def index_faces(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    ExternalImageId: str = ...,
    DetectionAttributes: Sequence[AttributeType] = ...,  # (2)
    MaxFaces: int = ...,
    QualityFilter: QualityFilterType = ...,  # (3)
) -> IndexFacesResponseTypeDef:  # (4)
    ...
  1. See ImageTypeDef
  2. See AttributeType
  3. See QualityFilterType
  4. See IndexFacesResponseTypeDef 
# index_faces method usage example with argument unpacking

kwargs: IndexFacesRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "Image": ...,
}

parent.index_faces(**kwargs)
  1. See IndexFacesRequestRequestTypeDef

list_collections#

Returns list of collection IDs in your account.

Type annotations and code completion for boto3.client("rekognition").list_collections method. boto3 documentation

# list_collections method definition

def list_collections(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCollectionsResponseTypeDef:  # (1)
    ...
  1. See ListCollectionsResponseTypeDef 
# list_collections method usage example with argument unpacking

kwargs: ListCollectionsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_collections(**kwargs)
  1. See ListCollectionsRequestRequestTypeDef

list_dataset_entries#

Lists the entries (images) within a dataset.

Type annotations and code completion for boto3.client("rekognition").list_dataset_entries method. boto3 documentation

# list_dataset_entries method definition

def list_dataset_entries(
    self,
    *,
    DatasetArn: str,
    ContainsLabels: Sequence[str] = ...,
    Labeled: bool = ...,
    SourceRefContains: str = ...,
    HasErrors: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetEntriesResponseTypeDef:  # (1)
    ...
  1. See ListDatasetEntriesResponseTypeDef 
# list_dataset_entries method usage example with argument unpacking

kwargs: ListDatasetEntriesRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.list_dataset_entries(**kwargs)
  1. See ListDatasetEntriesRequestRequestTypeDef

list_dataset_labels#

Lists the labels in a dataset.

Type annotations and code completion for boto3.client("rekognition").list_dataset_labels method. boto3 documentation

# list_dataset_labels method definition

def list_dataset_labels(
    self,
    *,
    DatasetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetLabelsResponseTypeDef:  # (1)
    ...
  1. See ListDatasetLabelsResponseTypeDef 
# list_dataset_labels method usage example with argument unpacking

kwargs: ListDatasetLabelsRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.list_dataset_labels(**kwargs)
  1. See ListDatasetLabelsRequestRequestTypeDef

list_faces#

Returns metadata for faces in the specified collection.

Type annotations and code completion for boto3.client("rekognition").list_faces method. boto3 documentation

# list_faces method definition

def list_faces(
    self,
    *,
    CollectionId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFacesResponseTypeDef:  # (1)
    ...
  1. See ListFacesResponseTypeDef 
# list_faces method usage example with argument unpacking

kwargs: ListFacesRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.list_faces(**kwargs)
  1. See ListFacesRequestRequestTypeDef

list_project_policies#

Gets a list of the project policies attached to a project.

Type annotations and code completion for boto3.client("rekognition").list_project_policies method. boto3 documentation

# list_project_policies method definition

def list_project_policies(
    self,
    *,
    ProjectArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProjectPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListProjectPoliciesResponseTypeDef 
# list_project_policies method usage example with argument unpacking

kwargs: ListProjectPoliciesRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.list_project_policies(**kwargs)
  1. See ListProjectPoliciesRequestRequestTypeDef

list_stream_processors#

Gets a list of stream processors that you have created with CreateStreamProcessor.

Type annotations and code completion for boto3.client("rekognition").list_stream_processors method. boto3 documentation

# list_stream_processors method definition

def list_stream_processors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamProcessorsResponseTypeDef:  # (1)
    ...
  1. See ListStreamProcessorsResponseTypeDef 
# list_stream_processors method usage example with argument unpacking

kwargs: ListStreamProcessorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stream_processors(**kwargs)
  1. See ListStreamProcessorsRequestRequestTypeDef

list_tags_for_resource#

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_project_policy#

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account.

Type annotations and code completion for boto3.client("rekognition").put_project_policy method. boto3 documentation

# put_project_policy method definition

def put_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: str = ...,
) -> PutProjectPolicyResponseTypeDef:  # (1)
    ...
  1. See PutProjectPolicyResponseTypeDef 
# put_project_policy method usage example with argument unpacking

kwargs: PutProjectPolicyRequestRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "PolicyName": ...,
    "PolicyDocument": ...,
}

parent.put_project_policy(**kwargs)
  1. See PutProjectPolicyRequestRequestTypeDef

recognize_celebrities#

Returns an array of celebrities recognized in the input image.

Type annotations and code completion for boto3.client("rekognition").recognize_celebrities method. boto3 documentation

# recognize_celebrities method definition

def recognize_celebrities(
    self,
    *,
    Image: ImageTypeDef,  # (1)
) -> RecognizeCelebritiesResponseTypeDef:  # (2)
    ...
  1. See ImageTypeDef
  2. See RecognizeCelebritiesResponseTypeDef 
# recognize_celebrities method usage example with argument unpacking

kwargs: RecognizeCelebritiesRequestRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.recognize_celebrities(**kwargs)
  1. See RecognizeCelebritiesRequestRequestTypeDef

search_faces#

For a given input face ID, searches for matching faces in the collection the face belongs to.

Type annotations and code completion for boto3.client("rekognition").search_faces method. boto3 documentation

# search_faces method definition

def search_faces(
    self,
    *,
    CollectionId: str,
    FaceId: str,
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
) -> SearchFacesResponseTypeDef:  # (1)
    ...
  1. See SearchFacesResponseTypeDef 
# search_faces method usage example with argument unpacking

kwargs: SearchFacesRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "FaceId": ...,
}

parent.search_faces(**kwargs)
  1. See SearchFacesRequestRequestTypeDef

search_faces_by_image#

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces.

Type annotations and code completion for boto3.client("rekognition").search_faces_by_image method. boto3 documentation

# search_faces_by_image method definition

def search_faces_by_image(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (2)
) -> SearchFacesByImageResponseTypeDef:  # (3)
    ...
  1. See ImageTypeDef
  2. See QualityFilterType
  3. See SearchFacesByImageResponseTypeDef 
# search_faces_by_image method usage example with argument unpacking

kwargs: SearchFacesByImageRequestRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "Image": ...,
}

parent.search_faces_by_image(**kwargs)
  1. See SearchFacesByImageRequestRequestTypeDef

start_celebrity_recognition#

Starts asynchronous recognition of celebrities in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_celebrity_recognition method. boto3 documentation

# start_celebrity_recognition method definition

def start_celebrity_recognition(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartCelebrityRecognitionResponseTypeDef:  # (3)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See StartCelebrityRecognitionResponseTypeDef 
# start_celebrity_recognition method usage example with argument unpacking

kwargs: StartCelebrityRecognitionRequestRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_celebrity_recognition(**kwargs)
  1. See StartCelebrityRecognitionRequestRequestTypeDef

start_content_moderation#

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_content_moderation method. boto3 documentation

# start_content_moderation method definition

def start_content_moderation(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    MinConfidence: float = ...,
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartContentModerationResponseTypeDef:  # (3)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See StartContentModerationResponseTypeDef 
# start_content_moderation method usage example with argument unpacking

kwargs: StartContentModerationRequestRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_content_moderation(**kwargs)
  1. See StartContentModerationRequestRequestTypeDef

start_face_detection#

Starts asynchronous detection of faces in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_face_detection method. boto3 documentation

# start_face_detection method definition

def start_face_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    FaceAttributes: FaceAttributesType = ...,  # (3)
    JobTag: str = ...,
) -> StartFaceDetectionResponseTypeDef:  # (4)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See FaceAttributesType
  4. See StartFaceDetectionResponseTypeDef 
# start_face_detection method usage example with argument unpacking

kwargs: StartFaceDetectionRequestRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_face_detection(**kwargs)
  1. See StartFaceDetectionRequestRequestTypeDef

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_face_search method. boto3 documentation

# start_face_search method definition

def start_face_search(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    CollectionId: str,
    ClientRequestToken: str = ...,
    FaceMatchThreshold: float = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartFaceSearchResponseTypeDef:  # (3)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See StartFaceSearchResponseTypeDef 
# start_face_search method usage example with argument unpacking

kwargs: StartFaceSearchRequestRequestTypeDef = {  # (1)
    "Video": ...,
    "CollectionId": ...,
}

parent.start_face_search(**kwargs)
  1. See StartFaceSearchRequestRequestTypeDef

start_label_detection#

Starts asynchronous detection of labels in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_label_detection method. boto3 documentation

# start_label_detection method definition

def start_label_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    MinConfidence: float = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
    Features: Sequence[LabelDetectionFeatureNameType] = ...,  # (3)
    Settings: LabelDetectionSettingsTypeDef = ...,  # (4)
) -> StartLabelDetectionResponseTypeDef:  # (5)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See LabelDetectionFeatureNameType
  4. See LabelDetectionSettingsTypeDef
  5. See StartLabelDetectionResponseTypeDef 
# start_label_detection method usage example with argument unpacking

kwargs: StartLabelDetectionRequestRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_label_detection(**kwargs)
  1. See StartLabelDetectionRequestRequestTypeDef

start_person_tracking#

Starts the asynchronous tracking of a person's path in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_person_tracking method. boto3 documentation

# start_person_tracking method definition

def start_person_tracking(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartPersonTrackingResponseTypeDef:  # (3)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See StartPersonTrackingResponseTypeDef 
# start_person_tracking method usage example with argument unpacking

kwargs: StartPersonTrackingRequestRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_person_tracking(**kwargs)
  1. See StartPersonTrackingRequestRequestTypeDef

start_project_version#

Starts the running of the version of a model.

Type annotations and code completion for boto3.client("rekognition").start_project_version method. boto3 documentation

# start_project_version method definition

def start_project_version(
    self,
    *,
    ProjectVersionArn: str,
    MinInferenceUnits: int,
    MaxInferenceUnits: int = ...,
) -> StartProjectVersionResponseTypeDef:  # (1)
    ...
  1. See StartProjectVersionResponseTypeDef 
# start_project_version method usage example with argument unpacking

kwargs: StartProjectVersionRequestRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
    "MinInferenceUnits": ...,
}

parent.start_project_version(**kwargs)
  1. See StartProjectVersionRequestRequestTypeDef

start_segment_detection#

Starts asynchronous detection of segment detection in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_segment_detection method. boto3 documentation

# start_segment_detection method definition

def start_segment_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    SegmentTypes: Sequence[SegmentTypeType],  # (2)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (3)
    JobTag: str = ...,
    Filters: StartSegmentDetectionFiltersTypeDef = ...,  # (4)
) -> StartSegmentDetectionResponseTypeDef:  # (5)
    ...
  1. See VideoTypeDef
  2. See SegmentTypeType
  3. See NotificationChannelTypeDef
  4. See StartSegmentDetectionFiltersTypeDef
  5. See StartSegmentDetectionResponseTypeDef 
# start_segment_detection method usage example with argument unpacking

kwargs: StartSegmentDetectionRequestRequestTypeDef = {  # (1)
    "Video": ...,
    "SegmentTypes": ...,
}

parent.start_segment_detection(**kwargs)
  1. See StartSegmentDetectionRequestRequestTypeDef

start_stream_processor#

Starts processing a stream processor.

Type annotations and code completion for boto3.client("rekognition").start_stream_processor method. boto3 documentation

# start_stream_processor method definition

def start_stream_processor(
    self,
    *,
    Name: str,
    StartSelector: StreamProcessingStartSelectorTypeDef = ...,  # (1)
    StopSelector: StreamProcessingStopSelectorTypeDef = ...,  # (2)
) -> StartStreamProcessorResponseTypeDef:  # (3)
    ...
  1. See StreamProcessingStartSelectorTypeDef
  2. See StreamProcessingStopSelectorTypeDef
  3. See StartStreamProcessorResponseTypeDef 
# start_stream_processor method usage example with argument unpacking

kwargs: StartStreamProcessorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_stream_processor(**kwargs)
  1. See StartStreamProcessorRequestRequestTypeDef

start_text_detection#

Starts asynchronous detection of text in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_text_detection method. boto3 documentation

# start_text_detection method definition

def start_text_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
    Filters: StartTextDetectionFiltersTypeDef = ...,  # (3)
) -> StartTextDetectionResponseTypeDef:  # (4)
    ...
  1. See VideoTypeDef
  2. See NotificationChannelTypeDef
  3. See