pulumi-aws-native 1.38.0a1761631437__py3-none-any.whl → 1.39.0a1762376209__py3-none-any.whl

pulumi_aws_native/s3vectors/index.py

@@ -0,0 +1,367 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+from ._enums import *
+from ._inputs import *
+
+__all__ = ['IndexArgs', 'Index']
+
+@pulumi.input_type
+class IndexArgs:
+    def __init__(__self__, *,
+                 data_type: pulumi.Input['IndexDataType'],
+                 dimension: pulumi.Input[_builtins.int],
+                 distance_metric: pulumi.Input['IndexDistanceMetric'],
+                 index_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 metadata_configuration: Optional[pulumi.Input['IndexMetadataConfigurationArgs']] = None,
+                 vector_bucket_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                 vector_bucket_name: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        The set of arguments for constructing a Index resource.
+        :param pulumi.Input['IndexDataType'] data_type: The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
+        :param pulumi.Input[_builtins.int] dimension: The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
+               
+               The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
+        :param pulumi.Input['IndexDistanceMetric'] distance_metric: The distance metric to be used for similarity search. Valid values are:
+               
+               - `cosine` - Measures the cosine of the angle between two vectors.
+               - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
+        :param pulumi.Input[_builtins.str] index_name: The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
+               
+               If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
+               
+               > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
+        :param pulumi.Input['IndexMetadataConfigurationArgs'] metadata_configuration: The metadata configuration for the vector index.
+        :param pulumi.Input[_builtins.str] vector_bucket_arn: The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
+        :param pulumi.Input[_builtins.str] vector_bucket_name: The name of the vector bucket that contains the vector index.
+        """
+        pulumi.set(__self__, "data_type", data_type)
+        pulumi.set(__self__, "dimension", dimension)
+        pulumi.set(__self__, "distance_metric", distance_metric)
+        if index_name is not None:
+            pulumi.set(__self__, "index_name", index_name)
+        if metadata_configuration is not None:
+            pulumi.set(__self__, "metadata_configuration", metadata_configuration)
+        if vector_bucket_arn is not None:
+            pulumi.set(__self__, "vector_bucket_arn", vector_bucket_arn)
+        if vector_bucket_name is not None:
+            pulumi.set(__self__, "vector_bucket_name", vector_bucket_name)
+
+    @_builtins.property
+    @pulumi.getter(name="dataType")
+    def data_type(self) -> pulumi.Input['IndexDataType']:
+        """
+        The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
+        """
+        return pulumi.get(self, "data_type")
+
+    @data_type.setter
+    def data_type(self, value: pulumi.Input['IndexDataType']):
+        pulumi.set(self, "data_type", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def dimension(self) -> pulumi.Input[_builtins.int]:
+        """
+        The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
+
+        The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
+        """
+        return pulumi.get(self, "dimension")
+
+    @dimension.setter
+    def dimension(self, value: pulumi.Input[_builtins.int]):
+        pulumi.set(self, "dimension", value)
+
+    @_builtins.property
+    @pulumi.getter(name="distanceMetric")
+    def distance_metric(self) -> pulumi.Input['IndexDistanceMetric']:
+        """
+        The distance metric to be used for similarity search. Valid values are:
+
+        - `cosine` - Measures the cosine of the angle between two vectors.
+        - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
+        """
+        return pulumi.get(self, "distance_metric")
+
+    @distance_metric.setter
+    def distance_metric(self, value: pulumi.Input['IndexDistanceMetric']):
+        pulumi.set(self, "distance_metric", value)
+
+    @_builtins.property
+    @pulumi.getter(name="indexName")
+    def index_name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
+
+        If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
+
+        > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
+        """
+        return pulumi.get(self, "index_name")
+
+    @index_name.setter
+    def index_name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "index_name", value)
+
+    @_builtins.property
+    @pulumi.getter(name="metadataConfiguration")
+    def metadata_configuration(self) -> Optional[pulumi.Input['IndexMetadataConfigurationArgs']]:
+        """
+        The metadata configuration for the vector index.
+        """
+        return pulumi.get(self, "metadata_configuration")
+
+    @metadata_configuration.setter
+    def metadata_configuration(self, value: Optional[pulumi.Input['IndexMetadataConfigurationArgs']]):
+        pulumi.set(self, "metadata_configuration", value)
+
+    @_builtins.property
+    @pulumi.getter(name="vectorBucketArn")
+    def vector_bucket_arn(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
+        """
+        return pulumi.get(self, "vector_bucket_arn")
+
+    @vector_bucket_arn.setter
+    def vector_bucket_arn(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "vector_bucket_arn", value)
+
+    @_builtins.property
+    @pulumi.getter(name="vectorBucketName")
+    def vector_bucket_name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The name of the vector bucket that contains the vector index.
+        """
+        return pulumi.get(self, "vector_bucket_name")
+
+    @vector_bucket_name.setter
+    def vector_bucket_name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "vector_bucket_name", value)
+
+
+@pulumi.type_token("aws-native:s3vectors:Index")
+class Index(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 data_type: Optional[pulumi.Input['IndexDataType']] = None,
+                 dimension: Optional[pulumi.Input[_builtins.int]] = None,
+                 distance_metric: Optional[pulumi.Input['IndexDistanceMetric']] = None,
+                 index_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 metadata_configuration: Optional[pulumi.Input[Union['IndexMetadataConfigurationArgs', 'IndexMetadataConfigurationArgsDict']]] = None,
+                 vector_bucket_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                 vector_bucket_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        Resource Type definition for AWS::S3Vectors::Index
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input['IndexDataType'] data_type: The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
+        :param pulumi.Input[_builtins.int] dimension: The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
+               
+               The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
+        :param pulumi.Input['IndexDistanceMetric'] distance_metric: The distance metric to be used for similarity search. Valid values are:
+               
+               - `cosine` - Measures the cosine of the angle between two vectors.
+               - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
+        :param pulumi.Input[_builtins.str] index_name: The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
+               
+               If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
+               
+               > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
+        :param pulumi.Input[Union['IndexMetadataConfigurationArgs', 'IndexMetadataConfigurationArgsDict']] metadata_configuration: The metadata configuration for the vector index.
+        :param pulumi.Input[_builtins.str] vector_bucket_arn: The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
+        :param pulumi.Input[_builtins.str] vector_bucket_name: The name of the vector bucket that contains the vector index.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: IndexArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Resource Type definition for AWS::S3Vectors::Index
+
+        :param str resource_name: The name of the resource.
+        :param IndexArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(IndexArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 data_type: Optional[pulumi.Input['IndexDataType']] = None,
+                 dimension: Optional[pulumi.Input[_builtins.int]] = None,
+                 distance_metric: Optional[pulumi.Input['IndexDistanceMetric']] = None,
+                 index_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 metadata_configuration: Optional[pulumi.Input[Union['IndexMetadataConfigurationArgs', 'IndexMetadataConfigurationArgsDict']]] = None,
+                 vector_bucket_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                 vector_bucket_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = IndexArgs.__new__(IndexArgs)
+
+            if data_type is None and not opts.urn:
+                raise TypeError("Missing required property 'data_type'")
+            __props__.__dict__["data_type"] = data_type
+            if dimension is None and not opts.urn:
+                raise TypeError("Missing required property 'dimension'")
+            __props__.__dict__["dimension"] = dimension
+            if distance_metric is None and not opts.urn:
+                raise TypeError("Missing required property 'distance_metric'")
+            __props__.__dict__["distance_metric"] = distance_metric
+            __props__.__dict__["index_name"] = index_name
+            __props__.__dict__["metadata_configuration"] = metadata_configuration
+            __props__.__dict__["vector_bucket_arn"] = vector_bucket_arn
+            __props__.__dict__["vector_bucket_name"] = vector_bucket_name
+            __props__.__dict__["creation_time"] = None
+            __props__.__dict__["index_arn"] = None
+        replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["dataType", "dimension", "distanceMetric", "indexName", "metadataConfiguration", "vectorBucketArn", "vectorBucketName"])
+        opts = pulumi.ResourceOptions.merge(opts, replace_on_changes)
+        super(Index, __self__).__init__(
+            'aws-native:s3vectors:Index',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'Index':
+        """
+        Get an existing Index resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = IndexArgs.__new__(IndexArgs)
+
+        __props__.__dict__["creation_time"] = None
+        __props__.__dict__["data_type"] = None
+        __props__.__dict__["dimension"] = None
+        __props__.__dict__["distance_metric"] = None
+        __props__.__dict__["index_arn"] = None
+        __props__.__dict__["index_name"] = None
+        __props__.__dict__["metadata_configuration"] = None
+        __props__.__dict__["vector_bucket_arn"] = None
+        __props__.__dict__["vector_bucket_name"] = None
+        return Index(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter(name="creationTime")
+    def creation_time(self) -> pulumi.Output[_builtins.str]:
+        """
+        Returns the date and time when the vector index was created.
+
+        Example: `2024-12-21T10:30:00Z`
+        """
+        return pulumi.get(self, "creation_time")
+
+    @_builtins.property
+    @pulumi.getter(name="dataType")
+    def data_type(self) -> pulumi.Output['IndexDataType']:
+        """
+        The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
+        """
+        return pulumi.get(self, "data_type")
+
+    @_builtins.property
+    @pulumi.getter
+    def dimension(self) -> pulumi.Output[_builtins.int]:
+        """
+        The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
+
+        The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
+        """
+        return pulumi.get(self, "dimension")
+
+    @_builtins.property
+    @pulumi.getter(name="distanceMetric")
+    def distance_metric(self) -> pulumi.Output['IndexDistanceMetric']:
+        """
+        The distance metric to be used for similarity search. Valid values are:
+
+        - `cosine` - Measures the cosine of the angle between two vectors.
+        - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
+        """
+        return pulumi.get(self, "distance_metric")
+
+    @_builtins.property
+    @pulumi.getter(name="indexArn")
+    def index_arn(self) -> pulumi.Output[_builtins.str]:
+        """
+        Returns the Amazon Resource Name (ARN) of the specified index.
+
+        Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
+        """
+        return pulumi.get(self, "index_arn")
+
+    @_builtins.property
+    @pulumi.getter(name="indexName")
+    def index_name(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
+
+        If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
+
+        > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
+        """
+        return pulumi.get(self, "index_name")
+
+    @_builtins.property
+    @pulumi.getter(name="metadataConfiguration")
+    def metadata_configuration(self) -> pulumi.Output[Optional['outputs.IndexMetadataConfiguration']]:
+        """
+        The metadata configuration for the vector index.
+        """
+        return pulumi.get(self, "metadata_configuration")
+
+    @_builtins.property
+    @pulumi.getter(name="vectorBucketArn")
+    def vector_bucket_arn(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
+        """
+        return pulumi.get(self, "vector_bucket_arn")
+
+    @_builtins.property
+    @pulumi.getter(name="vectorBucketName")
+    def vector_bucket_name(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The name of the vector bucket that contains the vector index.
+        """
+        return pulumi.get(self, "vector_bucket_name")
+

pulumi_aws_native/s3vectors/outputs.py

@@ -0,0 +1,129 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from ._enums import *
+
+__all__ = [
+    'IndexMetadataConfiguration',
+    'VectorBucketEncryptionConfiguration',
+    'VectorBucketPolicyPolicy',
+]
+
+@pulumi.output_type
+class IndexMetadataConfiguration(dict):
+    """
+    The metadata configuration for the vector index.
+    """
+    @staticmethod
+    def __key_warning(key: str):
+        suggest = None
+        if key == "nonFilterableMetadataKeys":
+            suggest = "non_filterable_metadata_keys"
+
+        if suggest:
+            pulumi.log.warn(f"Key '{key}' not found in IndexMetadataConfiguration. Access the value via the '{suggest}' property getter instead.")
+
+    def __getitem__(self, key: str) -> Any:
+        IndexMetadataConfiguration.__key_warning(key)
+        return super().__getitem__(key)
+
+    def get(self, key: str, default = None) -> Any:
+        IndexMetadataConfiguration.__key_warning(key)
+        return super().get(key, default)
+
+    def __init__(__self__, *,
+                 non_filterable_metadata_keys: Optional[Sequence[_builtins.str]] = None):
+        """
+        The metadata configuration for the vector index.
+        :param Sequence[_builtins.str] non_filterable_metadata_keys: Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+        """
+        if non_filterable_metadata_keys is not None:
+            pulumi.set(__self__, "non_filterable_metadata_keys", non_filterable_metadata_keys)
+
+    @_builtins.property
+    @pulumi.getter(name="nonFilterableMetadataKeys")
+    def non_filterable_metadata_keys(self) -> Optional[Sequence[_builtins.str]]:
+        """
+        Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+        """
+        return pulumi.get(self, "non_filterable_metadata_keys")
+
+
+@pulumi.output_type
+class VectorBucketEncryptionConfiguration(dict):
+    """
+    The encryption configuration for the vector bucket.
+    """
+    @staticmethod
+    def __key_warning(key: str):
+        suggest = None
+        if key == "kmsKeyArn":
+            suggest = "kms_key_arn"
+        elif key == "sseType":
+            suggest = "sse_type"
+
+        if suggest:
+            pulumi.log.warn(f"Key '{key}' not found in VectorBucketEncryptionConfiguration. Access the value via the '{suggest}' property getter instead.")
+
+    def __getitem__(self, key: str) -> Any:
+        VectorBucketEncryptionConfiguration.__key_warning(key)
+        return super().__getitem__(key)
+
+    def get(self, key: str, default = None) -> Any:
+        VectorBucketEncryptionConfiguration.__key_warning(key)
+        return super().get(key, default)
+
+    def __init__(__self__, *,
+                 kms_key_arn: Optional[_builtins.str] = None,
+                 sse_type: Optional['VectorBucketEncryptionConfigurationSseType'] = None):
+        """
+        The encryption configuration for the vector bucket.
+        :param _builtins.str kms_key_arn: AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
+        :param 'VectorBucketEncryptionConfigurationSseType' sse_type: The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+        """
+        if kms_key_arn is not None:
+            pulumi.set(__self__, "kms_key_arn", kms_key_arn)
+        if sse_type is not None:
+            pulumi.set(__self__, "sse_type", sse_type)
+
+    @_builtins.property
+    @pulumi.getter(name="kmsKeyArn")
+    def kms_key_arn(self) -> Optional[_builtins.str]:
+        """
+        AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
+        """
+        return pulumi.get(self, "kms_key_arn")
+
+    @_builtins.property
+    @pulumi.getter(name="sseType")
+    def sse_type(self) -> Optional['VectorBucketEncryptionConfigurationSseType']:
+        """
+        The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+        """
+        return pulumi.get(self, "sse_type")
+
+
+@pulumi.output_type
+class VectorBucketPolicyPolicy(dict):
+    """
+    A policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
+    """
+    def __init__(__self__):
+        """
+        A policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
+        """
+        pass
+
+