AWS.Tools.Schemas.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Schemas</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.AddSCHMResourceTagCmdlet"> <summary> Add tags to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.AddSCHMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.AddSCHMResourceTagCmdlet.Tag"> <summary> <para> <para>Tags associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.AddSCHMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.AddSCHMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.SchemaVersion"> <summary> <para> <para>Specifying this limits the results to only this schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.Type"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.Select"> <summary> 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.Schemas.Model.ExportSchemaResponse). Specifying the name of a property of type Amazon.Schemas.Model.ExportSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.ExportSCHMSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet"> <summary> Describe the code binding URI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet.Language"> <summary> <para> <para>The language of the code binding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet.SchemaVersion"> <summary> <para> <para>Specifying this limits the results to only this schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingCmdlet.Select"> <summary> 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.Schemas.Model.DescribeCodeBindingResponse). Specifying the name of a property of type Amazon.Schemas.Model.DescribeCodeBindingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet"> <summary> Get the code binding source URI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet.Language"> <summary> <para> <para>The language of the code binding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet.SchemaVersion"> <summary> <para> <para>Specifying this limits the results to only this schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMCodeBindingSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Body'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.GetCodeBindingSourceResponse). Specifying the name of a property of type Amazon.Schemas.Model.GetCodeBindingSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscoveredSchemaCmdlet"> <summary> Get the discovered schema that was generated based on sampled events. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscoveredSchemaCmdlet.Event"> <summary> <para> <para>An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscoveredSchemaCmdlet.Type"> <summary> <para> <para>The type of event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscoveredSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Content'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.GetDiscoveredSchemaResponse). Specifying the name of a property of type Amazon.Schemas.Model.GetDiscoveredSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererCmdlet"> <summary> Describes the discoverer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererCmdlet.DiscovererId"> <summary> <para> <para>The ID of the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererCmdlet.Select"> <summary> 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.Schemas.Model.DescribeDiscovererResponse). Specifying the name of a property of type Amazon.Schemas.Model.DescribeDiscovererResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet"> <summary> List the discoverers.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.DiscovererIdPrefix"> <summary> <para> <para>Specifying this limits the results to only those discoverer IDs that start with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.SourceArnPrefix"> <summary> <para> <para>Specifying this limits the results to only those ARNs that start with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Discoverers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListDiscoverersResponse). Specifying the name of a property of type Amazon.Schemas.Model.ListDiscoverersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMDiscovererListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryCmdlet"> <summary> Describes the registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryCmdlet.Select"> <summary> 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.Schemas.Model.DescribeRegistryResponse). Specifying the name of a property of type Amazon.Schemas.Model.DescribeRegistryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet"> <summary> List the registries.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.RegistryNamePrefix"> <summary> <para> <para>Specifying this limits the results to only those registry names that start with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.Scope"> <summary> <para> <para>Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Registries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListRegistriesResponse). Specifying the name of a property of type Amazon.Schemas.Model.ListRegistriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMRegistryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourcePolicyCmdlet"> <summary> Retrieves the resource-based policy attached to a given registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourcePolicyCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourcePolicyCmdlet.Select"> <summary> 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.Schemas.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.Schemas.Model.GetResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourceTagCmdlet"> <summary> Get tags for resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Schemas.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaCmdlet"> <summary> Retrieve the schema definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaCmdlet.SchemaVersion"> <summary> <para> <para>Specifying this limits the results to only this schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaCmdlet.Select"> <summary> 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.Schemas.Model.DescribeSchemaResponse). Specifying the name of a property of type Amazon.Schemas.Model.DescribeSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet"> <summary> List the schemas.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.SchemaNamePrefix"> <summary> <para> <para>Specifying this limits the results to only those schema names that start with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListSchemasResponse). Specifying the name of a property of type Amazon.Schemas.Model.ListSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet"> <summary> Provides a list of the schema versions and related information.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SchemaVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListSchemaVersionsResponse). Specifying the name of a property of type Amazon.Schemas.Model.ListSchemaVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.GetSCHMSchemaVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet"> <summary> Creates a discoverer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.CrossAccount"> <summary> <para> <para>Support discovery of schemas in events sent to the bus from another account. (default: true).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.Description"> <summary> <para> <para>A description for the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.SourceArn"> <summary> <para> <para>The ARN of the event bus.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.Tag"> <summary> <para> <para>Tags associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.Select"> <summary> 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.Schemas.Model.CreateDiscovererResponse). Specifying the name of a property of type Amazon.Schemas.Model.CreateDiscovererResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMDiscovererCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet"> <summary> Creates a registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet.Description"> <summary> <para> <para>A description of the registry to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet.Tag"> <summary> <para> <para>Tags to associate with the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet.Select"> <summary> 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.Schemas.Model.CreateRegistryResponse). Specifying the name of a property of type Amazon.Schemas.Model.CreateRegistryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMRegistryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet"> <summary> Creates a schema definition. <note><para> Inactive schemas will be deleted after two years. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Content"> <summary> <para> <para>The source of the schema definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Description"> <summary> <para> <para>A description of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Tag"> <summary> <para> <para>Tags associated with the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Type"> <summary> <para> <para>The type of schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Select"> <summary> 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.Schemas.Model.CreateSchemaResponse). Specifying the name of a property of type Amazon.Schemas.Model.CreateSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.NewSCHMSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMDiscovererCmdlet"> <summary> Deletes a discoverer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMDiscovererCmdlet.DiscovererId"> <summary> <para> <para>The ID of the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMDiscovererCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.DeleteDiscovererResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMDiscovererCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMRegistryCmdlet"> <summary> Deletes a Registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMRegistryCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMRegistryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.DeleteRegistryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMRegistryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourcePolicyCmdlet"> <summary> Delete the resource-based policy attached to the specified registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourcePolicyCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourceTagCmdlet"> <summary> Removes tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys of key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaCmdlet"> <summary> Delete a schema definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.DeleteSchemaResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet"> <summary> Delete the schema version definition </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet.SchemaVersion"> <summary> <para> The version number of the schema </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.DeleteSchemaVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.RemoveSCHMSchemaVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet"> <summary> Search the schemas<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.Keyword"> <summary> <para> <para>Specifying this limits the results to only schemas that include the provided keywords.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.NextToken"> <summary> <para> <para>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.SearchSchemasResponse). Specifying the name of a property of type Amazon.Schemas.Model.SearchSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.SearchSCHMSchemaCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.StartSCHMDiscovererCmdlet"> <summary> Starts the discoverer </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StartSCHMDiscovererCmdlet.DiscovererId"> <summary> <para> <para>The ID of the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StartSCHMDiscovererCmdlet.Select"> <summary> 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.Schemas.Model.StartDiscovererResponse). Specifying the name of a property of type Amazon.Schemas.Model.StartDiscovererResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StartSCHMDiscovererCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.StopSCHMDiscovererCmdlet"> <summary> Stops the discoverer </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StopSCHMDiscovererCmdlet.DiscovererId"> <summary> <para> <para>The ID of the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StopSCHMDiscovererCmdlet.Select"> <summary> 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.Schemas.Model.StopDiscovererResponse). Specifying the name of a property of type Amazon.Schemas.Model.StopDiscovererResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.StopSCHMDiscovererCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet"> <summary> Updates the discoverer </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet.CrossAccount"> <summary> <para> <para>Support discovery of schemas in events sent to the bus from another account. (default: true)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet.Description"> <summary> <para> <para>The description of the discoverer to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet.DiscovererId"> <summary> <para> <para>The ID of the discoverer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet.Select"> <summary> 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.Schemas.Model.UpdateDiscovererResponse). Specifying the name of a property of type Amazon.Schemas.Model.UpdateDiscovererResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMDiscovererCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMRegistryCmdlet"> <summary> Updates a registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMRegistryCmdlet.Description"> <summary> <para> <para>The description of the registry to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMRegistryCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMRegistryCmdlet.Select"> <summary> 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.Schemas.Model.UpdateRegistryResponse). Specifying the name of a property of type Amazon.Schemas.Model.UpdateRegistryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMRegistryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet"> <summary> Updates the schema definition <note><para> Inactive schemas will be deleted after two years. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.ClientTokenId"> <summary> <para> <para>The ID of the client token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.Content"> <summary> <para> <para>The source of the schema definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.Description"> <summary> <para> <para>The description of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.Type"> <summary> <para> <para>The schema type for the events schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.Select"> <summary> 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.Schemas.Model.UpdateSchemaResponse). Specifying the name of a property of type Amazon.Schemas.Model.UpdateSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.UpdateSCHMSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet"> <summary> Put code binding URI </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.Language"> <summary> <para> <para>The language of the code binding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.SchemaName"> <summary> <para> <para>The name of the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.SchemaVersion"> <summary> <para> <para>Specifying this limits the results to only this schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.Select"> <summary> 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.Schemas.Model.PutCodeBindingResponse). Specifying the name of a property of type Amazon.Schemas.Model.PutCodeBindingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMCodeBindingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet"> <summary> The name of the policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet.Policy"> <summary> <para> <para>The resource-based policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet.RegistryName"> <summary> <para> <para>The name of the registry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet.RevisionId"> <summary> <para> <para>The revision ID of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet.Select"> <summary> 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.Schemas.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.Schemas.Model.PutResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SCHM.WriteSCHMResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |