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

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.

Usage example

client = boto3.client("rekognition")

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

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

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

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

Method definition

def compare_faces(
    self,
    *,
    SourceImage: ImageTypeDef,  # (1)
    TargetImage: ImageTypeDef,  # (1)
    SimilarityThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (3)
) -> CompareFacesResponseTypeDef:  # (4)
    ...

Usage example with kwargs

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

parent.compare_faces(**kwargs)

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

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)
    ...

See OutputConfigTypeDef
See CopyProjectVersionResponseTypeDef

Usage example with kwargs

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

parent.copy_project_version(**kwargs)

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

Method definition

def create_collection(
    self,
    *,
    CollectionId: str,
    Tags: Mapping[str, str] = ...,
) -> CreateCollectionResponseTypeDef:  # (1)
    ...

See CreateCollectionResponseTypeDef

Usage example with kwargs

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

parent.create_collection(**kwargs)

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

Method definition

def create_dataset(
    self,
    *,
    DatasetType: DatasetTypeType,  # (1)
    ProjectArn: str,
    DatasetSource: DatasetSourceTypeDef = ...,  # (2)
) -> CreateDatasetResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.create_dataset(**kwargs)

See CreateDatasetRequestRequestTypeDef

create_project

Creates a new Amazon Rekognition Custom Labels project.

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

Method definition

def create_project(
    self,
    *,
    ProjectName: str,
) -> CreateProjectResponseTypeDef:  # (1)
    ...

See CreateProjectResponseTypeDef

Usage example with kwargs

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

parent.create_project(**kwargs)

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

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)
    ...

Usage example with kwargs

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

parent.create_project_version(**kwargs)

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

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)
    ...

Usage example with kwargs

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

parent.create_stream_processor(**kwargs)

See CreateStreamProcessorRequestRequestTypeDef

delete_collection

Deletes the specified collection.

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

Method definition

def delete_collection(
    self,
    *,
    CollectionId: str,
) -> DeleteCollectionResponseTypeDef:  # (1)
    ...

See DeleteCollectionResponseTypeDef

Usage example with kwargs

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

parent.delete_collection(**kwargs)

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

Method definition

def delete_dataset(
    self,
    *,
    DatasetArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_dataset(**kwargs)

See DeleteDatasetRequestRequestTypeDef

delete_faces

Deletes faces from a collection.

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

Method definition

def delete_faces(
    self,
    *,
    CollectionId: str,
    FaceIds: Sequence[str],
) -> DeleteFacesResponseTypeDef:  # (1)
    ...

See DeleteFacesResponseTypeDef

Usage example with kwargs

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

parent.delete_faces(**kwargs)

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

Method definition

def delete_project(
    self,
    *,
    ProjectArn: str,
) -> DeleteProjectResponseTypeDef:  # (1)
    ...

See DeleteProjectResponseTypeDef

Usage example with kwargs

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

parent.delete_project(**kwargs)

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

Method definition

def delete_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyRevisionId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_project_policy(**kwargs)

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

Method definition

def delete_project_version(
    self,
    *,
    ProjectVersionArn: str,
) -> DeleteProjectVersionResponseTypeDef:  # (1)
    ...

See DeleteProjectVersionResponseTypeDef

Usage example with kwargs

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

parent.delete_project_version(**kwargs)

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

Method definition

def delete_stream_processor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_stream_processor(**kwargs)

See DeleteStreamProcessorRequestRequestTypeDef

describe_collection

Describes the specified collection.

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

Method definition

def describe_collection(
    self,
    *,
    CollectionId: str,
) -> DescribeCollectionResponseTypeDef:  # (1)
    ...

See DescribeCollectionResponseTypeDef

Usage example with kwargs

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

parent.describe_collection(**kwargs)

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

Method definition

def describe_dataset(
    self,
    *,
    DatasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

See DescribeDatasetResponseTypeDef

Usage example with kwargs

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

parent.describe_dataset(**kwargs)

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

Method definition

def describe_project_versions(
    self,
    *,
    ProjectArn: str,
    VersionNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeProjectVersionsResponseTypeDef:  # (1)
    ...

See DescribeProjectVersionsResponseTypeDef

Usage example with kwargs

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

parent.describe_project_versions(**kwargs)

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

Method definition

def describe_projects(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ProjectNames: Sequence[str] = ...,
) -> DescribeProjectsResponseTypeDef:  # (1)
    ...

See DescribeProjectsResponseTypeDef

Usage example with kwargs

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

parent.describe_projects(**kwargs)

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

Method definition

def describe_stream_processor(
    self,
    *,
    Name: str,
) -> DescribeStreamProcessorResponseTypeDef:  # (1)
    ...

See DescribeStreamProcessorResponseTypeDef

Usage example with kwargs

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

parent.describe_stream_processor(**kwargs)

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

Method definition

def detect_custom_labels(
    self,
    *,
    ProjectVersionArn: str,
    Image: ImageTypeDef,  # (1)
    MaxResults: int = ...,
    MinConfidence: float = ...,
) -> DetectCustomLabelsResponseTypeDef:  # (2)
    ...

See ImageTypeDef
See DetectCustomLabelsResponseTypeDef

Usage example with kwargs

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

parent.detect_custom_labels(**kwargs)

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

Method definition

def detect_faces(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Attributes: Sequence[AttributeType] = ...,  # (2)
) -> DetectFacesResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.detect_faces(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.detect_labels(**kwargs)

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

Method definition

def detect_moderation_labels(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    MinConfidence: float = ...,
    HumanLoopConfig: HumanLoopConfigTypeDef = ...,  # (2)
) -> DetectModerationLabelsResponseTypeDef:  # (3)
    ...

See ImageTypeDef
See HumanLoopConfigTypeDef
See DetectModerationLabelsResponseTypeDef

Usage example with kwargs

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

parent.detect_moderation_labels(**kwargs)

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

Method definition

def detect_protective_equipment(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    SummarizationAttributes: ProtectiveEquipmentSummarizationAttributesTypeDef = ...,  # (2)
) -> DetectProtectiveEquipmentResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.detect_protective_equipment(**kwargs)

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

Method definition

def detect_text(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Filters: DetectTextFiltersTypeDef = ...,  # (2)
) -> DetectTextResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.detect_text(**kwargs)

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

Method definition

def distribute_dataset_entries(
    self,
    *,
    Datasets: Sequence[DistributeDatasetTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

See DistributeDatasetTypeDef

Usage example with kwargs

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

parent.distribute_dataset_entries(**kwargs)

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

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

Method definition

def get_celebrity_info(
    self,
    *,
    Id: str,
) -> GetCelebrityInfoResponseTypeDef:  # (1)
    ...

See GetCelebrityInfoResponseTypeDef

Usage example with kwargs

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

parent.get_celebrity_info(**kwargs)

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

Method definition

def get_celebrity_recognition(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: CelebrityRecognitionSortByType = ...,  # (1)
) -> GetCelebrityRecognitionResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.get_celebrity_recognition(**kwargs)

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

Method definition

def get_content_moderation(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ContentModerationSortByType = ...,  # (1)
) -> GetContentModerationResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.get_content_moderation(**kwargs)

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

Method definition

def get_face_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetFaceDetectionResponseTypeDef:  # (1)
    ...

See GetFaceDetectionResponseTypeDef

Usage example with kwargs

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

parent.get_face_detection(**kwargs)

See GetFaceDetectionRequestRequestTypeDef

get_face_search

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

Method definition

def get_face_search(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: FaceSearchSortByType = ...,  # (1)
) -> GetFaceSearchResponseTypeDef:  # (2)
    ...

See FaceSearchSortByType
See GetFaceSearchResponseTypeDef

Usage example with kwargs

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

parent.get_face_search(**kwargs)

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

Method definition

def get_label_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: LabelDetectionSortByType = ...,  # (1)
    AggregateBy: LabelDetectionAggregateByType = ...,  # (2)
) -> GetLabelDetectionResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.get_label_detection(**kwargs)

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

Method definition

def get_person_tracking(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: PersonTrackingSortByType = ...,  # (1)
) -> GetPersonTrackingResponseTypeDef:  # (2)
    ...

See PersonTrackingSortByType
See GetPersonTrackingResponseTypeDef

Usage example with kwargs

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

parent.get_person_tracking(**kwargs)

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

Method definition

def get_segment_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetSegmentDetectionResponseTypeDef:  # (1)
    ...

See GetSegmentDetectionResponseTypeDef

Usage example with kwargs

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

parent.get_segment_detection(**kwargs)

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

Method definition

def get_text_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTextDetectionResponseTypeDef:  # (1)
    ...

See GetTextDetectionResponseTypeDef

Usage example with kwargs

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

parent.get_text_detection(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.index_faces(**kwargs)

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

Method definition

def list_collections(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCollectionsResponseTypeDef:  # (1)
    ...

See ListCollectionsResponseTypeDef

Usage example with kwargs

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

parent.list_collections(**kwargs)

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

Method definition

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

See ListDatasetEntriesResponseTypeDef

Usage example with kwargs

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

parent.list_dataset_entries(**kwargs)

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

Method definition

def list_dataset_labels(
    self,
    *,
    DatasetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetLabelsResponseTypeDef:  # (1)
    ...

See ListDatasetLabelsResponseTypeDef

Usage example with kwargs

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

parent.list_dataset_labels(**kwargs)

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

Method definition

def list_faces(
    self,
    *,
    CollectionId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFacesResponseTypeDef:  # (1)
    ...

See ListFacesResponseTypeDef

Usage example with kwargs

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

parent.list_faces(**kwargs)

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

Method definition

def list_project_policies(
    self,
    *,
    ProjectArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProjectPoliciesResponseTypeDef:  # (1)
    ...

See ListProjectPoliciesResponseTypeDef

Usage example with kwargs

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

parent.list_project_policies(**kwargs)

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

Method definition

def list_stream_processors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamProcessorsResponseTypeDef:  # (1)
    ...

See ListStreamProcessorsResponseTypeDef

Usage example with kwargs

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

parent.list_stream_processors(**kwargs)

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

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

Method definition

def put_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: str = ...,
) -> PutProjectPolicyResponseTypeDef:  # (1)
    ...

See PutProjectPolicyResponseTypeDef

Usage example with kwargs

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

parent.put_project_policy(**kwargs)

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

Method definition

def recognize_celebrities(
    self,
    *,
    Image: ImageTypeDef,  # (1)
) -> RecognizeCelebritiesResponseTypeDef:  # (2)
    ...

See ImageTypeDef
See RecognizeCelebritiesResponseTypeDef

Usage example with kwargs

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

parent.recognize_celebrities(**kwargs)

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

Method definition

def search_faces(
    self,
    *,
    CollectionId: str,
    FaceId: str,
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
) -> SearchFacesResponseTypeDef:  # (1)
    ...

See SearchFacesResponseTypeDef

Usage example with kwargs

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

parent.search_faces(**kwargs)

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

Method definition

def search_faces_by_image(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (2)
) -> SearchFacesByImageResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.search_faces_by_image(**kwargs)

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

Method definition

def start_celebrity_recognition(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartCelebrityRecognitionResponseTypeDef:  # (3)
    ...

See VideoTypeDef
See NotificationChannelTypeDef
See StartCelebrityRecognitionResponseTypeDef

Usage example with kwargs

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

parent.start_celebrity_recognition(**kwargs)

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

Method definition

def start_content_moderation(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    MinConfidence: float = ...,
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartContentModerationResponseTypeDef:  # (3)
    ...

See VideoTypeDef
See NotificationChannelTypeDef
See StartContentModerationResponseTypeDef

Usage example with kwargs

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

parent.start_content_moderation(**kwargs)

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

Method definition

def start_face_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    FaceAttributes: FaceAttributesType = ...,  # (3)
    JobTag: str = ...,
) -> StartFaceDetectionResponseTypeDef:  # (4)
    ...

Usage example with kwargs

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

parent.start_face_detection(**kwargs)

See StartFaceDetectionRequestRequestTypeDef

start_face_search

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

Method definition

def start_face_search(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    CollectionId: str,
    ClientRequestToken: str = ...,
    FaceMatchThreshold: float = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartFaceSearchResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.start_face_search(**kwargs)

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

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)
    ...

Usage example with kwargs

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

parent.start_label_detection(**kwargs)

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

Method definition

def start_person_tracking(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartPersonTrackingResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.start_person_tracking(**kwargs)

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

Method definition

def start_project_version(
    self,
    *,
    ProjectVersionArn: str,
    MinInferenceUnits: int,
    MaxInferenceUnits: int = ...,
) -> StartProjectVersionResponseTypeDef:  # (1)
    ...

See StartProjectVersionResponseTypeDef

Usage example with kwargs

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

parent.start_project_version(**kwargs)

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

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)
    ...

See VideoTypeDef
See SegmentTypeType
See NotificationChannelTypeDef
See StartSegmentDetectionFiltersTypeDef
See StartSegmentDetectionResponseTypeDef

Usage example with kwargs

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

parent.start_segment_detection(**kwargs)

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

Method definition

def start_stream_processor(
    self,
    *,
    Name: str,
    StartSelector: StreamProcessingStartSelectorTypeDef = ...,  # (1)
    StopSelector: StreamProcessingStopSelectorTypeDef = ...,  # (2)
) -> StartStreamProcessorResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.start_stream_processor(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.start_text_detection(**kwargs)

See StartTextDetectionRequestRequestTypeDef

stop_project_version

Stops a running model.

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

Method definition

def stop_project_version(
    self,
    *,
    ProjectVersionArn: str,
) -> StopProjectVersionResponseTypeDef:  # (1)
    ...

See StopProjectVersionResponseTypeDef

Usage example with kwargs

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

parent.stop_project_version(**kwargs)

See StopProjectVersionRequestRequestTypeDef

stop_stream_processor

Stops a running stream processor that was created by CreateStreamProcessor.

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

Method definition

def stop_stream_processor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.stop_stream_processor(**kwargs)

See StopStreamProcessorRequestRequestTypeDef

tag_resource

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.tag_resource(**kwargs)

See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

See UntagResourceRequestRequestTypeDef

update_dataset_entries

Adds or updates one or more entries (images) in a dataset.

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

Method definition

def update_dataset_entries(
    self,
    *,
    DatasetArn: str,
    Changes: DatasetChangesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

See DatasetChangesTypeDef

Usage example with kwargs

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

parent.update_dataset_entries(**kwargs)

See UpdateDatasetEntriesRequestRequestTypeDef

update_stream_processor

Allows you to update a stream processor.

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

Method definition

def update_stream_processor(
    self,
    *,
    Name: str,
    SettingsForUpdate: StreamProcessorSettingsForUpdateTypeDef = ...,  # (1)
    RegionsOfInterestForUpdate: Sequence[RegionOfInterestTypeDef] = ...,  # (2)
    DataSharingPreferenceForUpdate: StreamProcessorDataSharingPreferenceTypeDef = ...,  # (3)
    ParametersToDelete: Sequence[StreamProcessorParameterToDeleteType] = ...,  # (4)
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_stream_processor(**kwargs)

See UpdateStreamProcessorRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("rekognition").get_paginator method with overloads.

client.get_paginator("describe_project_versions") -> DescribeProjectVersionsPaginator
client.get_paginator("describe_projects") -> DescribeProjectsPaginator
client.get_paginator("list_collections") -> ListCollectionsPaginator
client.get_paginator("list_dataset_entries") -> ListDatasetEntriesPaginator
client.get_paginator("list_dataset_labels") -> ListDatasetLabelsPaginator
client.get_paginator("list_faces") -> ListFacesPaginator
client.get_paginator("list_project_policies") -> ListProjectPoliciesPaginator
client.get_paginator("list_stream_processors") -> ListStreamProcessorsPaginator

get_waiter

Type annotations and code completion for boto3.client("rekognition").get_waiter method with overloads.

client.get_waiter("project_version_running") -> ProjectVersionRunningWaiter
client.get_waiter("project_version_training_completed") -> ProjectVersionTrainingCompletedWaiter