Skip to content

ZonalStatisticsConfigInput

Source code in docs_src/capo_sagemaker_geospatial/types/zonal_statistics_config_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class ZonalStatisticsConfigInput(TypedDict, closed=True):
    zone_s3_path: "capo_sagemaker_geospatial.types.s3_uri.S3Uri"
    """<p>The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.</p>"""
    statistics: "capo_sagemaker_geospatial.types.zonal_statistics_list_input.ZonalStatisticsListInput"
    """<p>List of zonal statistics to compute.</p>"""
    target_bands: NotRequired[
        "capo_sagemaker_geospatial.types.string_list_input.StringListInput"
    ]
    """<p>Bands used in the operation. If no target bands are specified, it uses all bands available input.</p>"""
    zone_s3_path_kms_key_id: NotRequired[
        "capo_sagemaker_geospatial.types.kms_key.KmsKey"
    ]
    """<p>The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have <code>kms:GenerateDataKey</code> permission.</p> <p>The <code>KmsKeyId</code> can be any of the following formats:</p> <ul> <li> <p>// KMS Key ID</p> <p> <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key</p> <p> <code>"arn:aws:kms:&lt;region&gt;:&lt;account&gt;:key/&lt;key-id-12ab-34cd-56ef-1234567890ab&gt;"</code> </p> </li> </ul> <p>For more information about key identifiers, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">Key identifiers (KeyID)</a> in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.</p>"""

statistics instance-attribute 

statistics: ZonalStatisticsListInput

List of zonal statistics to compute.

target_bands instance-attribute 

target_bands: NotRequired[StringListInput]

Bands used in the operation. If no target bands are specified, it uses all bands available input.

zone_s3_path instance-attribute 

zone_s3_path: S3Uri

The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

zone_s3_path_kms_key_id instance-attribute 

zone_s3_path_kms_key_id: NotRequired[KmsKey]

The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.