AWS Cloud Control v1.28.0, May 19 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotcoredeviceadvisor.getSuiteDefinition

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

Using getSuiteDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSuiteDefinition(args: GetSuiteDefinitionArgs, opts?: InvokeOptions): Promise<GetSuiteDefinitionResult>
function getSuiteDefinitionOutput(args: GetSuiteDefinitionOutputArgs, opts?: InvokeOptions): Output<GetSuiteDefinitionResult>

def get_suite_definition(suite_definition_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSuiteDefinitionResult
def get_suite_definition_output(suite_definition_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSuiteDefinitionResult]

func LookupSuiteDefinition(ctx *Context, args *LookupSuiteDefinitionArgs, opts ...InvokeOption) (*LookupSuiteDefinitionResult, error)
func LookupSuiteDefinitionOutput(ctx *Context, args *LookupSuiteDefinitionOutputArgs, opts ...InvokeOption) LookupSuiteDefinitionResultOutput

> Note: This function is named LookupSuiteDefinition in the Go SDK.

public static class GetSuiteDefinition 
{
    public static Task<GetSuiteDefinitionResult> InvokeAsync(GetSuiteDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetSuiteDefinitionResult> Invoke(GetSuiteDefinitionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSuiteDefinitionResult> getSuiteDefinition(GetSuiteDefinitionArgs args, InvokeOptions options)
public static Output<GetSuiteDefinitionResult> getSuiteDefinition(GetSuiteDefinitionArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:iotcoredeviceadvisor:getSuiteDefinition
  arguments:
    # arguments dictionary

The following arguments are supported:

SuiteDefinitionId string: The unique identifier for the suite definition.

SuiteDefinitionId string: The unique identifier for the suite definition.

suiteDefinitionId String: The unique identifier for the suite definition.

suiteDefinitionId string: The unique identifier for the suite definition.

suite_definition_id str: The unique identifier for the suite definition.

suiteDefinitionId String: The unique identifier for the suite definition.

getSuiteDefinition Result

The following output properties are available:

SuiteDefinitionArn string

The Amazon Resource name for the suite definition.

SuiteDefinitionConfiguration Pulumi.AwsNative.IoTCoreDeviceAdvisor.Outputs.SuiteDefinitionConfigurationProperties

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

SuiteDefinitionId string

The unique identifier for the suite definition.

SuiteDefinitionVersion string

The suite definition version of a test suite.

Tags List<Pulumi.AwsNative.Outputs.Tag>

An array of key-value pairs to apply to this resource.

SuiteDefinitionArn string

The Amazon Resource name for the suite definition.

SuiteDefinitionConfiguration SuiteDefinitionConfigurationProperties

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

SuiteDefinitionId string

The unique identifier for the suite definition.

SuiteDefinitionVersion string

The suite definition version of a test suite.

Tags Tag

An array of key-value pairs to apply to this resource.

suiteDefinitionArn String

The Amazon Resource name for the suite definition.

suiteDefinitionConfiguration SuiteDefinitionConfigurationProperties

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

suiteDefinitionId String

The unique identifier for the suite definition.

suiteDefinitionVersion String

The suite definition version of a test suite.

tags List<Tag>

An array of key-value pairs to apply to this resource.

suiteDefinitionArn string

The Amazon Resource name for the suite definition.

suiteDefinitionConfiguration SuiteDefinitionConfigurationProperties

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

suiteDefinitionId string

The unique identifier for the suite definition.

suiteDefinitionVersion string

The suite definition version of a test suite.

tags Tag[]

An array of key-value pairs to apply to this resource.

suite_definition_arn str

The Amazon Resource name for the suite definition.

suite_definition_configuration SuiteDefinitionConfigurationProperties

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

suite_definition_id str

The unique identifier for the suite definition.

suite_definition_version str

The suite definition version of a test suite.

tags Sequence[root_Tag]

An array of key-value pairs to apply to this resource.

suiteDefinitionArn String

The Amazon Resource name for the suite definition.

suiteDefinitionConfiguration Property Map

The configuration of the Suite Definition. Listed below are the required elements of the SuiteDefinitionConfiguration .

devicePermissionRoleArn - The device permission arn.

This is a required element.

Type: String

devices - The list of configured devices under test. For more information on devices under test, see DeviceUnderTest

Not a required element.

Type: List of devices under test

intendedForQualification - The tests intended for qualification in a suite.

Not a required element.

Type: Boolean

rootGroup - The test suite root group. For more information on creating and using root groups see the Device Advisor workflow .

This is a required element.

Type: String

suiteDefinitionName - The Suite Definition Configuration name.

This is a required element.

Type: String

suiteDefinitionId String

The unique identifier for the suite definition.

suiteDefinitionVersion String

The suite definition version of a test suite.

tags List<Property Map>

An array of key-value pairs to apply to this resource.

Supporting Types

SuiteDefinitionConfigurationProperties

DevicePermissionRoleArn string

Gets the device permission ARN. This is a required parameter.

RootGroup string

Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Devices List<Pulumi.AwsNative.IoTCoreDeviceAdvisor.Inputs.SuiteDefinitionDeviceUnderTest>

Gets the devices configured.

IntendedForQualification bool

Gets the tests intended for qualification in a suite.

SuiteDefinitionName string

Gets the suite definition name. This is a required parameter.

DevicePermissionRoleArn string

Gets the device permission ARN. This is a required parameter.

RootGroup string

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Devices []SuiteDefinitionDeviceUnderTest

Gets the devices configured.

IntendedForQualification bool

Gets the tests intended for qualification in a suite.

SuiteDefinitionName string

Gets the suite definition name. This is a required parameter.

devicePermissionRoleArn String

Gets the device permission ARN. This is a required parameter.

rootGroup String

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

devices List<SuiteDefinitionDeviceUnderTest>

Gets the devices configured.

intendedForQualification Boolean

Gets the tests intended for qualification in a suite.

suiteDefinitionName String

Gets the suite definition name. This is a required parameter.

devicePermissionRoleArn string

Gets the device permission ARN. This is a required parameter.

rootGroup string

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

devices SuiteDefinitionDeviceUnderTest[]

Gets the devices configured.

intendedForQualification boolean

Gets the tests intended for qualification in a suite.

suiteDefinitionName string

Gets the suite definition name. This is a required parameter.

device_permission_role_arn str

Gets the device permission ARN. This is a required parameter.

root_group str

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

devices Sequence[SuiteDefinitionDeviceUnderTest]

Gets the devices configured.

intended_for_qualification bool

Gets the tests intended for qualification in a suite.

suite_definition_name str

Gets the suite definition name. This is a required parameter.

devicePermissionRoleArn String

Gets the device permission ARN. This is a required parameter.

rootGroup String

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

devices List<Property Map>