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 Billing CreateContractualInvestmentAttestation API operation.

Syntax

New-AWSBContractualInvestmentAttestation
-AdditionalRecipient <AdditionalRecipient[]>
-AttestationDetails_AttestationValue_AttestationQuantity <AttestationQuantity[]>
-ContractArn <String>
-ContractDocumentId <String>
-AttestationDetails_AttestationValue_AttestationAmount_CurrencyAmount <String>
-AttestationDetails_AttestationValue_AttestationAmount_CurrencyCode <String>
-ApproverDetails_Email <String>
-InvestmentDisbursedAt <DateTime>
-AttestationDetails_InvestmentDistribution <InvestmentDistribution[]>
-InvestmentId <String>
-InvestmentSummaryId <String>
-ApproverDetails_Name <String>
-ApproverDetails_Title <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBillingConfig>

Description

Creates an attestation that claims an investment award for a completed milestone or outcome within a private pricing contract. Supply a clientToken to make the request idempotent so a safe retry does not create a duplicate attestation. This operation starts an asynchronous review and returns an attestationId while the attestation is pending.

Parameters

-AdditionalRecipient <AdditionalRecipient[]>
The email addresses to copy as viewers on the executive approval request. 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)
AliasesAdditionalRecipients
-ApproverDetails_Email <String>
The email address of the approver. This value is 3–256 characters and must be a valid email address.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApproverDetails_Name <String>
The name of the approver as it appears on the contract. This value can be up to 256 characters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApproverDetails_Title <String>
The title of the approver, such as Chief Financial Officer. This value can be up to 256 characters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AttestationDetails_AttestationValue_AttestationAmount_CurrencyAmount <String>
The amount as a decimal string (for example, "743.21"). Negative values represent credits that reduce a bill.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AttestationDetails_AttestationValue_AttestationAmount_CurrencyCode <String>
The ISO 4217 currency code for the amount (for example, USD).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AttestationDetails_AttestationValue_AttestationQuantity <AttestationQuantity[]>
The value attested as one or more quantities, each with its own unit. The list contains at most 50 quantities. 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)
AliasesAttestationDetails_AttestationValue_AttestationQuantities
-AttestationDetails_InvestmentDistribution <InvestmentDistribution[]>
The distribution of the resulting investment across the eligible investment accounts on the contract. If you omit this value, the full investment is allocated to the single eligible investment account on the contract. This value is required when multiple investment accounts are eligible. When you provide this value, the sum of all distributions must equal the resulting monetary investment value (the attested amount, or the value computed from the attested quantities using the investment multipliers). The list contains at most 200 distributions. 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)
AliasesAttestationDetails_InvestmentDistributions
-ClientConfig <AmazonBillingConfig>
Amazon.PowerShell.Cmdlets.AWSB.AmazonBillingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry completes without performing any further actions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContractArn <String>
The Amazon Resource Name (ARN) of the contract that contains the investment being attested.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContractDocumentId <String>
The contract ID from the contract document, located in the top-right corner of the private pricing contract pages. This value confirms that you have access to the contract.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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)
-InvestmentDisbursedAt <DateTime>
The date on which the investment is disbursed to the investment accounts. The disbursement date is subject to review timelines.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvestmentId <String>
The identifier of the investment (outcome) being attested.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvestmentSummaryId <String>
The identifier of the investment summary being attested. This is the parent to the investmentId.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AttestationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Billing.Model.CreateContractualInvestmentAttestationResponse). Specifying the name of a property of type Amazon.Billing.Model.CreateContractualInvestmentAttestationResponse 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)

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

System.String or Amazon.Billing.Model.CreateContractualInvestmentAttestationResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Billing.Model.CreateContractualInvestmentAttestationResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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