AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the AWS Elemental MediaTailor PutFunction API operation.

Syntax

Write-EMTFunction
-AwsServiceRequestConfiguration_Body <String>
-HttpRequestConfiguration_Body <String>
-VastRequestConfiguration_Body <String>
-Description <String>
-FunctionId <String>
-ConcurrentExecutorConfiguration_FunctionList <FunctionRef[]>
-SequentialExecutorConfiguration_FunctionList <FunctionRef[]>
-FunctionType <FunctionType>
-AwsServiceRequestConfiguration_Header <Hashtable>
-HttpRequestConfiguration_Header <Hashtable>
-VastRequestConfiguration_Header <Hashtable>
-AwsServiceRequestConfiguration_Cache_Key <String>
-HttpRequestConfiguration_Cache_Key <String>
-VastRequestConfiguration_Cache_Key <String>
-ConcurrentExecutorConfiguration_MaxConcurrency <Int32>
-AwsServiceRequestConfiguration_MethodType <MethodType>
-HttpRequestConfiguration_MethodType <MethodType>
-VastRequestConfiguration_MethodType <MethodType>
-AwsServiceRequestConfiguration_Output <Hashtable>
-ConcurrentExecutorConfiguration_Output <Hashtable>
-CustomOutputConfiguration_Output <Hashtable>
-HttpRequestConfiguration_Output <Hashtable>
-SequentialExecutorConfiguration_Output <Hashtable>
-VastRequestConfiguration_Output <Hashtable>
-AwsServiceRequestConfiguration_RequestTimeoutMillisecond <Int32>
-HttpRequestConfiguration_RequestTimeoutMillisecond <Int32>
-VastRequestConfiguration_RequestTimeoutMillisecond <Int32>
-AwsServiceRequestConfiguration_Runtime <RuntimeType>
-ConcurrentExecutorConfiguration_Runtime <RuntimeType>
-CustomOutputConfiguration_Runtime <RuntimeType>
-HttpRequestConfiguration_Runtime <RuntimeType>
-SequentialExecutorConfiguration_Runtime <RuntimeType>
-VastRequestConfiguration_Runtime <RuntimeType>
-Tag <Hashtable>
-AwsServiceRequestConfiguration_TargetRegion <String>
-AwsServiceRequestConfiguration_TargetService <String>
-ConcurrentExecutorConfiguration_TimeoutMillisecond <Int32>
-SequentialExecutorConfiguration_TimeoutMillisecond <Int32>
-AwsServiceRequestConfiguration_Cache_TtlMaximumSecond <Int32>
-HttpRequestConfiguration_Cache_TtlMaximumSecond <Int32>
-VastRequestConfiguration_Cache_TtlMaximumSecond <Int32>
-AwsServiceRequestConfiguration_Cache_TtlMinimumSecond <Int32>
-HttpRequestConfiguration_Cache_TtlMinimumSecond <Int32>
-VastRequestConfiguration_Cache_TtlMinimumSecond <Int32>
-AwsServiceRequestConfiguration_Url <String>
-HttpRequestConfiguration_Url <String>
-VastRequestConfiguration_Url <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaTailorConfig>

Description

Creates or updates a function. A function defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. For more information about functions, see Working with functions in the MediaTailor User Guide.

Parameters

-AwsServiceRequestConfiguration_Body <String>
An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_Cache_Key <String>
A JSONata expression that MediaTailor evaluates to a custom cache key. By default, the cache key is a hash of the HTTP URL, the request body, and the HTTP method; request headers are not included. You can specify a custom cache key expression to vary caching by request headers and more. The evaluated key must be smaller than 1 KB; otherwise the HTTP function will fail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_Cache_TtlMaximumSecond <Int32>
The upper bound, in seconds, on how long MediaTailor caches a response. This value must be greater than or equal to TtlMinimumSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsServiceRequestConfiguration_Cache_TtlMaximumSeconds
-AwsServiceRequestConfiguration_Cache_TtlMinimumSecond <Int32>
The lower bound, in seconds, on how long MediaTailor caches a response. MediaTailor also uses this value as the cache duration when a response has no Cache-Controlmax-age directive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsServiceRequestConfiguration_Cache_TtlMinimumSeconds
-AwsServiceRequestConfiguration_Header <Hashtable>
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsServiceRequestConfiguration_Headers
-AwsServiceRequestConfiguration_MethodType <MethodType>
Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:
  • GET – Retrieves data from the target service.
  • POST – Submits a request body to the target service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_Output <Hashtable>
A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_RequestTimeoutMillisecond <Int32>
The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsServiceRequestConfiguration_RequestTimeoutMilliseconds
-AwsServiceRequestConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_TargetRegion <String>
The AWS Region for the target service. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_TargetService <String>
The AWS service to call. Valid value: elemental-inference (AWS Elemental Inference).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsServiceRequestConfiguration_Url <String>
An expression that evaluates to the endpoint URL for the target AWS service API operation. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaTailorConfig>
Amazon.PowerShell.Cmdlets.EMT.AmazonMediaTailorClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConcurrentExecutorConfiguration_FunctionList <FunctionRef[]>
The list of child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConcurrentExecutorConfiguration_MaxConcurrency <Int32>
The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConcurrentExecutorConfiguration_Output <Hashtable>
A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConcurrentExecutorConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConcurrentExecutorConfiguration_TimeoutMillisecond <Int32>
The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConcurrentExecutorConfiguration_TimeoutMilliseconds
-CustomOutputConfiguration_Output <Hashtable>
A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.variant), and each value is an expression that MediaTailor evaluates at runtime against the current session state. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomOutputConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FunctionId <String>
The identifier of the function. The identifier must be unique within your account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FunctionType <FunctionType>
The type of the function, which determines what the function can do at runtime. Valid values:
  • CUSTOM_OUTPUT – Evaluates expressions and produces output bindings with no external calls.
  • HTTP_REQUEST – Makes an HTTP call to an external service and evaluates output expressions that can reference the response.
  • AWS_SERVICE_REQUEST – Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.
  • VAST_REQUEST – Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.
  • SEQUENTIAL_EXECUTOR – Runs a sequence of child functions in order, passing data between steps through temporary data.
  • CONCURRENT_EXECUTOR – Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.
For more information, see Function types and composition in the MediaTailor User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_Body <String>
An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_Cache_Key <String>
A JSONata expression that MediaTailor evaluates to a custom cache key. By default, the cache key is a hash of the HTTP URL, the request body, and the HTTP method; request headers are not included. You can specify a custom cache key expression to vary caching by request headers and more. The evaluated key must be smaller than 1 KB; otherwise the HTTP function will fail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_Cache_TtlMaximumSecond <Int32>
The upper bound, in seconds, on how long MediaTailor caches a response. This value must be greater than or equal to TtlMinimumSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHttpRequestConfiguration_Cache_TtlMaximumSeconds
-HttpRequestConfiguration_Cache_TtlMinimumSecond <Int32>
The lower bound, in seconds, on how long MediaTailor caches a response. MediaTailor also uses this value as the cache duration when a response has no Cache-Controlmax-age directive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHttpRequestConfiguration_Cache_TtlMinimumSeconds
-HttpRequestConfiguration_Header <Hashtable>
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHttpRequestConfiguration_Headers
-HttpRequestConfiguration_MethodType <MethodType>
The HTTP method for the request. Valid values: GET and POST.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_Output <Hashtable>
A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_RequestTimeoutMillisecond <Int32>
The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHttpRequestConfiguration_RequestTimeoutMilliseconds
-HttpRequestConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpRequestConfiguration_Url <String>
An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaTailor.Model.PutFunctionResponse). Specifying the name of a property of type Amazon.MediaTailor.Model.PutFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SequentialExecutorConfiguration_FunctionList <FunctionRef[]>
An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SequentialExecutorConfiguration_Output <Hashtable>
An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SequentialExecutorConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SequentialExecutorConfiguration_TimeoutMillisecond <Int32>
The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSequentialExecutorConfiguration_TimeoutMilliseconds
-Tag <Hashtable>
The tags to assign to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VastRequestConfiguration_Body <String>
An expression that evaluates to the request body, for example to send an OpenRTB bid request. The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VastRequestConfiguration_Cache_Key <String>
A JSONata expression that MediaTailor evaluates to a custom cache key. By default, the cache key is a hash of the HTTP URL, the request body, and the HTTP method; request headers are not included. You can specify a custom cache key expression to vary caching by request headers and more. The evaluated key must be smaller than 1 KB; otherwise the HTTP function will fail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VastRequestConfiguration_Cache_TtlMaximumSecond <Int32>
The upper bound, in seconds, on how long MediaTailor caches a response. This value must be greater than or equal to TtlMinimumSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVastRequestConfiguration_Cache_TtlMaximumSeconds
-VastRequestConfiguration_Cache_TtlMinimumSecond <Int32>
The lower bound, in seconds, on how long MediaTailor caches a response. MediaTailor also uses this value as the cache duration when a response has no Cache-Controlmax-age directive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVastRequestConfiguration_Cache_TtlMinimumSeconds
-VastRequestConfiguration_Header <Hashtable>
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVastRequestConfiguration_Headers
-VastRequestConfiguration_MethodType <MethodType>
The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VastRequestConfiguration_Output <Hashtable>
A map of output bindings. Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds — the ads parsed from the VAST response after schema validation and wrapper resolution — and response.statusCode. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VastRequestConfiguration_RequestTimeoutMillisecond <Int32>
The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values: 100 to 2000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVastRequestConfiguration_RequestTimeoutMilliseconds
-VastRequestConfiguration_Runtime <RuntimeType>
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VastRequestConfiguration_Url <String>
An expression that evaluates to the VAST endpoint URL. Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.MediaTailor.Model.PutFunctionResponse object containing multiple properties.

Supported Version

AWS Tools for PowerShell: 2.x.y.z