Package software.amazon.awssdk.services.cleanroomsml.model

Class GetConfiguredAudienceModelResponse

    • Method Detail

      • createTime

        public final Instant createTime()

        The time at which the configured audience model was created.

        Returns:
        The time at which the configured audience model was created.

      • updateTime

        public final Instant updateTime()

        The most recent time at which the configured audience model was updated.

        Returns:
        The most recent time at which the configured audience model was updated.

      • configuredAudienceModelArn

        public final String configuredAudienceModelArn()

        The Amazon Resource Name (ARN) of the configured audience model.

        Returns:
        The Amazon Resource Name (ARN) of the configured audience model.

      • name

        public final String name()

        The name of the configured audience model.

        Returns:
        The name of the configured audience model.

      • audienceModelArn

        public final String audienceModelArn()

        The Amazon Resource Name (ARN) of the audience model used for this configured audience model.

        Returns:
        The Amazon Resource Name (ARN) of the audience model used for this configured audience model.

      • outputConfig

        public final ConfiguredAudienceModelOutputConfig outputConfig()

        The output configuration of the configured audience model

        Returns:
        The output configuration of the configured audience model

      • description

        public final String description()

        The description of the configured audience model.

        Returns:
        The description of the configured audience model.

      • sharedAudienceMetrics

        public final List<SharedAudienceMetrics> sharedAudienceMetrics()

        Whether audience metrics are shared.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSharedAudienceMetrics() method.

        Returns:
        Whether audience metrics are shared.

      • hasSharedAudienceMetrics

        public final boolean hasSharedAudienceMetrics()
        For responses, this returns true if the service returned a value for the SharedAudienceMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • sharedAudienceMetricsAsStrings

        public final List<String> sharedAudienceMetricsAsStrings()

        Whether audience metrics are shared.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSharedAudienceMetrics() method.

        Returns:
        Whether audience metrics are shared.

      • minMatchingSeedSize

        public final Integer minMatchingSeedSize()

        The minimum number of users from the seed audience that must match with users in the training data of the audience model.

        Returns:
        The minimum number of users from the seed audience that must match with users in the training data of the audience model.

      • audienceSizeConfig

        public final AudienceSizeConfig audienceSizeConfig()

        The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

        Returns:
        The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        The tags that are associated to this configured audience model.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags that are associated to this configured audience model.

      • childResourceTagOnCreatePolicy

        public final TagOnCreatePolicy childResourceTagOnCreatePolicy()

        Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

        If the service returns an enum value that is not available in the current SDK version, childResourceTagOnCreatePolicy will return TagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childResourceTagOnCreatePolicyAsString().

        Returns:
        Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
        See Also:
        TagOnCreatePolicy

      • childResourceTagOnCreatePolicyAsString

        public final String childResourceTagOnCreatePolicyAsString()

        Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

        If the service returns an enum value that is not available in the current SDK version, childResourceTagOnCreatePolicy will return TagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childResourceTagOnCreatePolicyAsString().

        Returns:
        Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
        See Also:
        TagOnCreatePolicy

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object