1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. getClientsBandwidthUsageHistory
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

meraki.organizations.getClientsBandwidthUsageHistory

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.organizations.getClientsBandwidthUsageHistory({
        organizationId: "string",
        t0: "string",
        t1: "string",
        timespan: 1,
    });
    export const merakiOrganizationsClientsBandwidthUsageHistoryExample = example.then(example => example.items);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_clients_bandwidth_usage_history(organization_id="string",
        t0="string",
        t1="string",
        timespan=1)
    pulumi.export("merakiOrganizationsClientsBandwidthUsageHistoryExample", example.items)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.GetClientsBandwidthUsageHistory(ctx, &organizations.GetClientsBandwidthUsageHistoryArgs{
    			OrganizationId: "string",
    			T0:             pulumi.StringRef("string"),
    			T1:             pulumi.StringRef("string"),
    			Timespan:       pulumi.Float64Ref(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsClientsBandwidthUsageHistoryExample", example.Items)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetClientsBandwidthUsageHistory.Invoke(new()
        {
            OrganizationId = "string",
            T0 = "string",
            T1 = "string",
            Timespan = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsClientsBandwidthUsageHistoryExample"] = example.Apply(getClientsBandwidthUsageHistoryResult => getClientsBandwidthUsageHistoryResult.Items),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.inputs.GetClientsBandwidthUsageHistoryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = OrganizationsFunctions.getClientsBandwidthUsageHistory(GetClientsBandwidthUsageHistoryArgs.builder()
                .organizationId("string")
                .t0("string")
                .t1("string")
                .timespan(1)
                .build());
    
            ctx.export("merakiOrganizationsClientsBandwidthUsageHistoryExample", example.applyValue(getClientsBandwidthUsageHistoryResult -> getClientsBandwidthUsageHistoryResult.items()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getClientsBandwidthUsageHistory
          Arguments:
            organizationId: string
            t0: string
            t1: string
            timespan: 1
    outputs:
      merakiOrganizationsClientsBandwidthUsageHistoryExample: ${example.items}
    

    Using getClientsBandwidthUsageHistory

    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 getClientsBandwidthUsageHistory(args: GetClientsBandwidthUsageHistoryArgs, opts?: InvokeOptions): Promise<GetClientsBandwidthUsageHistoryResult>
    function getClientsBandwidthUsageHistoryOutput(args: GetClientsBandwidthUsageHistoryOutputArgs, opts?: InvokeOptions): Output<GetClientsBandwidthUsageHistoryResult>
    def get_clients_bandwidth_usage_history(organization_id: Optional[str] = None,
                                            t0: Optional[str] = None,
                                            t1: Optional[str] = None,
                                            timespan: Optional[float] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetClientsBandwidthUsageHistoryResult
    def get_clients_bandwidth_usage_history_output(organization_id: Optional[pulumi.Input[str]] = None,
                                            t0: Optional[pulumi.Input[str]] = None,
                                            t1: Optional[pulumi.Input[str]] = None,
                                            timespan: Optional[pulumi.Input[float]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetClientsBandwidthUsageHistoryResult]
    func GetClientsBandwidthUsageHistory(ctx *Context, args *GetClientsBandwidthUsageHistoryArgs, opts ...InvokeOption) (*GetClientsBandwidthUsageHistoryResult, error)
    func GetClientsBandwidthUsageHistoryOutput(ctx *Context, args *GetClientsBandwidthUsageHistoryOutputArgs, opts ...InvokeOption) GetClientsBandwidthUsageHistoryResultOutput

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

    public static class GetClientsBandwidthUsageHistory 
    {
        public static Task<GetClientsBandwidthUsageHistoryResult> InvokeAsync(GetClientsBandwidthUsageHistoryArgs args, InvokeOptions? opts = null)
        public static Output<GetClientsBandwidthUsageHistoryResult> Invoke(GetClientsBandwidthUsageHistoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClientsBandwidthUsageHistoryResult> getClientsBandwidthUsageHistory(GetClientsBandwidthUsageHistoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getClientsBandwidthUsageHistory:getClientsBandwidthUsageHistory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

    getClientsBandwidthUsageHistory Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetClientsBandwidthUsageHistoryItem>
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetClientsBandwidthUsageHistoryItem
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    OrganizationId string
    organizationId path parameter. Organization ID
    T0 string
    t0 query parameter. The beginning of the timespan for the data.
    T1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    Timespan float64
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetClientsBandwidthUsageHistoryItem>
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Double
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetClientsBandwidthUsageHistoryItem[]
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    organizationId string
    organizationId path parameter. Organization ID
    t0 string
    t0 query parameter. The beginning of the timespan for the data.
    t1 string
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetClientsBandwidthUsageHistoryItem]
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    organization_id str
    organizationId path parameter. Organization ID
    t0 str
    t0 query parameter. The beginning of the timespan for the data.
    t1 str
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan float
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizationClientsBandwidthUsageHistory
    organizationId String
    organizationId path parameter. Organization ID
    t0 String
    t0 query parameter. The beginning of the timespan for the data.
    t1 String
    t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
    timespan Number
    timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

    Supporting Types

    GetClientsBandwidthUsageHistoryItem

    Downstream int
    Downloaded data, in mbps.
    Total int
    Total bandwidth usage, in mbps.
    Ts string
    Timestamp for the bandwidth usage snapshot.
    Upstream int
    Uploaded data, in mbps.
    Downstream int
    Downloaded data, in mbps.
    Total int
    Total bandwidth usage, in mbps.
    Ts string
    Timestamp for the bandwidth usage snapshot.
    Upstream int
    Uploaded data, in mbps.
    downstream Integer
    Downloaded data, in mbps.
    total Integer
    Total bandwidth usage, in mbps.
    ts String
    Timestamp for the bandwidth usage snapshot.
    upstream Integer
    Uploaded data, in mbps.
    downstream number
    Downloaded data, in mbps.
    total number
    Total bandwidth usage, in mbps.
    ts string
    Timestamp for the bandwidth usage snapshot.
    upstream number
    Uploaded data, in mbps.
    downstream int
    Downloaded data, in mbps.
    total int
    Total bandwidth usage, in mbps.
    ts str
    Timestamp for the bandwidth usage snapshot.
    upstream int
    Uploaded data, in mbps.
    downstream Number
    Downloaded data, in mbps.
    total Number
    Total bandwidth usage, in mbps.
    ts String
    Timestamp for the bandwidth usage snapshot.
    upstream Number
    Uploaded data, in mbps.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi