AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListInstancesAsync.

Namespace: Amazon.SupplyChain
Assembly: AWSSDK.SupplyChain.dll
Version: 3.x.y.z

Syntax

C#
public abstract ListInstancesResponse ListInstances(
         ListInstancesRequest request
)

Parameters

request
Type: Amazon.SupplyChain.Model.ListInstancesRequest

Container for the necessary parameters to execute the ListInstances service method.

Return Value


The response from the ListInstances service method, as returned by SupplyChain.

Exceptions

ExceptionCondition
AccessDeniedException You do not have the required privileges to perform this action.
ConflictException Updating or deleting a resource can cause an inconsistent state.
InternalServerException Unexpected error during processing of request.
ResourceNotFoundException Request references a resource which does not exist.
ServiceQuotaExceededException Request would cause a service quota to be exceeded.
ThrottlingException Request was denied due to request throttling.
ValidationException The input does not satisfy the constraints specified by an AWS service.

Examples

Successful ListInstance request with no input data


var client = new AmazonSupplyChainClient();
var response = client.CreateBillOfMaterialsImportJob(new CreateBillOfMaterialsImportJobRequest 
{
    ClientToken = "550e8400-e29b-41d4-a716-446655440000",
    InstanceId = "60f82bbd-71f7-4fcd-a941-472f574c5243",
    S3uri = "s3://mybucketname/pathelemene/file.csv"
});

string jobId = response.JobId;

            

Successful ListInstance request with filters


var client = new AmazonSupplyChainClient();
var response = client.CreateDataIntegrationFlow(new CreateDataIntegrationFlowRequest 
{
    Name = "trading-partner",
    InstanceId = "8850c54e-e187-4fa7-89d4-6370f165174d",
    Sources = new List<DataIntegrationFlowSource> {
        new DataIntegrationFlowSource {
            DatasetSource = new DataIntegrationFlowDatasetSourceConfiguration { DatasetIdentifier = "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1" },
            SourceName = "testSourceName1",
            SourceType = "DATASET"
        },
        new DataIntegrationFlowSource {
            DatasetSource = new DataIntegrationFlowDatasetSourceConfiguration { DatasetIdentifier = "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2" },
            SourceName = "testSourceName2",
            SourceType = "DATASET"
        }
    },
    Tags = new Dictionary<string, string> {
        { "tagKey1", "tagValue1" }
    },
    Target = new DataIntegrationFlowTarget {
        DatasetTarget = new DataIntegrationFlowDatasetTargetConfiguration { DatasetIdentifier = "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" },
        TargetType = "DATASET"
    },
    Transformation = new DataIntegrationFlowTransformation {
        SqlTransformation = new DataIntegrationFlowSQLTransformationConfiguration { Query = "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id" },
        TransformationType = "SQL"
    }
});

string name = response.Name;
string instanceId = response.InstanceId;

            

Successful ListInstance request with maxResult override


var client = new AmazonSupplyChainClient();
var response = client.ListInstances(new ListInstancesRequest 
{
    MaxResults = 1
});

List<Instance> instances = response.Instances;
string nextToken = response.NextToken;

            

Successful ListInstance request with nextToken


var client = new AmazonSupplyChainClient();
var response = client.ListInstances(new ListInstancesRequest 
{
    MaxResults = 1,
    NextToken = "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D"
});

List<Instance> instances = response.Instances;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also