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 Amazon QuickSight CreateActionConnector API operation.

Syntax

New-QSActionConnector
-ActionConnectorId <String>
-ApiKeyConnectionMetadata_ApiKey <String>
-AuthenticationConfig_AuthenticationType <ConnectionAuthType>
-AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsSource <AuthorizationCodeGrantCredentialsSource>
-AuthorizationCodeGrantDetails_AuthorizationEndpoint <String>
-AwsAccountId <String>
-ApiKeyConnectionMetadata_BaseEndpoint <String>
-AuthorizationCodeGrantMetadata_BaseEndpoint <String>
-BasicAuthConnectionMetadata_BaseEndpoint <String>
-ClientCredentialsGrantMetadata_BaseEndpoint <String>
-NoneConnectionMetadata_BaseEndpoint <String>
-ClientCredentialsGrantMetadata_ClientCredentialsSource <ClientCredentialsSource>
-AuthorizationCodeGrantDetails_ClientId <String>
-ClientCredentialsGrantDetails_ClientId <String>
-AuthorizationCodeGrantDetails_ClientSecret <String>
-ClientCredentialsGrantDetails_ClientSecret <String>
-Description <String>
-ApiKeyConnectionMetadata_Email <String>
-Name <String>
-BasicAuthConnectionMetadata_Password <String>
-Permission <ResourcePermission[]>
-AuthorizationCodeGrantMetadata_RedirectUrl <String>
-IamConnectionMetadata_RoleArn <String>
-Tag <Tag[]>
-AuthorizationCodeGrantDetails_TokenEndpoint <String>
-ClientCredentialsGrantDetails_TokenEndpoint <String>
-Type <ActionConnectorType>
-BasicAuthConnectionMetadata_Username <String>
-VpcConnectionArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Parameters

-ActionConnectorId <String>
A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApiKeyConnectionMetadata_ApiKey <String>
The API key used for authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ApiKeyConnectionMetadata_ApiKey
-ApiKeyConnectionMetadata_BaseEndpoint <String>
The base URL endpoint for the external service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ApiKeyConnectionMetadata_BaseEndpoint
-ApiKeyConnectionMetadata_Email <String>
The email address associated with the API key, if required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ApiKeyConnectionMetadata_Email
-AuthenticationConfig_AuthenticationType <ConnectionAuthType>
The type of authentication method.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthorizationCodeGrantDetails_AuthorizationEndpoint <String>
The authorization endpoint URL for the OAuth flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsDetails_AuthorizationCodeGrantDetails_AuthorizationEndpoint
-AuthorizationCodeGrantDetails_ClientId <String>
The client ID for the OAuth application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsDetails_AuthorizationCodeGrantDetails_ClientId
-AuthorizationCodeGrantDetails_ClientSecret <String>
The client secret for the OAuth application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsDetails_AuthorizationCodeGrantDetails_ClientSecret
-AuthorizationCodeGrantDetails_TokenEndpoint <String>
The token endpoint URL for obtaining access tokens.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsDetails_AuthorizationCodeGrantDetails_TokenEndpoint
-AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsSource <AuthorizationCodeGrantCredentialsSource>
The source of the authorization code grant credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_AuthorizationCodeGrantCredentialsSource
-AuthorizationCodeGrantMetadata_BaseEndpoint <String>
The base URL endpoint for the external service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_BaseEndpoint
-AuthorizationCodeGrantMetadata_RedirectUrl <String>
The redirect URL for the OAuth authorization flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_AuthorizationCodeGrantMetadata_RedirectUrl
-AwsAccountId <String>
The Amazon Web Services account ID associated with the action connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BasicAuthConnectionMetadata_BaseEndpoint <String>
The base URL endpoint for the external service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_BasicAuthConnectionMetadata_BaseEndpoint
-BasicAuthConnectionMetadata_Password <String>
The password for basic authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_BasicAuthConnectionMetadata_Password
-BasicAuthConnectionMetadata_Username <String>
The username for basic authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_BasicAuthConnectionMetadata_Username
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientCredentialsGrantDetails_ClientId <String>
The client identifier issued to the client during the registration process with the authorization server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ClientCredentialsGrantMetadata_ClientCredentialsDetails_ClientCredentialsGrantDetails_ClientId
-ClientCredentialsGrantDetails_ClientSecret <String>
The client secret issued to the client during the registration process with the authorization server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ClientCredentialsGrantMetadata_ClientCredentialsDetails_ClientCredentialsGrantDetails_ClientSecret
-ClientCredentialsGrantDetails_TokenEndpoint <String>
The authorization server endpoint used to obtain access tokens via the client credentials grant flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ClientCredentialsGrantMetadata_ClientCredentialsDetails_ClientCredentialsGrantDetails_TokenEndpoint
-ClientCredentialsGrantMetadata_BaseEndpoint <String>
The base endpoint URL for the external service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ClientCredentialsGrantMetadata_BaseEndpoint
-ClientCredentialsGrantMetadata_ClientCredentialsSource <ClientCredentialsSource>
The source of the client credentials configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_ClientCredentialsGrantMetadata_ClientCredentialsSource
-Description <String>
An optional description of the action connector.
Required?False
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)
-IamConnectionMetadata_RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_IamConnectionMetadata_RoleArn
-Name <String>
A descriptive name for the action connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoneConnectionMetadata_BaseEndpoint <String>
The base endpoint URL for connections that do not require authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthenticationConfig_AuthenticationMetadata_NoneConnectionMetadata_BaseEndpoint
-Permission <ResourcePermission[]>
The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform. 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)
AliasesPermissions
-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.QuickSight.Model.CreateActionConnectorResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateActionConnectorResponse 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)
-Tag <Tag[]>
A list of tags to apply to the action connector for resource management and organization. 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
-Type <ActionConnectorType>
The type of action connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConnectionArn <String>
The ARN of the VPC connection to use for secure connectivity to the external service.
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

Amazon.QuickSight.Model.CreateActionConnectorResponse
This cmdlet returns an Amazon.QuickSight.Model.CreateActionConnectorResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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